EnableDefaultKeyReplicationRegions
Enables multi-region key replication settings for your account, causing new keys to be automatically replicated to the specified AWS Regions when created.
When default Replication Regions are enabled, any new keys created in your account will automatically be replicated to these regions unless you explicitly override this behavior during key creation. This simplifies key management for applications that operate across multiple regions.
Existing keys are not affected by this operation - only keys created after enabling default replication will be automatically replicated.
Cross-account use: This operation can't be used across different AWS accounts.
Related operations:
Request Syntax
{
"ReplicationRegions": [ "string" ]
}Request Parameters
The request accepts the following data in JSON format.
- ReplicationRegions
-
The list of AWS Regions to enable as default replication regions for the account.
New keys created in this account will automatically be replicated to these regions unless explicitly overridden during key creation.
Type: Array of strings
Pattern:
[a-z]{2}-[a-z]{1,16}-[0-9]+Required: Yes
Response Syntax
{
"EnabledReplicationRegions": [ "string" ]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EnabledReplicationRegions
-
The complete list of regions where default key replication is now enabled for the account.
This includes both previously enabled regions and the newly added regions from this operation.
Type: Array of strings
Pattern:
[a-z]{2}-[a-z]{1,16}-[0-9]+
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific AWS Payment Cryptography action you're attempting.
HTTP Status Code: 400
- ConflictException
-
This request can cause an inconsistent state for the resource.
The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
This indicates a server-side error within the AWS Payment Cryptography service. If this error persists, contact support for assistance.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request was denied due to resource not found.
The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
This request would cause a service quota to be exceeded.
You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
You have exceeded the rate limits for AWS Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.
HTTP Status Code: 400
- ValidationException
-
The request was denied due to an invalid request error.
One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
