default_key_replication_regions

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

Overview

Name	default_key_replication_regions
Type	Resource
Id	aws.payment_cryptography.default_key_replication_regions

Fields

The following fields are returned by SELECT queries:

get_default_key_replication_regions

Name	Datatype	Description
enabled_replication_region	string	The list of regions where default key replication is currently enabled for the account. New keys created in this account will automatically be replicated to these regions unless explicitly configured otherwise during key creation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_default_key_replication_regions	select	region		Retrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account. This operation returns the current Multi-Region key replication configuration. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: EnableDefaultKeyReplicationRegions DisableDefaultKeyReplicationRegions
disable_default_key_replication_regions	exec	region, ReplicationRegions		Disables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions. After disabling Multi-Region key replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the AddKeyReplicationRegions operation. This operation does not affect existing keys or their current replication configuration. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: EnableDefaultKeyReplicationRegions GetDefaultKeyReplicationRegions
enable_default_key_replication_regions	exec	region, ReplicationRegions		Enables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created. When Multi-Region key replication 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 Amazon Web Services accounts. Related operations: DisableDefaultKeyReplicationRegions GetDefaultKeyReplicationRegions

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_default_key_replication_regions

Retrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account. This operation returns the current Multi-Region key replication configuration. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: EnableDefaultKeyReplicationRegions DisableDefaultKeyReplicationRegions

SELECT
enabled_replication_region
FROM aws.payment_cryptography.default_key_replication_regions
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

disable_default_key_replication_regions

Disables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions. After disabling Multi-Region key replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the AddKeyReplicationRegions operation. This operation does not affect existing keys or their current replication configuration. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: EnableDefaultKeyReplicationRegions GetDefaultKeyReplicationRegions

EXEC aws.payment_cryptography.default_key_replication_regions.disable_default_key_replication_regions 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationRegions": "{{ ReplicationRegions }}"
}'
;

enable_default_key_replication_regions

Enables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created. When Multi-Region key replication 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 Amazon Web Services accounts. Related operations: DisableDefaultKeyReplicationRegions GetDefaultKeyReplicationRegions

EXEC aws.payment_cryptography.default_key_replication_regions.enable_default_key_replication_regions 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationRegions": "{{ ReplicationRegions }}"
}'
;