AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

GlobalReplicationGroup

The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.

Create a GlobalReplicationGroup Resource

new GlobalReplicationGroup(name: string, args: GlobalReplicationGroupArgs, opts?: CustomResourceOptions);
@overload
def GlobalReplicationGroup(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           automatic_failover_enabled: Optional[bool] = None,
                           cache_node_type: Optional[str] = None,
                           cache_parameter_group_name: Optional[str] = None,
                           engine_version: Optional[str] = None,
                           global_node_group_count: Optional[int] = None,
                           global_replication_group_description: Optional[str] = None,
                           global_replication_group_id_suffix: Optional[str] = None,
                           members: Optional[Sequence[GlobalReplicationGroupMemberArgs]] = None,
                           regional_configurations: Optional[Sequence[GlobalReplicationGroupRegionalConfigurationArgs]] = None)
@overload
def GlobalReplicationGroup(resource_name: str,
                           args: GlobalReplicationGroupArgs,
                           opts: Optional[ResourceOptions] = None)
func NewGlobalReplicationGroup(ctx *Context, name string, args GlobalReplicationGroupArgs, opts ...ResourceOption) (*GlobalReplicationGroup, error)
public GlobalReplicationGroup(string name, GlobalReplicationGroupArgs args, CustomResourceOptions? opts = null)
public GlobalReplicationGroup(String name, GlobalReplicationGroupArgs args)
public GlobalReplicationGroup(String name, GlobalReplicationGroupArgs args, CustomResourceOptions options)
type: aws-native:elasticache:GlobalReplicationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args GlobalReplicationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args GlobalReplicationGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GlobalReplicationGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GlobalReplicationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GlobalReplicationGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

GlobalReplicationGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The GlobalReplicationGroup resource accepts the following input properties:

Members List<Pulumi.AwsNative.ElastiCache.Inputs.GlobalReplicationGroupMemberArgs>

The replication groups that comprise the Global Datastore.

AutomaticFailoverEnabled bool

AutomaticFailoverEnabled

CacheNodeType string

The cache node type of the Global Datastore

CacheParameterGroupName string

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

EngineVersion string

The engine version of the Global Datastore.

GlobalNodeGroupCount int

Indicates the number of node groups in the Global Datastore.

GlobalReplicationGroupDescription string

The optional description of the Global Datastore

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

RegionalConfigurations List<Pulumi.AwsNative.ElastiCache.Inputs.GlobalReplicationGroupRegionalConfigurationArgs>

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

Members []GlobalReplicationGroupMemberArgs

The replication groups that comprise the Global Datastore.

AutomaticFailoverEnabled bool

AutomaticFailoverEnabled

CacheNodeType string

The cache node type of the Global Datastore

CacheParameterGroupName string

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

EngineVersion string

The engine version of the Global Datastore.

GlobalNodeGroupCount int

Indicates the number of node groups in the Global Datastore.

GlobalReplicationGroupDescription string

The optional description of the Global Datastore

GlobalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

RegionalConfigurations []GlobalReplicationGroupRegionalConfigurationArgs

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

members List<GlobalReplicationGroupMemberArgs>

The replication groups that comprise the Global Datastore.

automaticFailoverEnabled Boolean

AutomaticFailoverEnabled

cacheNodeType String

The cache node type of the Global Datastore

cacheParameterGroupName String

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

engineVersion String

The engine version of the Global Datastore.

globalNodeGroupCount Integer

Indicates the number of node groups in the Global Datastore.

globalReplicationGroupDescription String

The optional description of the Global Datastore

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

regionalConfigurations List<GlobalReplicationGroupRegionalConfigurationArgs>

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

members GlobalReplicationGroupMemberArgs[]

The replication groups that comprise the Global Datastore.

automaticFailoverEnabled boolean

AutomaticFailoverEnabled

cacheNodeType string

The cache node type of the Global Datastore

cacheParameterGroupName string

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

engineVersion string

The engine version of the Global Datastore.

globalNodeGroupCount number

Indicates the number of node groups in the Global Datastore.

globalReplicationGroupDescription string

The optional description of the Global Datastore

globalReplicationGroupIdSuffix string

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

regionalConfigurations GlobalReplicationGroupRegionalConfigurationArgs[]

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

members Sequence[GlobalReplicationGroupMemberArgs]

The replication groups that comprise the Global Datastore.

automatic_failover_enabled bool

AutomaticFailoverEnabled

cache_node_type str

The cache node type of the Global Datastore

cache_parameter_group_name str

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

engine_version str

The engine version of the Global Datastore.

global_node_group_count int

Indicates the number of node groups in the Global Datastore.

global_replication_group_description str

The optional description of the Global Datastore

global_replication_group_id_suffix str

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

regional_configurations Sequence[GlobalReplicationGroupRegionalConfigurationArgs]

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

members List<Property Map>

The replication groups that comprise the Global Datastore.

automaticFailoverEnabled Boolean

AutomaticFailoverEnabled

cacheNodeType String

The cache node type of the Global Datastore

cacheParameterGroupName String

Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.

engineVersion String

The engine version of the Global Datastore.

globalNodeGroupCount Number

Indicates the number of node groups in the Global Datastore.

globalReplicationGroupDescription String

The optional description of the Global Datastore

globalReplicationGroupIdSuffix String

