multi_region_clusters

Creates, updates, deletes or gets a multi_region_cluster resource or lists multi_region_clusters in a region

Overview

Name	multi_region_clusters
Type	Resource
Description	The AWS::MemoryDB::Multi Region Cluster resource creates an Amazon MemoryDB Multi Region Cluster.
Id	aws.memorydb.multi_region_clusters

Fields

Name	Datatype	Description
multi_region_cluster_name_suffix	string	The name of the Multi Region cluster. This value must be unique as it also serves as the multi region cluster identifier.
description	string	Description of the multi region cluster.
multi_region_cluster_name	string	The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
status	string	The status of the multi region cluster. For example, Available, Updating, Creating.
node_type	string	The compute and memory capacity of the nodes in the multi region cluster.
num_shards	integer	The number of shards the multi region cluster will contain.
multi_region_parameter_group_name	string	The name of the parameter group associated with the multi region cluster.
tls_enabled	boolean	A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
arn	string	The Amazon Resource Name (ARN) of the multi region cluster.
engine	string	The engine type used by the multi region cluster.
engine_version	string	The Redis engine version used by the multi region cluster.
tags	array	An array of key-value pairs to apply to this multi region cluster.
update_strategy	string	An enum string value that determines the update strategy for scaling. Possible values are 'COORDINATED' and 'UNCOORDINATED'. Default is 'COORDINATED'.
region	string	AWS region.

For more information, see AWS::MemoryDB::MultiRegionCluster.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	NodeType, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all multi_region_clusters in a region.

SELECT
region,
multi_region_cluster_name_suffix,
description,
multi_region_cluster_name,
status,
node_type,
num_shards,
multi_region_parameter_group_name,
tls_enabled,
arn,
engine,
engine_version,
tags,
update_strategy
FROM aws.memorydb.multi_region_clusters
WHERE region = 'us-east-1';

Gets all properties from an individual multi_region_cluster.

SELECT
region,
multi_region_cluster_name_suffix,
description,
multi_region_cluster_name,
status,
node_type,
num_shards,
multi_region_parameter_group_name,
tls_enabled,
arn,
engine,
engine_version,
tags,
update_strategy
FROM aws.memorydb.multi_region_clusters
WHERE region = 'us-east-1' AND data__Identifier = '<MultiRegionClusterName>';

INSERT example

Use the following StackQL query and manifest file to create a new multi_region_cluster resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.memorydb.multi_region_clusters (
 NodeType,
 region
)
SELECT 
'{{ NodeType }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: multi_region_cluster
    props:
      - name: MultiRegionClusterNameSuffix
        value: '{{ MultiRegionClusterNameSuffix }}'
      - name: Description
        value: '{{ Description }}'
      - name: NodeType
        value: '{{ NodeType }}'
      - name: NumShards
        value: '{{ NumShards }}'
      - name: MultiRegionParameterGroupName
        value: '{{ MultiRegionParameterGroupName }}'
      - name: TLSEnabled
        value: '{{ TLSEnabled }}'
      - name: Engine
        value: '{{ Engine }}'
      - name: EngineVersion
        value: '{{ EngineVersion }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: UpdateStrategy
        value: '{{ UpdateStrategy }}'

DELETE example

/*+ delete */
DELETE FROM aws.memorydb.multi_region_clusters
WHERE data__Identifier = '<MultiRegionClusterName>'
AND region = 'us-east-1';

Permissions

To operate on the multi_region_clusters resource, the following permissions are required:

Create

memorydb:CreateMultiRegionCluster,
memorydb:DescribeMultiRegionClusters,
memorydb:TagResource,
memorydb:ListTags

Read

memorydb:DescribeMultiRegionClusters,
memorydb:ListTags

Update

memorydb:UpdateMultiRegionCluster,
memorydb:DescribeMultiRegionClusters,
memorydb:ListTags,
memorydb:TagResource,
memorydb:UntagResource

Delete

memorydb:DeleteMultiRegionCluster,
memorydb:DescribeMultiRegionClusters

List

memorydb:DescribeMultiRegionClusters