Stratosphere.Resources.CacheCluster

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

Documentation

data CacheCluster

Full data type definition for CacheCluster. See cacheCluster for a more convenient constructor.

Constructors

CacheCluster

Fields

• _cacheClusterAutoMinorVersionUpgrade :: Maybe (Val Bool')
• _cacheClusterAZMode :: Maybe (Val Text)
• _cacheClusterCacheNodeType :: Val Text
• _cacheClusterCacheParameterGroupName :: Maybe (Val Text)
• _cacheClusterCacheSecurityGroupNames :: Maybe [Val Text]
• _cacheClusterCacheSubnetGroupName :: Maybe (Val Text)
• _cacheClusterClusterName :: Maybe (Val Text)
• _cacheClusterEngine :: Val Text
• _cacheClusterEngineVersion :: Maybe (Val Text)
• _cacheClusterNotificationTopicArn :: Maybe (Val Text)
• _cacheClusterNumCacheNodes :: Val Integer'
• _cacheClusterPort :: Maybe (Val Integer')
• _cacheClusterPreferredAvailabilityZone :: Maybe (Val Text)
• _cacheClusterPreferredAvailabilityZones :: Maybe [Val Text]
• _cacheClusterPreferredMaintenanceWindow :: Maybe (Val Text)
• _cacheClusterSnapshotArns :: Maybe [Val Text]
• _cacheClusterSnapshotName :: Maybe (Val Text)
• _cacheClusterSnapshotRetentionLimit :: Maybe (Val Integer')
• _cacheClusterSnapshotWindow :: Maybe (Val Text)
• _cacheClusterTags :: Maybe [ResourceTag]
• _cacheClusterVpcSecurityGroupIds :: Maybe [Val Text]

Instances

Show CacheCluster

Methods

showsPrec :: Int -> CacheCluster -> ShowS

show :: CacheCluster -> String

showList :: [CacheCluster] -> ShowS

Generic CacheCluster

Associated Types

type Rep CacheCluster :: * -> *

Methods

from :: CacheCluster -> Rep CacheCluster x

to :: Rep CacheCluster x -> CacheCluster

ToJSON CacheCluster

Methods

toJSON :: CacheCluster -> Value

toEncoding :: CacheCluster -> Encoding

toJSONList :: [CacheCluster] -> Value

toEncodingList :: [CacheCluster] -> Encoding

FromJSON CacheCluster

Methods

parseJSON :: Value -> Parser CacheCluster

parseJSONList :: Value -> Parser [CacheCluster]

type Rep CacheCluster

type Rep CacheCluster = D1 (MetaData "CacheCluster" "Stratosphere.Resources.CacheCluster" "stratosphere-0.2.1-7UjeTxLOKRACY1vyFAxa7V" False) (C1 (MetaCons "CacheCluster" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterAutoMinorVersionUpgrade") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Bool')))) (S1 (MetaSel (Just Symbol "_cacheClusterAZMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterCacheNodeType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterCacheParameterGroupName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_cacheClusterCacheSecurityGroupNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Val Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterCacheSubnetGroupName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_cacheClusterClusterName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterEngine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterEngineVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_cacheClusterNotificationTopicArn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterNumCacheNodes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Integer'))) (S1 (MetaSel (Just Symbol "_cacheClusterPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer'))))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterPreferredAvailabilityZone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterPreferredAvailabilityZones") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Val Text]))) (S1 (MetaSel (Just Symbol "_cacheClusterPreferredMaintenanceWindow") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterSnapshotArns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Val Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterSnapshotName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_cacheClusterSnapshotRetentionLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Integer')))))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterSnapshotWindow") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cacheClusterTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ResourceTag]))) (S1 (MetaSel (Just Symbol "_cacheClusterVpcSecurityGroupIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Val Text])))))))))

cacheCluster

Arguments

:: Val Text

ccCacheNodeType

-> Val Text

ccEngine

-> Val Integer'

ccNumCacheNodes

-> CacheCluster

Constructor for CacheCluster containing required fields as arguments.

ccAutoMinorVersionUpgrade :: Lens' CacheCluster (Maybe (Val Bool'))

Indicates that minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

ccAZMode :: Lens' CacheCluster (Maybe (Val Text))

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.

ccCacheNodeType :: Lens' CacheCluster (Val Text)

The compute and memory capacity of nodes in a cache cluster.

ccCacheParameterGroupName :: Lens' CacheCluster (Maybe (Val Text))

The name of the cache parameter group that is associated with this cache cluster.

ccCacheSecurityGroupNames :: Lens' CacheCluster (Maybe [Val Text])

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.

ccCacheSubnetGroupName :: Lens' CacheCluster (Maybe (Val Text))

The cache subnet group that you associate with a cache cluster.

ccClusterName :: Lens' CacheCluster (Maybe (Val Text))

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. Important If 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.

ccEngine :: Lens' CacheCluster (Val Text)

The name of the cache engine to be used for this cache cluster, such as memcached or redis.

ccEngineVersion :: Lens' CacheCluster (Maybe (Val Text))

The version of the cache engine to be used for this cluster.

ccNotificationTopicArn :: Lens' CacheCluster (Maybe (Val Text))

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

ccNumCacheNodes :: Lens' CacheCluster (Val Integer')

The number of cache nodes that the cache cluster should have.

ccPort :: Lens' CacheCluster (Maybe (Val Integer'))

The port number on which each of the cache nodes will accept connections.

ccPreferredAvailabilityZone :: Lens' CacheCluster (Maybe (Val Text))

The Amazon EC2 Availability Zone in which the cache cluster is created.

ccPreferredAvailabilityZones :: Lens' CacheCluster (Maybe [Val Text])

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.

ccPreferredMaintenanceWindow :: Lens' CacheCluster (Maybe (Val Text))

The weekly time range (in UTC) during which system maintenance can occur.

ccSnapshotArns :: Lens' CacheCluster (Maybe [Val Text])

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.

ccSnapshotName :: Lens' CacheCluster (Maybe (Val Text))

The name of a snapshot from which to restore data into a new Redis cache cluster.

ccSnapshotRetentionLimit :: Lens' CacheCluster (Maybe (Val Integer'))

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.

ccSnapshotWindow :: Lens' CacheCluster (Maybe (Val Text))

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.

ccTags :: Lens' CacheCluster (Maybe [ResourceTag])

An arbitrary set of tags (key–value pairs) for this cache cluster.

ccVpcSecurityGroupIds :: Lens' CacheCluster (Maybe [Val Text])

A list of VPC security group IDs. If your cache cluster isn't in a VPC, specify the CacheSecurityGroupNames property instead. Note You 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.