Skip to main content

vault_replicas

Creates, updates, deletes, gets or lists a vault_replicas resource.

Overview​

Namevault_replicas
TypeResource
Idoci.kms.vault_replicas

Fields​

The following fields are returned by SELECT queries:

Summary of vault replicas

NameDatatypeDescription
cryptoEndpointstringThe vault replica's crypto endpoint
managementEndpointstringThe vault replica's management endpoint
regionstringRegion to which vault is replicated to
statusstringStatus of the Vault (CREATING, CREATED, DELETING, DELETED)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectvaultId, regionif-match, limit, page, opc-request-id, opc-retry-token, sortBy, sortOrderLists the replicas for a vault<br /><br />As a provisioning operation, this call is subject to a Key Management limit that applies to<br />the total number of requests across all provisioning write operations. Key Management might<br />throttle this call to reject an otherwise valid request when the total rate of provisioning<br />write operations exceeds 10 requests per second for a given tenancy.<br />
createinsertvaultId, region, replicaRegionif-match, opc-request-id, opc-retry-tokenCreates a replica for the vault in another region in the same realm<br /><br />The API is a no-op if called for same region that a vault is already replicated to.<br />409 if called on a vault that is already replicated to a different region. Users need to delete<br />existing replica first before calling it with a different region.<br /><br />As a provisioning operation, this call is subject to a Key Management limit that applies to<br />the total number of requests across all provisioning write operations. Key Management might<br />throttle this call to reject an otherwise valid request when the total rate of provisioning<br />write operations exceeds 10 requests per second for a given tenancy.<br />

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
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
vaultIdstringThe OCID of the vault.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
limitintegerThe maximum number of items to return in a paginated "List" call.
opc-request-idstringUnique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringThe value of the opc-next-page response header from the previous "List" call.
sortBystringThe field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples​

Lists the replicas for a vault<br /><br />As a provisioning operation, this call is subject to a Key Management limit that applies to<br />the total number of requests across all provisioning write operations. Key Management might<br />throttle this call to reject an otherwise valid request when the total rate of provisioning<br />write operations exceeds 10 requests per second for a given tenancy.<br />

SELECT
cryptoEndpoint,
managementEndpoint,
region,
status
FROM oci.kms.vault_replicas
WHERE vaultId = '{{ vaultId }}' -- required
AND region = '{{ region }}' -- required
AND if-match = '{{ if-match }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND opc-retry-token = '{{ opc-retry-token }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

INSERT examples​

Creates a replica for the vault in another region in the same realm<br /><br />The API is a no-op if called for same region that a vault is already replicated to.<br />409 if called on a vault that is already replicated to a different region. Users need to delete<br />existing replica first before calling it with a different region.<br /><br />As a provisioning operation, this call is subject to a Key Management limit that applies to<br />the total number of requests across all provisioning write operations. Key Management might<br />throttle this call to reject an otherwise valid request when the total rate of provisioning<br />write operations exceeds 10 requests per second for a given tenancy.<br />

INSERT INTO oci.kms.vault_replicas (
replicaRegion,
replicaVaultMetadata,
vaultId,
region,
if-match,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ replicaRegion }}' /* required */,
'{{ replicaVaultMetadata }}',
'{{ vaultId }}',
'{{ region }}',
'{{ if-match }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;