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	awscc.memorydb.multi_region_clusters

Fields

get (all properties)

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.<br />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.

list (identifiers only)

Name	Datatype	Description
multi_region_cluster_name	string	The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	multi_region_clusters	INSERT	NodeType, region
delete_resource	multi_region_clusters	DELETE	Identifier, region
update_resource	multi_region_clusters	UPDATE	Identifier, PatchDocument, region
list_resources	multi_region_clusters_list_only	SELECT	region
get_resource	multi_region_clusters	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.memorydb.multi_region_clusters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ multi_region_cluster_name }}';

list (identifiers only)

Lists all multi_region_clusters in a region.

SELECT
  region,
  multi_region_cluster_name
FROM awscc.memorydb.multi_region_clusters_list_only
WHERE
  region = 'us-east-1';

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 awscc.memorydb.multi_region_clusters (
  NodeType,
  region
)
SELECT
  '{{ node_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.memorydb.multi_region_clusters (
  MultiRegionClusterNameSuffix,
  Description,
  NodeType,
  NumShards,
  MultiRegionParameterGroupName,
  TLSEnabled,
  Engine,
  EngineVersion,
  Tags,
  UpdateStrategy,
  region
)
SELECT
  '{{ multi_region_cluster_name_suffix }}',
  '{{ description }}',
  '{{ node_type }}',
  '{{ num_shards }}',
  '{{ multi_region_parameter_group_name }}',
  '{{ tls_enabled }}',
  '{{ engine }}',
  '{{ engine_version }}',
  '{{ tags }}',
  '{{ update_strategy }}',
  '{{ 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: multi_region_cluster_name_suffix
        value: '{{ multi_region_cluster_name_suffix }}'
      - name: description
        value: '{{ description }}'
      - name: node_type
        value: '{{ node_type }}'
      - name: num_shards
        value: '{{ num_shards }}'
      - name: multi_region_parameter_group_name
        value: '{{ multi_region_parameter_group_name }}'
      - name: tls_enabled
        value: '{{ tls_enabled }}'
      - name: engine
        value: '{{ engine }}'
      - name: engine_version
        value: '{{ engine_version }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: update_strategy
        value: '{{ update_strategy }}'

UPDATE example

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

/*+ update */
UPDATE awscc.memorydb.multi_region_clusters
SET PatchDocument = string('{{ {
    "Description": description,
    "NodeType": node_type,
    "NumShards": num_shards,
    "Engine": engine,
    "Tags": tags,
    "UpdateStrategy": update_strategy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ multi_region_cluster_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.memorydb.multi_region_clusters
WHERE
  Identifier = '{{ multi_region_cluster_name }}' 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,
iam:CreateServiceLinkedRole

Read

memorydb:DescribeMultiRegionClusters,
memorydb:ListTags

Update

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

Delete

memorydb:DeleteMultiRegionCluster,
memorydb:DescribeMultiRegionClusters

List

memorydb:DescribeMultiRegionClusters