Class: CacheCluster

ElastiCache.CacheCluster

new CacheCluster()

Properties:
Name Type Description
AutoMinorVersionUpgrade Boolean Required: No. Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.Default: trueUpdate requires: No interruption
AZMode String Required: Conditional. 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. For valid values, see CreateCacheCluster in the Amazon ElastiCache API Reference.Update requires: No interruption
CacheNodeType String Required: Yes. The compute and memory capacity of nodes in a cache cluster.Update requires: Replacement
CacheParameterGroupName String Required: No. The name of the cache parameter group that is associated with this cache cluster.Update requires: Some interruptions
CacheSecurityGroupNames String Required: Conditional. A list of cache security group names that are associated with this cache cluster. If your cache cluster is in a VPC, specify the VpcSecurityGroupIds property instead.Update requires: No interruption
CacheSubnetGroupName String Required: Conditional. The cache subnet group that you associate with a cache cluster.Update requires: Replacement
ClusterName String Required: No. 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. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.The name must contain 1 to 20 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.Update requires: Replacement
Engine String Required: Yes. The name of the cache engine to be used for this cache cluster, such as memcached or redis.Update requires: Replacement
EngineVersion String Required: No. The version of the cache engine to be used for this cluster.Update requires: Some interruptions
NotificationTopicArn String Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.Update requires: No interruption
NumCacheNodes String Required: Yes. The number of cache nodes that the cache cluster should have.Update requires: No interruption. However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement.
Port Number Required: No. The port number on which each of the cache nodes will accept connections.Update requires: Replacement
PreferredAvailabilityZone String Required: No. The Amazon EC2 Availability Zone in which the cache cluster is created.Update requires: Replacement
PreferredAvailabilityZones String Required: No. For Memcached cache clusters, the list of Availability Zones in which cache nodes are created. The number of Availability Zones listed must equal the number of cache nodes. For example, if you want to create three nodes in two different Availability Zones, you can specify ["us-east-1a", "us-east-1a", "us-east-1b"], which would create two nodes in us-east-1a and one node in us-east-1b.If you specify a subnet group and you're creating your cache cluster in a VPC, you must specify Availability Zones that are associated with the subnets in the subnet group that you've chosen.If you want all the nodes in the same Availability Zone, use the PreferredAvailabilityZone property or repeat the Availability Zone multiple times in the list.If you specify an Availability Zone that was previously specified in the template, such as in the PreferredAvailabilityZone property, the update requires some interruptions. Also, if the PreferredAvailabilityZones property was already specified and you're updating its values (regardless of whether you specify the same Availability Zones), the update requires some interruptions.All other updates require replacement.
PreferredMaintenanceWindow String Required: No. The weekly time range (in UTC) during which system maintenance can occur.Update requires: No interruption
SnapshotArns String Required: No. The ARN of the snapshot file that you want to use to seed a new Redis cache cluster. If you manage a Redis instance outside of Amazon ElastiCache, you can create a new cache cluster in ElastiCache by using a snapshot file that is stored in an Amazon S3 bucket.Update requires: Replacement
SnapshotName String Required: No. The name of a snapshot from which to restore data into a new Redis cache cluster.Update requires: Replacement
SnapshotRetentionLimit Number Required: No. For Redis cache clusters, the number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set the value to 5, a snapshot that was taken today will be retained for 5 days before being deleted.Update requires: No interruption
SnapshotWindow String Required: No. For Redis cache clusters, the daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group. For example, you can specify 05:00-09:00.Update requires: No interruption
Tags AWSCloudFormationResourceTags Required: No. An arbitrary set of tags (key–value pairs) for this cache cluster.Update requires: No interruption.
VpcSecurityGroupIds String Required: Conditional. A list of VPC security group IDs. If your cache cluster isn't in a VPC, specify the CacheSecurityGroupNames property instead. NoteYou must use the AWS::EC2::SecurityGroup resource instead of the AWS::ElastiCache::SecurityGroup resource in order to specify an ElastiCache security group that is in a VPC. In addition, if you use the default VPC for your AWS account, you must use the Fn::GetAtt function and the GroupId attribute to retrieve security group IDs (instead of the Ref function). To see a sample template, see the Template Snippet section. Update requires: No interruption
Source:

