We recommend new projects start with resources from the AWS provider.
aws-native.elasticache.GlobalReplicationGroup
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.
Create GlobalReplicationGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GlobalReplicationGroup(name: string, args: GlobalReplicationGroupArgs, opts?: CustomResourceOptions);
@overload
def GlobalReplicationGroup(resource_name: str,
args: GlobalReplicationGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GlobalReplicationGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
members: Optional[Sequence[GlobalReplicationGroupMemberArgs]] = None,
automatic_failover_enabled: Optional[bool] = None,
cache_node_type: Optional[str] = None,
cache_parameter_group_name: Optional[str] = None,
engine: 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,
regional_configurations: Optional[Sequence[GlobalReplicationGroupRegionalConfigurationArgs]] = 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.
Parameters
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GlobalReplicationGroup resource accepts the following input properties:
- Members
List<Pulumi.
Aws Native. Elasti Cache. Inputs. Global Replication Group Member> - The replication groups that comprise the Global Datastore.
- Automatic
Failover boolEnabled - AutomaticFailoverEnabled
- Cache
Node stringType - The cache node type of the Global Datastore
- Cache
Parameter stringGroup Name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- Engine string
- The engine of the Global Datastore.
- Engine
Version string - The engine version of the Global Datastore.
- Global
Node intGroup Count - Indicates the number of node groups in the Global Datastore.
- Global
Replication stringGroup Description - The optional description of the Global Datastore
- Global
Replication stringGroup Id Suffix - 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 List<Pulumi.Aws Native. Elasti Cache. Inputs. Global Replication Group Regional Configuration> - Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
- Members
[]Global
Replication Group Member Args - The replication groups that comprise the Global Datastore.
- Automatic
Failover boolEnabled - AutomaticFailoverEnabled
- Cache
Node stringType - The cache node type of the Global Datastore
- Cache
Parameter stringGroup Name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- Engine string
- The engine of the Global Datastore.
- Engine
Version string - The engine version of the Global Datastore.
- Global
Node intGroup Count - Indicates the number of node groups in the Global Datastore.
- Global
Replication stringGroup Description - The optional description of the Global Datastore
- Global
Replication stringGroup Id Suffix - 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 []GlobalReplication Group Regional Configuration Args - 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<Global
Replication Group Member> - The replication groups that comprise the Global Datastore.
- automatic
Failover BooleanEnabled - AutomaticFailoverEnabled
- cache
Node StringType - The cache node type of the Global Datastore
- cache
Parameter StringGroup Name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- engine String
- The engine of the Global Datastore.
- engine
Version String - The engine version of the Global Datastore.
- global
Node IntegerGroup Count - Indicates the number of node groups in the Global Datastore.
- global
Replication StringGroup Description - The optional description of the Global Datastore
- global
Replication StringGroup Id Suffix - 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 List<GlobalReplication Group Regional Configuration> - Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore
- members
Global
Replication Group Member[] - The replication groups that comprise the Global Datastore.
- automatic
Failover booleanEnabled - AutomaticFailoverEnabled
- cache
Node stringType - The cache node type of the Global Datastore
- cache
Parameter stringGroup Name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- engine string
- The engine of the Global Datastore.
- engine
Version string - The engine version of the Global Datastore.
- global
Node numberGroup Count - Indicates the number of node groups in the Global Datastore.
- global
Replication stringGroup Description - The optional description of the Global Datastore
- global
Replication stringGroup Id Suffix - 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 GlobalReplication Group Regional Configuration[] - 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[Global
Replication Group Member Args] - The replication groups that comprise the Global Datastore.
- automatic_
failover_ boolenabled - AutomaticFailoverEnabled
- cache_
node_ strtype - The cache node type of the Global Datastore
- cache_
parameter_ strgroup_ name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- engine str
- The engine of the Global Datastore.
- engine_
version str - The engine version of the Global Datastore.
- global_
node_ intgroup_ count - Indicates the number of node groups in the Global Datastore.
- global_
replication_ strgroup_ description - The optional description of the Global Datastore
- global_
replication_ strgroup_ id_ suffix - 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[GlobalReplication Group Regional Configuration Args] - 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.
- automatic
Failover BooleanEnabled - AutomaticFailoverEnabled
- cache
Node StringType - The cache node type of the Global Datastore
- cache
Parameter StringGroup Name - Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
- engine String
- The engine of the Global Datastore.
- engine
Version String - The engine version of the Global Datastore.
- global
Node NumberGroup Count - Indicates the number of node groups in the Global Datastore.
- global
Replication StringGroup Description - The optional description of the Global Datastore
- global
Replication StringGroup Id Suffix - 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 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:
- Global
Replication stringGroup Id - 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 stringGroup Id - 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 StringGroup Id - 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 stringGroup Id - 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_ strgroup_ id - 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
- global
Replication StringGroup Id - 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, GlobalReplicationGroupMemberArgs
- Replication
Group stringId - Regionally unique identifier for the member i.e. ReplicationGroupId.
- Replication
Group stringRegion - The AWS region of the Global Datastore member.
- Role
Pulumi.
Aws Native. Elasti Cache. Global Replication Group Member Role - Indicates the role of the member, primary or secondary.
- Replication
Group stringId - Regionally unique identifier for the member i.e. ReplicationGroupId.
- Replication
Group stringRegion - The AWS region of the Global Datastore member.
- Role
Global
Replication Group Member Role - Indicates the role of the member, primary or secondary.
- replication
Group StringId - Regionally unique identifier for the member i.e. ReplicationGroupId.
- replication
Group StringRegion - The AWS region of the Global Datastore member.
- role
Global
Replication Group Member Role - Indicates the role of the member, primary or secondary.
- replication
Group stringId - Regionally unique identifier for the member i.e. ReplicationGroupId.
- replication
Group stringRegion - The AWS region of the Global Datastore member.
- role
Global
Replication Group Member Role - Indicates the role of the member, primary or secondary.
- replication_
group_ strid - Regionally unique identifier for the member i.e. ReplicationGroupId.
- replication_
group_ strregion - The AWS region of the Global Datastore member.
- role
Global
Replication Group Member Role - Indicates the role of the member, primary or secondary.
- replication
Group StringId - Regionally unique identifier for the member i.e. ReplicationGroupId.
- replication
Group StringRegion - The AWS region of the Global Datastore member.
- role "PRIMARY" | "SECONDARY"
- Indicates the role of the member, primary or secondary.
GlobalReplicationGroupMemberRole, GlobalReplicationGroupMemberRoleArgs
- Primary
- PRIMARY
- Secondary
- SECONDARY
- Global
Replication Group Member Role Primary - PRIMARY
- Global
Replication Group Member Role Secondary - SECONDARY
- Primary
- PRIMARY
- Secondary
- SECONDARY
- Primary
- PRIMARY
- Secondary
- SECONDARY
- PRIMARY
- PRIMARY
- SECONDARY
- SECONDARY
- "PRIMARY"
- PRIMARY
- "SECONDARY"
- SECONDARY
GlobalReplicationGroupRegionalConfiguration, GlobalReplicationGroupRegionalConfigurationArgs
- Replication
Group stringId - The replication group id of the Global Datastore member.
- Replication
Group stringRegion - The AWS region of the Global Datastore member.
- Resharding
Configurations List<Pulumi.Aws Native. Elasti Cache. Inputs. Global Replication Group Resharding Configuration> - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
- Replication
Group stringId - The replication group id of the Global Datastore member.
- Replication
Group stringRegion - The AWS region of the Global Datastore member.
- Resharding
Configurations []GlobalReplication Group Resharding Configuration - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
- replication
Group StringId - The replication group id of the Global Datastore member.
- replication
Group StringRegion - The AWS region of the Global Datastore member.
- resharding
Configurations List<GlobalReplication Group Resharding Configuration> - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
- replication
Group stringId - The replication group id of the Global Datastore member.
- replication
Group stringRegion - The AWS region of the Global Datastore member.
- resharding
Configurations GlobalReplication Group Resharding Configuration[] - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
- replication_
group_ strid - The replication group id of the Global Datastore member.
- replication_
group_ strregion - The AWS region of the Global Datastore member.
- resharding_
configurations Sequence[GlobalReplication Group Resharding Configuration] - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
- replication
Group StringId - The replication group id of the Global Datastore member.
- replication
Group StringRegion - The AWS region of the Global Datastore member.
- resharding
Configurations List<Property Map> - A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
GlobalReplicationGroupReshardingConfiguration, GlobalReplicationGroupReshardingConfigurationArgs
- Node
Group stringId - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- Preferred
Availability List<string>Zones - A list of preferred availability zones for the nodes of new node groups.
- Node
Group stringId - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- Preferred
Availability []stringZones - A list of preferred availability zones for the nodes of new node groups.
- node
Group StringId - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- preferred
Availability List<String>Zones - A list of preferred availability zones for the nodes of new node groups.
- node
Group stringId - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- preferred
Availability string[]Zones - A list of preferred availability zones for the nodes of new node groups.
- node_
group_ strid - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- preferred_
availability_ Sequence[str]zones - A list of preferred availability zones for the nodes of new node groups.
- node
Group StringId - Unique identifier for the Node Group. This is either auto-generated by ElastiCache (4-digit id) or a user supplied id.
- preferred
Availability List<String>Zones - A list of preferred availability zones for the nodes of new node groups.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.