The suffix name of a Global Datastore. Amazon ElastiCache automatically applies a prefix to the Global Datastore ID when it is created. Each AWS Region has its own prefix.

regionalConfigurations List<Property Map>

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore

Outputs

All input properties are implicitly available as output properties. Additionally, the GlobalReplicationGroup resource produces the following output properties:

GlobalReplicationGroupId string

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The status of the Global Datastore

GlobalReplicationGroupId string

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The status of the Global Datastore

globalReplicationGroupId String

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

id String

The provider-assigned unique ID for this managed resource.

status String

The status of the Global Datastore

globalReplicationGroupId string

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

id string

The provider-assigned unique ID for this managed resource.

status string

The status of the Global Datastore

global_replication_group_id str

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

id str

The provider-assigned unique ID for this managed resource.

status str

The status of the Global Datastore

globalReplicationGroupId String

The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

id String

The provider-assigned unique ID for this managed resource.

status String

The status of the Global Datastore

Supporting Types

GlobalReplicationGroupMember

ReplicationGroupId string

Regionally unique identifier for the member i.e. ReplicationGroupId.

ReplicationGroupRegion string

The AWS region of the Global Datastore member.

Role Pulumi.AwsNative.ElastiCache.GlobalReplicationGroupMemberRole

Indicates the role of the member, primary or secondary.

ReplicationGroupId string

Regionally unique identifier for the member i.e. ReplicationGroupId.

ReplicationGroupRegion string

The AWS region of the Global Datastore member.

Role GlobalReplicationGroupMemberRole

Indicates the role of the member, primary or secondary.

replicationGroupId String

Regionally unique identifier for the member i.e. ReplicationGroupId.

replicationGroupRegion String

The AWS region of the Global Datastore member.

role GlobalReplicationGroupMemberRole

Indicates the role of the member, primary or secondary.

replicationGroupId string

Regionally unique identifier for the member i.e. ReplicationGroupId.

replicationGroupRegion string

The AWS region of the Global Datastore member.

role GlobalReplicationGroupMemberRole

Indicates the role of the member, primary or secondary.

replication_group_id str

Regionally unique identifier for the member i.e. ReplicationGroupId.

replication_group_region str

The AWS region of the Global Datastore member.

role GlobalReplicationGroupMemberRole

Indicates the role of the member, primary or secondary.

replicationGroupId String

Regionally unique identifier for the member i.e. ReplicationGroupId.

replicationGroupRegion String

The AWS region of the Global Datastore member.

role "PRIMARY" | "SECONDARY"

Indicates the role of the member, primary or secondary.

GlobalReplicationGroupMemberRole

Primary
PRIMARY
Secondary
SECONDARY
GlobalReplicationGroupMemberRolePrimary
PRIMARY
GlobalReplicationGroupMemberRoleSecondary
SECONDARY
Primary
PRIMARY
Secondary
SECONDARY
Primary
PRIMARY
Secondary
SECONDARY
PRIMARY
PRIMARY
SECONDARY
SECONDARY
"PRIMARY"
PRIMARY
"SECONDARY"
SECONDARY

GlobalReplicationGroupRegionalConfiguration

ReplicationGroupId string

The replication group id of the Global Datastore member.

ReplicationGroupRegion string

The AWS region of the Global Datastore member.

ReshardingConfigurations List<Pulumi.AwsNative.ElastiCache.Inputs.GlobalReplicationGroupReshardingConfiguration>

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

ReplicationGroupId string

The replication group id of the Global Datastore member.

ReplicationGroupRegion string

The AWS region of the Global Datastore member.

ReshardingConfigurations []GlobalReplicationGroupReshardingConfiguration

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

replicationGroupId String

The replication group id of the Global Datastore member.

replicationGroupRegion String

The AWS region of the Global Datastore member.

reshardingConfigurations List<GlobalReplicationGroupReshardingConfiguration>

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

replicationGroupId string

The replication group id of the Global Datastore member.

replicationGroupRegion string

The AWS region of the Global Datastore member.

reshardingConfigurations GlobalReplicationGroupReshardingConfiguration[]

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

replication_group_id str

The replication group id of the Global Datastore member.

replication_group_region str

The AWS region of the Global Datastore member.

resharding_configurations Sequence[GlobalReplicationGroupReshardingConfiguration]

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

replicationGroupId String

The replication group id of the Global Datastore member.

replicationGroupRegion String

The AWS region of the Global Datastore member.

reshardingConfigurations List<Property Map>

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

GlobalReplicationGroupReshardingConfiguration

NodeGroupId string

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

PreferredAvailabilityZones List<string>

A list of preferred availability zones for the nodes of new node groups.

NodeGroupId string

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

PreferredAvailabilityZones []string

A list of preferred availability zones for the nodes of new node groups.

nodeGroupId String

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

preferredAvailabilityZones List<String>

A list of preferred availability zones for the nodes of new node groups.

nodeGroupId string

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

preferredAvailabilityZones string[]

A list of preferred availability zones for the nodes of new node groups.

node_group_id str

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

preferred_availability_zones Sequence[str]

A list of preferred availability zones for the nodes of new node groups.

nodeGroupId String

Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.

preferredAvailabilityZones List<String>

A list of preferred availability zones for the nodes of new node groups.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0