multi_region_clusters

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

Overview

Name	multi_region_clusters
Type	Resource
Id	aws.memorydb.multi_region_clusters

Fields

The following fields are returned by SELECT queries:

describe_multi_region_clusters

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the multi-Region cluster.
clusters	array	The clusters in this multi-Region cluster.
description	string	The description of the multi-Region cluster.
engine	string	The name of the engine used by the multi-Region cluster.
engine_version	string	The version of the engine used by the multi-Region cluster.
multi_region_cluster_name	string	The name of the multi-Region cluster.
multi_region_parameter_group_name	string	The name of the multi-Region parameter group associated with the cluster.
node_type	string	The node type used by the multi-Region cluster.
number_of_shards	integer	The number of shards in the multi-Region cluster.
status	string	The current status of the multi-Region cluster.
tls_enabled	boolean	Indiciates if the multi-Region cluster is TLS enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_multi_region_clusters	select	region		Returns details about one or more multi-Region clusters.
create_multi_region_cluster	insert	region, MultiRegionClusterNameSuffix, NodeType		Creates a new multi-Region cluster.
update_multi_region_cluster	update	region, MultiRegionClusterName		Updates the configuration of an existing multi-Region cluster.
delete_multi_region_cluster	delete	region		Deletes an existing multi-Region cluster.

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

describe_multi_region_clusters

Returns details about one or more multi-Region clusters.

SELECT
arn,
clusters,
description,
engine,
engine_version,
multi_region_cluster_name,
multi_region_parameter_group_name,
node_type,
number_of_shards,
status,
tls_enabled
FROM aws.memorydb.multi_region_clusters
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_multi_region_cluster

Creates a new multi-Region cluster.

INSERT INTO aws.memorydb.multi_region_clusters (
MultiRegionClusterNameSuffix,
Description,
Engine,
EngineVersion,
NodeType,
MultiRegionParameterGroupName,
NumShards,
TLSEnabled,
Tags,
region
)
SELECT 
'{{ MultiRegionClusterNameSuffix }}' /* required */,
'{{ Description }}',
'{{ Engine }}',
'{{ EngineVersion }}',
'{{ NodeType }}' /* required */,
'{{ MultiRegionParameterGroupName }}',
{{ NumShards }},
{{ TLSEnabled }},
'{{ Tags }}',
'{{ region }}'
RETURNING
multi_region_cluster
;

Manifest

# Description fields are for documentation purposes
- name: multi_region_clusters
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multi_region_clusters resource.
  - name: MultiRegionClusterNameSuffix
    value: "{{ MultiRegionClusterNameSuffix }}"
    description: |
      A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the multi-Region cluster.
  - name: Engine
    value: "{{ Engine }}"
    description: |
      The name of the engine to be used for the multi-Region cluster.
  - name: EngineVersion
    value: "{{ EngineVersion }}"
    description: |
      The version of the engine to be used for the multi-Region cluster.
  - name: NodeType
    value: "{{ NodeType }}"
    description: |
      The node type to be used for the multi-Region cluster.
  - name: MultiRegionParameterGroupName
    value: "{{ MultiRegionParameterGroupName }}"
    description: |
      The name of the multi-Region parameter group to be associated with the cluster.
  - name: NumShards
    value: {{ NumShards }}
    description: |
      The number of shards for the multi-Region cluster.
  - name: TLSEnabled
    value: {{ TLSEnabled }}
    description: |
      Whether to enable TLS encryption for the multi-Region cluster.
  - name: Tags
    description: |
      A list of tags to be applied to the multi-Region cluster.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_multi_region_cluster

Updates the configuration of an existing multi-Region cluster.

UPDATE aws.memorydb.multi_region_clusters
SET 
MultiRegionClusterName = '{{ MultiRegionClusterName }}',
NodeType = '{{ NodeType }}',
Description = '{{ Description }}',
EngineVersion = '{{ EngineVersion }}',
ShardConfiguration = '{{ ShardConfiguration }}',
MultiRegionParameterGroupName = '{{ MultiRegionParameterGroupName }}',
UpdateStrategy = '{{ UpdateStrategy }}'
WHERE 
region = '{{ region }}' --required
AND MultiRegionClusterName = '{{ MultiRegionClusterName }}' --required
RETURNING
multi_region_cluster;

DELETE examples

delete_multi_region_cluster

Deletes an existing multi-Region cluster.

DELETE FROM aws.memorydb.multi_region_clusters
WHERE region = '{{ region }}' --required
;