CfnGlobalReplicationGroup

class aws_cdk.aws_elasticache.CfnGlobalReplicationGroup(scope, id, *, members, automatic_failover_enabled=None, cache_node_type=None, cache_parameter_group_name=None, engine_version=None, global_node_group_count=None, global_replication_group_description=None, global_replication_group_id_suffix=None, regional_configurations=None)

Bases: CfnResource

A CloudFormation AWS::ElastiCache::GlobalReplicationGroup.

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

CloudformationResource

AWS::ElastiCache::GlobalReplicationGroup

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache as elasticache

cfn_global_replication_group = elasticache.CfnGlobalReplicationGroup(self, "MyCfnGlobalReplicationGroup",
    members=[elasticache.CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        role="role"
    )],

    # the properties below are optional
    automatic_failover_enabled=False,
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    engine_version="engineVersion",
    global_node_group_count=123,
    global_replication_group_description="globalReplicationGroupDescription",
    global_replication_group_id_suffix="globalReplicationGroupIdSuffix",
    regional_configurations=[elasticache.CfnGlobalReplicationGroup.RegionalConfigurationProperty(
        replication_group_id="replicationGroupId",
        replication_group_region="replicationGroupRegion",
        resharding_configurations=[elasticache.CfnGlobalReplicationGroup.ReshardingConfigurationProperty(
            node_group_id="nodeGroupId",
            preferred_availability_zones=["preferredAvailabilityZones"]
        )]
    )]
)

Create a new AWS::ElastiCache::GlobalReplicationGroup.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • members (Union[IResolvable, Sequence[Union[IResolvable, GlobalReplicationGroupMemberProperty, Dict[str, Any]]]]) – The replication groups that comprise the Global datastore.

  • automatic_failover_enabled (Union[bool, IResolvable, None]) – Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

  • cache_node_type (Optional[str]) – The cache node type of the Global datastore.

  • cache_parameter_group_name (Optional[str]) – The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

  • engine_version (Optional[str]) – The Elasticache Redis engine version.

  • global_node_group_count (Union[int, float, None]) – The number of node groups that comprise the Global Datastore.

  • global_replication_group_description (Optional[str]) – The optional description of the Global datastore.

  • global_replication_group_id_suffix (Optional[str]) – The suffix name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

  • regional_configurations (Union[IResolvable, Sequence[Union[IResolvable, RegionalConfigurationProperty, Dict[str, Any]]], None]) – The Regions that comprise the Global Datastore.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ElastiCache::GlobalReplicationGroup'
attr_global_replication_group_id

The ID used to associate a secondary cluster to the Global Replication Group.

CloudformationAttribute

GlobalReplicationGroupId

Return type

str

attr_status

The status of the Global Datastore.

Can be Creating , Modifying , Available , Deleting or Primary-Only . Primary-only status indicates the global datastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully created.

CloudformationAttribute

Status

Return type

str

automatic_failover_enabled

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled

Return type

Union[bool, IResolvable, None]

cache_node_type

The cache node type of the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype

Return type

Optional[str]

cache_parameter_group_name

The name of the cache parameter group to use with the Global datastore.

It must be compatible with the major engine version used by the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

engine_version

The Elasticache Redis engine version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engineversion

Return type

Optional[str]

global_node_group_count

The number of node groups that comprise the Global Datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount

Return type

Union[int, float, None]

global_replication_group_description

The optional description of the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription

Return type

Optional[str]

global_replication_group_id_suffix

The suffix name of a Global Datastore.

The suffix guarantees uniqueness of the Global Datastore name across multiple regions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

members

The replication groups that comprise the Global datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members

Return type

Union[IResolvable, List[Union[IResolvable, GlobalReplicationGroupMemberProperty]]]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

regional_configurations

The Regions that comprise the Global Datastore.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, RegionalConfigurationProperty]], None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

GlobalReplicationGroupMemberProperty

class CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty(*, replication_group_id=None, replication_group_region=None, role=None)

Bases: object

A member of a Global datastore.

It contains the Replication Group Id, the Amazon region and the role of the replication group.

Parameters
  • replication_group_id (Optional[str]) – The replication group id of the Global datastore member.

  • replication_group_region (Optional[str]) – The Amazon region of the Global datastore member.

  • role (Optional[str]) – Indicates the role of the replication group, PRIMARY or SECONDARY .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache as elasticache

global_replication_group_member_property = elasticache.CfnGlobalReplicationGroup.GlobalReplicationGroupMemberProperty(
    replication_group_id="replicationGroupId",
    replication_group_region="replicationGroupRegion",
    role="role"
)

Attributes

replication_group_id

The replication group id of the Global datastore member.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupid

Return type

Optional[str]

replication_group_region

The Amazon region of the Global datastore member.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupregion

Return type

Optional[str]

role

Indicates the role of the replication group, PRIMARY or SECONDARY .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-role

Return type

Optional[str]

RegionalConfigurationProperty

class CfnGlobalReplicationGroup.RegionalConfigurationProperty(*, replication_group_id=None, replication_group_region=None, resharding_configurations=None)

Bases: object

A list of the replication groups.

Parameters
  • replication_group_id (Optional[str]) – The name of the secondary cluster.

  • replication_group_region (Optional[str]) – The Amazon region where the cluster is stored.

  • resharding_configurations (Union[IResolvable, Sequence[Union[IResolvable, ReshardingConfigurationProperty, Dict[str, Any]]], None]) – A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache as elasticache

regional_configuration_property = elasticache.CfnGlobalReplicationGroup.RegionalConfigurationProperty(
    replication_group_id="replicationGroupId",
    replication_group_region="replicationGroupRegion",
    resharding_configurations=[elasticache.CfnGlobalReplicationGroup.ReshardingConfigurationProperty(
        node_group_id="nodeGroupId",
        preferred_availability_zones=["preferredAvailabilityZones"]
    )]
)

Attributes

replication_group_id

The name of the secondary cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupid

Return type

Optional[str]

replication_group_region

The Amazon region where the cluster is stored.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupregion

Return type

Optional[str]

resharding_configurations

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-reshardingconfigurations

Return type

Union[IResolvable, List[Union[IResolvable, ReshardingConfigurationProperty]], None]

ReshardingConfigurationProperty

class CfnGlobalReplicationGroup.ReshardingConfigurationProperty(*, node_group_id=None, preferred_availability_zones=None)

Bases: object

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

Parameters
  • node_group_id (Optional[str]) – Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

  • preferred_availability_zones (Optional[Sequence[str]]) – A list of preferred availability zones for the nodes in this cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache as elasticache

resharding_configuration_property = elasticache.CfnGlobalReplicationGroup.ReshardingConfigurationProperty(
    node_group_id="nodeGroupId",
    preferred_availability_zones=["preferredAvailabilityZones"]
)

Attributes

node_group_id

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-nodegroupid

Return type

Optional[str]

preferred_availability_zones

A list of preferred availability zones for the nodes in this cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-preferredavailabilityzones

Return type

Optional[List[str]]