Skip to main content

exascale_db_storage_vaults

Creates, updates, deletes, gets or lists an exascale_db_storage_vaults resource.

Overview​

Nameexascale_db_storage_vaults
TypeResource
Idaws.odb.exascale_db_storage_vaults

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
additional_flash_cache_in_percentintegerThe additional flash cache percentage for the Exascale storage vault.
attached_shape_attributesarrayThe list of shape attributes attached to the Exascale storage vault.
autoscale_limit_in_gbsintegerThe autoscale limit in gigabytes (GB) for the Exascale storage vault.
availability_zonestringThe Availability Zone for the Exascale storage vault.
availability_zone_idstringThe Availability Zone ID for the Exascale storage vault.
created_atstring (date-time)The date and time when the Exascale storage vault was created.
descriptionstringThe description of the Exascale storage vault.
display_namestringThe user-friendly name for the Exascale storage vault.
exascale_db_storage_vault_arnstringThe Amazon Resource Name (ARN) of the Exascale storage vault. (pattern: <code>arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}</code>)
exascale_db_storage_vault_idstringThe unique identifier of the Exascale storage vault. (pattern: <code>(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_.-]{6,64}|[a-zA-Z0-9_.-]{6,64})</code>)
high_capacity_database_storageobjectThe high-capacity database storage details for the Exascale storage vault.
is_autoscale_enabledbooleanSpecifies whether autoscaling is enabled for the Exascale storage vault.
oci_resource_anchor_namestringThe name of the OCI resource anchor for the Exascale storage vault.
oci_urlstringThe HTTPS link to the Exascale storage vault in Oracle Cloud Infrastructure (OCI).
ocidstringThe OCID of the Exascale storage vault.
percent_progressnumber (float)The amount of progress made on the current operation on the Exascale storage vault, expressed as a percentage.
statusstringThe current status of the Exascale storage vault. (AVAILABLE, FAILED, PROVISIONING, TERMINATED, TERMINATING, UPDATING, MAINTENANCE_IN_PROGRESS)
status_reasonstringAdditional information about the status of the Exascale storage vault.
time_zonestringThe time zone of the Exascale storage vault.
vm_cluster_arnsarrayThe list of Amazon Resource Names (ARNs) of the VM clusters associated with this Exascale storage vault.
vm_cluster_countintegerThe number of VM clusters associated with this Exascale storage vault.
vm_cluster_idsarrayThe list of unique identifiers of the VM clusters associated with this Exascale storage vault.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_exascale_db_storage_vaultselectregionReturns information about the specified Exascale storage vault.
list_exascale_db_storage_vaultsselectregionReturns information about the Exascale storage vaults owned by your Amazon Web Services account.
create_exascale_db_storage_vaultinsertregion, displayName, highCapacityDatabaseStorageTotalSizeInGBsCreates an Exascale storage vault.
update_exascale_db_storage_vaultupdateregion, exascaleDbStorageVaultIdUpdates the specified Exascale storage vault.
delete_exascale_db_storage_vaultdeleteregionDeletes the specified Exascale storage vault.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns information about the specified Exascale storage vault.

SELECT
additional_flash_cache_in_percent,
attached_shape_attributes,
autoscale_limit_in_gbs,
availability_zone,
availability_zone_id,
created_at,
description,
display_name,
exascale_db_storage_vault_arn,
exascale_db_storage_vault_id,
high_capacity_database_storage,
is_autoscale_enabled,
oci_resource_anchor_name,
oci_url,
ocid,
percent_progress,
status,
status_reason,
time_zone,
vm_cluster_arns,
vm_cluster_count,
vm_cluster_ids
FROM aws.odb.exascale_db_storage_vaults
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an Exascale storage vault.

INSERT INTO aws.odb.exascale_db_storage_vaults (
displayName,
highCapacityDatabaseStorageTotalSizeInGBs,
additionalFlashCacheInPercent,
autoscaleLimitInGBs,
availabilityZoneId,
availabilityZone,
description,
isAutoscaleEnabled,
tags,
timeZone,
clientToken,
region
)
SELECT 
'{{ displayName }}' /* required */,
{{ highCapacityDatabaseStorageTotalSizeInGBs }} /* required */,
{{ additionalFlashCacheInPercent }},
{{ autoscaleLimitInGBs }},
'{{ availabilityZoneId }}',
'{{ availabilityZone }}',
'{{ description }}',
{{ isAutoscaleEnabled }},
'{{ tags }}',
'{{ timeZone }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
display_name,
exascale_db_storage_vault_id,
status,
status_reason
;

UPDATE examples​

Updates the specified Exascale storage vault.

UPDATE aws.odb.exascale_db_storage_vaults
SET 
exascaleDbStorageVaultId = '{{ exascaleDbStorageVaultId }}',
additionalFlashCacheInPercent = {{ additionalFlashCacheInPercent }},
autoscaleLimitInGBs = {{ autoscaleLimitInGBs }},
description = '{{ description }}',
displayName = '{{ displayName }}',
highCapacityDatabaseStorageTotalSizeInGBs = {{ highCapacityDatabaseStorageTotalSizeInGBs }},
isAutoscaleEnabled = {{ isAutoscaleEnabled }}
WHERE 
region = '{{ region }}' --required
AND exascaleDbStorageVaultId = '{{ exascaleDbStorageVaultId }}' --required
RETURNING
display_name,
exascale_db_storage_vault_id,
status,
status_reason;

DELETE examples​

Deletes the specified Exascale storage vault.

DELETE FROM aws.odb.exascale_db_storage_vaults
WHERE region = '{{ region }}' --required
;
Last updated on