< Back
Add-CfnElastiCache_ReplicationGroupResource
Post
NAME Add-CfnElastiCache_ReplicationGroupResource
SYNOPSIS
The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache replication group.
SYNTAX
Add-CfnElastiCache_ReplicationGroupResource [-ResourceName] <String> [-AutomaticFailoverEnabled <Boolean>]
[-AutoMinorVersionUpgrade <Boolean>] [-CacheNodeType <String>] [-CacheParameterGroupName <String>]
[-CacheSecurityGroupNames <String[]>] [-CacheSubnetGroupName <String>] [-Engine <String>] [-EngineVersion
<String>] [-NotificationTopicArn <String>] [-NumCacheClusters <Int32>] [-Port <Int32>] [-PreferredCacheClusterAZs
<String[]>] [-PreferredMaintenanceWindow <String>] [-ReplicationGroupDescription <String>] [-SecurityGroupIds
<String[]>] [-SnapshotArns <String[]>] [-SnapshotRetentionLimit <Int32>] [-SnapshotWindow <String>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticFailoverEnabled <Boolean>
Indicates whether Multi-AZ is enabled.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AutoMinorVersionUpgrade <Boolean>
Currently, this property isn't used by ElastiCache.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-CacheNodeType <String>
The compute and memory capacity of nodes in the node group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheParameterGroupName <String>
The name of the parameter group to associate with this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSecurityGroupNames <String[]>
A list of cache security group names to associate with this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSubnetGroupName <String>
The name of a cache subnet group to use for this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the cache engine to use for the cache clusters in this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version number of the cache engine to use for the cache clusters in this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationTopicArn <String>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications
will be sent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NumCacheClusters <Int32>
The number of cache clusters this replication group will initially have. If Multi-AZ is enabled, the value of
this parameter must be at least 2.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which each member of the replication group accepts connections.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PreferredCacheClusterAZs <String[]>
A list of Availability Zones (AZs) in which the cache clusters in this replication group are created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur. Use the following format to specify a time
range: ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). For example, you can specify sun:22:00-sun:23:30 for Sunday
from 10 PM to 11:30 PM.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicationGroupDescription <String>
The description of the replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityGroupIds <String[]>
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication group.
Use this property only when you are creating a replication group in a VPC. If you specify the
CacheSecurityGroupNames property, do not specify this property; you can specify only one.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotArns <String[]>
A single-element string list that specifies an ARN of a Redis .rdb snapshot file that is stored in Amazon
Simple Storage Service (Amazon S3). The snapshot file populates the node group. The Amazon S3 object name in
the ARN cannot contain commas. For example, you can specify arn:aws:s3:::my_bucket/snapshot1.rdb.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotRetentionLimit <Int32>
The number of days that ElastiCache retains automatic snapshots before deleting them.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotWindow <String>
The time range (in UTC) when ElastiCache takes a daily snapshot of your node group. For example, you can
specify 05:00-09:00.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... Replicatio
nGroup
SYNOPSIS
The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache replication group.
SYNTAX
Add-CfnElastiCache_ReplicationGroupResource [-ResourceName] <String> [-AutomaticFailoverEnabled <Boolean>]
[-AutoMinorVersionUpgrade <Boolean>] [-CacheNodeType <String>] [-CacheParameterGroupName <String>]
[-CacheSecurityGroupNames <String[]>] [-CacheSubnetGroupName <String>] [-Engine <String>] [-EngineVersion
<String>] [-NotificationTopicArn <String>] [-NumCacheClusters <Int32>] [-Port <Int32>] [-PreferredCacheClusterAZs
<String[]>] [-PreferredMaintenanceWindow <String>] [-ReplicationGroupDescription <String>] [-SecurityGroupIds
<String[]>] [-SnapshotArns <String[]>] [-SnapshotRetentionLimit <Int32>] [-SnapshotWindow <String>]
[-DeletionPolicy <String>] [-Metadata <Hashtable>] [-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>]
[-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticFailoverEnabled <Boolean>
Indicates whether Multi-AZ is enabled.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AutoMinorVersionUpgrade <Boolean>
Currently, this property isn't used by ElastiCache.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-CacheNodeType <String>
The compute and memory capacity of nodes in the node group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheParameterGroupName <String>
The name of the parameter group to associate with this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSecurityGroupNames <String[]>
A list of cache security group names to associate with this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSubnetGroupName <String>
The name of a cache subnet group to use for this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the cache engine to use for the cache clusters in this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version number of the cache engine to use for the cache clusters in this replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NotificationTopicArn <String>
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications
will be sent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NumCacheClusters <Int32>
The number of cache clusters this replication group will initially have. If Multi-AZ is enabled, the value of
this parameter must be at least 2.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which each member of the replication group accepts connections.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PreferredCacheClusterAZs <String[]>
A list of Availability Zones (AZs) in which the cache clusters in this replication group are created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range during which system maintenance can occur. Use the following format to specify a time
range: ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). For example, you can specify sun:22:00-sun:23:30 for Sunday
from 10 PM to 11:30 PM.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicationGroupDescription <String>
The description of the replication group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecurityGroupIds <String[]>
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication group.
Use this property only when you are creating a replication group in a VPC. If you specify the
CacheSecurityGroupNames property, do not specify this property; you can specify only one.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotArns <String[]>
A single-element string list that specifies an ARN of a Redis .rdb snapshot file that is stored in Amazon
Simple Storage Service (Amazon S3). The snapshot file populates the node group. The Amazon S3 object name in
the ARN cannot contain commas. For example, you can specify arn:aws:s3:::my_bucket/snapshot1.rdb.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotRetentionLimit <Int32>
The number of days that ElastiCache retains automatic snapshots before deleting them.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotWindow <String>
The time range (in UTC) when ElastiCache takes a daily snapshot of your node group. For example, you can
specify 05:00-09:00.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... Replicatio
nGroup