Extends

  • WKResource

ElastiCache.CacheCluster

new CacheCluster()

Properties:
Name Type Description
AutoMinorVersionUpgrade Boolean Required: No. Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.Default: trueUpdate requires: No interruption
AZMode String Required: Conditional. 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. For valid values, see CreateCacheCluster in the Amazon ElastiCache API Reference.Update requires: No interruption
CacheNodeType String Required: Yes. The compute and memory capacity of nodes in a cache cluster.Update requires: Replacement
CacheParameterGroupName String Required: No. The name of the cache parameter group that is associated with this cache cluster.Update requires: Some interruptions
CacheSecurityGroupNames String Required: Conditional. A list of cache security group names that are associated with this cache cluster. If your cache cluster is in a VPC, specify the VpcSecurityGroupIds property instead.Update requires: No interruption
CacheSubnetGroupName String Required: Conditional. The cache subnet group that you associate with a cache cluster.Update requires: Replacement
ClusterName String Required: No. 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. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.The name must contain 1 to 20 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.Update requires: Replacement
Engine String Required: Yes. The name of the cache engine to be used for this cache cluster, such as memcached or redis.Update requires: Replacement
EngineVersion String Required: No. The version of the cache engine to be used for this cluster.Update requires: Some interruptions
NotificationTopicArn String Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.Update requires: No interruption
NumCacheNodes String Required: Yes. The number of cache nodes that the cache cluster should have.Update requires: No interruption. However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement.
Port Number Required: No. The port number on which each of the cache nodes will accept connections.Update requires: Replacement
PreferredAvailabilityZone String Required: No. The Amazon EC2 Availability Zone in which the cache cluster is created.Update requires: Replacement
PreferredAvailabilityZones String Required: No. For Memcached cache clusters, the list of Availability Zones in which cache nodes are created. The number of Availability Zones listed must equal the number of cache nodes. For example, if you want to create three nodes in two different Availability Zones, you can specify ["us-east-1a", "us-east-1a", "us-east-1b"], which would create two nodes in us-east-1a and one node in us-east-1b.If you specify a subnet group and you're creating your cache cluster in a VPC, you must specify Availability Zones that are associated with the subnets in the subnet group that you've chosen.If you want all the nodes in the same Availability Zone, use the PreferredAvailabilityZone property or repeat the Availability Zone multiple times in the list.If you specify an Availability Zone that was previously specified in the template, such as in the PreferredAvailabilityZone property, the update requires some interruptions. Also, if the PreferredAvailabilityZones property was already specified and you're updating its values (regardless of whether you specify the same Availability Zones), the update requires some interruptions.All other updates require replacement.
PreferredMaintenanceWindow String Required: No. The weekly time range (in UTC) during which system maintenance can occur.Update requires: No interruption
SnapshotArns String Required: No. The ARN of the snapshot file that you want to use to seed a new Redis cache cluster. If you manage a Redis instance outside of Amazon ElastiCache, you can create a new cache cluster in ElastiCache by using a snapshot file that is stored in an Amazon S3 bucket.Update requires: Replacement
SnapshotName String Required: No. The name of a snapshot from which to restore data into a new Redis cache cluster.Update requires: Replacement
SnapshotRetentionLimit Number Required: No. For Redis cache clusters, the number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set the value to 5, a snapshot that was taken today will be retained for 5 days before being deleted.Update requires: No interruption
SnapshotWindow String Required: No. For Redis cache clusters, the daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group. For example, you can specify 05:00-09:00.Update requires: No interruption
Tags AWSCloudFormationResourceTags Required: No. An arbitrary set of tags (key–value pairs) for this cache cluster.Update requires: No interruption.
VpcSecurityGroupIds String Required: Conditional. A list of VPC security group IDs. If your cache cluster isn't in a VPC, specify the CacheSecurityGroupNames property instead. NoteYou must use the AWS::EC2::SecurityGroup resource instead of the AWS::ElastiCache::SecurityGroup resource in order to specify an ElastiCache security group that is in a VPC. In addition, if you use the default VPC for your AWS account, you must use the Fn::GetAtt function and the GroupId attribute to retrieve security group IDs (instead of the Ref function). To see a sample template, see the Template Snippet section. Update requires: No interruption
Source:

Extends

  • WKResource