< Back
Add-CfnElastiCache_CacheClusterResource
Post
NAME Add-CfnElastiCache_CacheClusterResource
SYNOPSIS
The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.
SYNTAX
Add-CfnElastiCache_CacheClusterResource [-ResourceName] <String> [-AutoMinorVersionUpgrade <Boolean>] [-AZMode
<String>] [-CacheNodeType <String>] [-CacheParameterGroupName <String>] [-CacheSecurityGroupNames <String[]>]
[-CacheSubnetGroupName <String>] [-ClusterName <String>] [-Engine <String>] [-EngineVersion <String>]
[-NotificationTopicArn <String>] [-NumCacheNodes <String>] [-Port <Int32>] [-PreferredAvailabilityZone <String>]
[-PreferredMaintenanceWindow <String>] [-SnapshotArns <String[]>] [-SnapshotName <String>] [-VpcSecurityGroupIds
<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
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance
window.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AZMode <String>
For Memcached cache clusters, indicates whether the nodes are created in a single Availability Zone or across
multiple Availability Zones in the cluster's region.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheNodeType <String>
The compute and memory capacity of nodes in a cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheParameterGroupName <String>
The name of the cache parameter group associated with this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSecurityGroupNames <String[]>
A list of cache security group names associated with this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSubnetGroupName <String>
The cache subnet group that you associate with a cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClusterName <String>
A name for the cache cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID
and uses that ID for the cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the cache engine to be used for this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version of the cache engine to be used for this cluster.
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
-NumCacheNodes <String>
The number of cache nodes the cache cluster should have.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which each of the cache nodes will accept connections.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PreferredAvailabilityZone <String>
The EC2 Availability Zone that the cache cluster will be created in.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range (in UTC) during which system maintenance can occur. Example: sun:05:00-sun:09:00
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotArns <String[]>
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB
snapshot file stored in Amazon S3. The snapshot file will be used to populate the Redis cache in the new cache
cluster. The Amazon S3 object name in the ARN cannot contain any commas.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotName <String>
The name of a snapshot from which to restore data into a new Redis cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VpcSecurityGroupIds <String[]>
One or more VPC security groups associated with the cache cluster.
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 ... CacheClust
er
SYNOPSIS
The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.
SYNTAX
Add-CfnElastiCache_CacheClusterResource [-ResourceName] <String> [-AutoMinorVersionUpgrade <Boolean>] [-AZMode
<String>] [-CacheNodeType <String>] [-CacheParameterGroupName <String>] [-CacheSecurityGroupNames <String[]>]
[-CacheSubnetGroupName <String>] [-ClusterName <String>] [-Engine <String>] [-EngineVersion <String>]
[-NotificationTopicArn <String>] [-NumCacheNodes <String>] [-Port <Int32>] [-PreferredAvailabilityZone <String>]
[-PreferredMaintenanceWindow <String>] [-SnapshotArns <String[]>] [-SnapshotName <String>] [-VpcSecurityGroupIds
<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
-AutoMinorVersionUpgrade <Boolean>
Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance
window.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AZMode <String>
For Memcached cache clusters, indicates whether the nodes are created in a single Availability Zone or across
multiple Availability Zones in the cluster's region.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheNodeType <String>
The compute and memory capacity of nodes in a cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheParameterGroupName <String>
The name of the cache parameter group associated with this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSecurityGroupNames <String[]>
A list of cache security group names associated with this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CacheSubnetGroupName <String>
The cache subnet group that you associate with a cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClusterName <String>
A name for the cache cluster. If you don't specify a name, AWS CloudFormation generates a unique physical ID
and uses that ID for the cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Engine <String>
The name of the cache engine to be used for this cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EngineVersion <String>
The version of the cache engine to be used for this cluster.
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
-NumCacheNodes <String>
The number of cache nodes the cache cluster should have.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
The port number on which each of the cache nodes will accept connections.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PreferredAvailabilityZone <String>
The EC2 Availability Zone that the cache cluster will be created in.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PreferredMaintenanceWindow <String>
The weekly time range (in UTC) during which system maintenance can occur. Example: sun:05:00-sun:09:00
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotArns <String[]>
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB
snapshot file stored in Amazon S3. The snapshot file will be used to populate the Redis cache in the new cache
cluster. The Amazon S3 object name in the ARN cannot contain any commas.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnapshotName <String>
The name of a snapshot from which to restore data into a new Redis cache cluster.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-VpcSecurityGroupIds <String[]>
One or more VPC security groups associated with the cache cluster.
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 ... CacheClust
er