Source: resources/elasticache.js

  1. 'use strict'
  3. const WKResource = require('./../resource').WKResource
  4. const ResourceAttribute = require('./../resourceattribute').ResourceAttribute
  5. const ResourceAttributeArray = require('./../resourceattribute').ResourceAttributeArray
  6. const tag = require('./../tag')
  7. const types = require('./../types')
  9. /** @module ElastiCache */
  11. /** @memberof module:ElastiCache
  12. *   @extends WKResource
  13. * @property {Boolean} AutoMinorVersionUpgrade Required: No. Indicates that minor engine upgrades will be applied automatically to the cache
  14.                   cluster during the maintenance window.Default: trueUpdate requires: No interruption
  15. * @property {String} AZMode Required: Conditional. For Memcached cache clusters, indicates whether the nodes are created in a
  16.                   single Availability Zone or across multiple Availability Zones in the cluster's
  17.                   region. For valid values, see CreateCacheCluster in
  18.                   the Amazon ElastiCache API Reference.Update requires: No interruption
  19. * @property {String} CacheNodeType Required: Yes. The compute and memory capacity of nodes in a cache cluster.Update requires: Replacement
  20. * @property {String} CacheParameterGroupName Required: No. The name of the cache parameter group that is associated with this cache
  21.                   cluster.Update requires: Some interruptions
  22. * @property {String} CacheSecurityGroupNames Required: Conditional. A list of cache security group names that are associated with this cache
  23.                   cluster. If your cache cluster is in a VPC, specify the
  24.                      VpcSecurityGroupIds property instead.Update requires: No interruption
  25. * @property {String} CacheSubnetGroupName Required: Conditional. The cache subnet group that you associate with a cache cluster.Update requires: Replacement
  26. * @property {String} ClusterName Required: No. A name for the cache cluster. If you don't specify a name, AWS CloudFormation generates a
  27.                   unique physical ID and uses that ID for the cache cluster. For more information,
  28.                   see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced.
  29. 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
  30.                   start with a letter and cannot end with a hyphen or contain two consecutive
  31.                   hyphens.Update requires: Replacement
  32. * @property {String} Engine Required: Yes. The name of the cache engine to be used for this cache cluster, such as
  33.                      memcached or redis.Update requires: Replacement
  34. * @property {String} EngineVersion Required: No. The version of the cache engine to be used for this cluster.Update requires: Some interruptions
  35. * @property {String} NotificationTopicArn Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS)
  36.                   topic to which notifications will be sent.Update requires: No interruption
  37. * @property {String} NumCacheNodes Required: Yes. The number of cache nodes that the cache cluster should have.Update requires: No interruption. However, if the PreferredAvailabilityZone
  38.                   and PreferredAvailabilityZones properties were not previously
  39.                   specified and you don't specify any new values, an update requires replacement.
  40. * @property {Number} Port Required: No. The port number on which each of the cache nodes will accept
  41.                   connections.Update requires: Replacement
  42. * @property {String} PreferredAvailabilityZone Required: No. The Amazon EC2 Availability Zone in which the cache cluster is created.Update requires: Replacement
  43. * @property {String} PreferredAvailabilityZones Required: No. For Memcached cache clusters, the list of Availability Zones in which cache
  44.                   nodes are created. The number of Availability Zones listed must equal the number
  45.                   of cache nodes. For example, if you want to create three nodes in two different
  46.                   Availability Zones, you can specify ["us-east-1a", "us-east-1a",
  47.                      "us-east-1b"], which would create two nodes in us-east-1a and one node
  48.                   in us-east-1b.If you specify a subnet group and you're creating your cache cluster in a VPC,
  49.                   you must specify Availability Zones that are associated with the subnets in the
  50.                   subnet group that you've chosen.If you want all the nodes in the same Availability Zone, use the
  51.                      PreferredAvailabilityZone property or repeat the Availability Zone
  52.                   multiple times in the list.If you specify an Availability Zone that was previously specified in the
  53.                   template, such as in the PreferredAvailabilityZone property, the
  54.                   update requires some interruptions.
  55.                   Also, if the PreferredAvailabilityZones property was already
  56.                   specified and you're updating its values (regardless of whether you specify the
  57.                   same Availability Zones), the update requires some interruptions.All other updates require replacement.
  58. * @property {String} PreferredMaintenanceWindow Required: No. The weekly time range (in UTC) during which system maintenance can
  59.                   occur.Update requires: No interruption
  60. * @property {String} SnapshotArns Required: No. The ARN of the snapshot file that you want to use to seed a new Redis cache
  61.                   cluster. If you manage a Redis instance outside of Amazon ElastiCache, you can create a new
  62.                   cache cluster in ElastiCache by using a snapshot file that is stored in an Amazon S3
  63.                   bucket.Update requires: Replacement
  64. * @property {String} SnapshotName Required: No. The name of a snapshot from which to restore data into a new Redis cache
  65.                   cluster.Update requires: Replacement
  66. * @property {Number} SnapshotRetentionLimit Required: No. For Redis cache clusters, the number of days for which ElastiCache retains automatic
  67.                   snapshots before deleting them. For example, if you set the value to
  68.                      5, a snapshot that was taken today will be retained for 5 days
  69.                   before being deleted.Update requires: No interruption
  70. * @property {String} SnapshotWindow Required: No. For Redis cache clusters, the daily time range (in UTC) during which ElastiCache will
  71.                   begin taking a daily snapshot of your node group. For example, you can specify
  72.                      05:00-09:00.Update requires: No interruption
  73. * @property {AWSCloudFormationResourceTags} Tags Required: No. An arbitrary set of tags (key–value pairs) for this cache
  74.                   cluster.Update requires: No interruption.
  75. * @property {String} VpcSecurityGroupIds Required: Conditional. A list of VPC security group IDs. If your cache cluster isn't in a VPC, specify
  76.                   the CacheSecurityGroupNames property instead.
  77.                   NoteYou must use the AWS::EC2::SecurityGroup resource instead of
  78.                         the AWS::ElastiCache::SecurityGroup resource in order to
  79.                         specify an ElastiCache security group that is in a VPC. In addition, if you use
  80.                         the default VPC for your
  81.                         AWS account, you must use the Fn::GetAtt function and the
  82.                            GroupId attribute to retrieve security group IDs (instead of
  83.                         the Ref function). To see a sample template, see the Template
  84.                         Snippet section.
  85.                Update requires: No interruption
  86. */
  87. class CacheCluster extends WKResource {
  88.   constructor (name, propertiesObject) {
  89.     let resourceType = 'AWS::ElastiCache::CacheCluster'
  90.     let properties = {
  91.       AutoMinorVersionUpgrade: new ResourceAttribute('AutoMinorVersionUpgrade', Boolean, 'No', null),
  92.       AZMode: new ResourceAttribute('AZMode', String, 'Conditional', null),
  93.       CacheNodeType: new ResourceAttribute('CacheNodeType', String, 'Yes', null),
  94.       CacheParameterGroupName: new ResourceAttribute('CacheParameterGroupName', String, 'No', null),
  95.       CacheSecurityGroupNames: new ResourceAttributeArray('CacheSecurityGroupNames', String, 'Conditional', null),
  96.       CacheSubnetGroupName: new ResourceAttribute('CacheSubnetGroupName', String, 'Conditional', null),
  97.       ClusterName: new ResourceAttribute('ClusterName', String, 'No', null),
  98.       Engine: new ResourceAttribute('Engine', String, 'Yes', null),
  99.       EngineVersion: new ResourceAttribute('EngineVersion', String, 'No', null),
  100.       NotificationTopicArn: new ResourceAttribute('NotificationTopicArn', String, 'No', null),
  101.       NumCacheNodes: new ResourceAttribute('NumCacheNodes', String, 'Yes', null),
  102.       Port: new ResourceAttribute('Port', Number, 'No', null),
  103.       PreferredAvailabilityZone: new ResourceAttribute('PreferredAvailabilityZone', String, 'No', null),
  104.       PreferredAvailabilityZones: new ResourceAttributeArray('PreferredAvailabilityZones', String, 'No', null),
  105.       PreferredMaintenanceWindow: new ResourceAttribute('PreferredMaintenanceWindow', String, 'No', null),
  106.       SnapshotArns: new ResourceAttributeArray('SnapshotArns', String, 'No', null),
  107.       SnapshotName: new ResourceAttribute('SnapshotName', String, 'No', null),
  108.       SnapshotRetentionLimit: new ResourceAttribute('SnapshotRetentionLimit', Number, 'No', null),
  109.       SnapshotWindow: new ResourceAttribute('SnapshotWindow', String, 'No', null),
  110.       Tags: new tag.TagSet(),
  111.       VpcSecurityGroupIds: new ResourceAttributeArray('VpcSecurityGroupIds', String, 'Conditional', null)
  112.     }
  113.     super(name, resourceType, properties, propertiesObject)
  114.   }
  115. }
  117. /** @memberof module:ElastiCache
  118. *   @extends WKResource
  119. * @property {String} CacheParameterGroupFamily Required: Yes. The name of the cache parameter group family that the cache parameter group can be used
  120.                with.Update requires: Updates are not supported.
  121. * @property {String} Description Required: Yes. The description for the Cache Parameter Group.Update requires: Updates are not supported.
  122. * @property {Map} Properties Required: No. A comma-delimited list of parameter name/value pairs. For more information, go to ModifyCacheParameterGroup in the Amazon ElastiCache API Reference
  123.                      Guide.Example:Update requires: Updates are not supported.
  124. */
  125. class ParameterGroup extends WKResource {
  126.   constructor (name, propertiesObject) {
  127.     let resourceType = 'AWS::ElastiCache::ParameterGroup'
  128.     let properties = {
  129.       CacheParameterGroupFamily: new ResourceAttribute('CacheParameterGroupFamily', String, 'Yes', null),
  130.       Description: new ResourceAttribute('Description', String, 'Yes', null),
  131.       Properties: new ResourceAttribute('Properties', Map, 'No', null)
  132.     }
  133.     super(name, resourceType, properties, propertiesObject)
  134.   }
  135. }
  137. /** @memberof module:ElastiCache
  138. *   @extends WKResource
  139. * @property {Boolean} AutomaticFailoverEnabled Required: No. Indicates whether Multi-AZ is enabled. When Multi-AZ is enabled, a read-only
  140.                   replica is automatically promoted to a read-write primary cluster if the existing
  141.                   primary cluster fails. If you specify true, you must specify a value
  142.                   greater than 1 for the NumCacheNodes property. By
  143.                   default, AWS CloudFormation sets the value to true.For more information about Multi-AZ, see Multi-AZ with Redis Replication Groups in the
  144.                      Amazon ElastiCache User Guide.NoteYou cannot enable automatic failover for Redis versions earlier than 2.8.6
  145.                      or for T1 and T2 cache node types.Update requires: No interruption
  146. * @property {Boolean} AutoMinorVersionUpgrade Required: No. Currently, this property isn't used by ElastiCache.Update requires: No interruption
  147. * @property {String} CacheNodeType Required: Yes. The compute and memory capacity of nodes in the node group. To see valid
  148.                   values, see CreateReplicationGroup in the Amazon ElastiCache API
  149.                      Reference Guide.Update requires: Replacement
  150. * @property {String} CacheParameterGroupName Required: No. The name of the parameter group to associate with this replication
  151.                   group.Update requires: No interruption
  152. * @property {String} CacheSecurityGroupNames Required: No. A list of cache security group names to associate with this replication group.
  153.                   If you specify the SecurityGroupIds property, do not specify this
  154.                   property; you can specify only one.Update requires: No interruption
  155. * @property {String} CacheSubnetGroupName Required: No. The name of a cache subnet group to use for this replication group.Update requires: Replacement
  156. * @property {String} Engine Required: Yes. The name of the cache engine to use for the cache clusters in this replication
  157.                   group. Currently, you can specify only redis.Update requires: Replacement
  158. * @property {String} EngineVersion Required: No. The version number of the cache engine to use for the cache clusters in this
  159.                   replication group.Update requires: No interruption
  160. * @property {String} NotificationTopicArn Required: No. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic to which notifications are
  161.                   sent.Update requires: No interruption
  162. * @property {Number} NumCacheClusters Required: Yes. The number of cache clusters for this replication group. If automatic failover
  163.                   is enabled, you must specify a value greater than 1.Update requires: Replacement
  164. * @property {Number} Port Required: No. The port number on which each member of the replication group accepts
  165.                   connections.Update requires: Replacement
  166. * @property {String} PreferredCacheClusterAZs Required: No. A list of Availability Zones (AZs) in which the cache clusters in this
  167.                   replication group are created.Update requires: Replacement
  168. * @property {String} PreferredMaintenanceWindow Required: No. The weekly time range during which system maintenance can occur. Use the
  169.                   following format to specify a time range: ddd:hh24:mi-ddd:hh24:mi
  170.                   (24H Clock UTC). For example, you can specify sun:22:00-sun:23:30 for
  171.                   Sunday from 10 PM to 11:30 PM.Update requires: No interruption
  172. * @property {String} ReplicationGroupDescription Required: Yes. The description of the replication group.Update requires: No interruption
  173. * @property {String} SecurityGroupIds Required: No. A list of Amazon Virtual Private Cloud (Amazon VPC) security groups to associate with this replication
  174.                   group. Use this property only when you are creating a replication group in a VPC.
  175.                   If you specify the CacheSecurityGroupNames property, do not specify
  176.                   this property; you can specify only one.Update requires: No interruption
  177. * @property {String} SnapshotArns Required: No. A single-element string list that specifies an ARN of a Redis
  178.                      .rdb snapshot file that is stored in Amazon Simple Storage Service (Amazon S3). The
  179.                   snapshot file populates the node group. The Amazon S3 object name in the ARN cannot
  180.                   contain commas. For example, you can specify
  181.                      arn:aws:s3:::my_bucket/snapshot1.rdb.Update requires: Replacement
  182. * @property {Number} SnapshotRetentionLimit Required: No. The number of days that ElastiCache retains automatic snapshots before deleting
  183.                   them.Update requires: No interruption
  184. * @property {String} SnapshotWindow Required: No. The time range (in UTC) when ElastiCache takes a daily snapshot of your node group.
  185.                   For example, you can specify 05:00-09:00.Update requires: No interruption
  186. */
  187. class ReplicationGroup extends WKResource {
  188.   constructor (name, propertiesObject) {
  189.     let resourceType = 'AWS::ElastiCache::ReplicationGroup'
  190.     let properties = {
  191.       AutomaticFailoverEnabled: new ResourceAttribute('AutomaticFailoverEnabled', Boolean, 'No', null),
  192.       AutoMinorVersionUpgrade: new ResourceAttribute('AutoMinorVersionUpgrade', Boolean, 'No', null),
  193.       CacheNodeType: new ResourceAttribute('CacheNodeType', String, 'Yes', null),
  194.       CacheParameterGroupName: new ResourceAttribute('CacheParameterGroupName', String, 'No', null),
  195.       CacheSecurityGroupNames: new ResourceAttributeArray('CacheSecurityGroupNames', String, 'No', null),
  196.       CacheSubnetGroupName: new ResourceAttribute('CacheSubnetGroupName', String, 'No', null),
  197.       Engine: new ResourceAttribute('Engine', String, 'Yes', null),
  198.       EngineVersion: new ResourceAttribute('EngineVersion', String, 'No', null),
  199.       NotificationTopicArn: new ResourceAttribute('NotificationTopicArn', String, 'No', null),
  200.       NumCacheClusters: new ResourceAttribute('NumCacheClusters', Number, 'Yes', null),
  201.       Port: new ResourceAttribute('Port', Number, 'No', null),
  202.       PreferredCacheClusterAZs: new ResourceAttributeArray('PreferredCacheClusterAZs', String, 'No', null),
  203.       PreferredMaintenanceWindow: new ResourceAttribute('PreferredMaintenanceWindow', String, 'No', null),
  204.       ReplicationGroupDescription: new ResourceAttribute('ReplicationGroupDescription', String, 'Yes', null),
  205.       SecurityGroupIds: new ResourceAttributeArray('SecurityGroupIds', String, 'No', null),
  206.       SnapshotArns: new ResourceAttributeArray('SnapshotArns', String, 'No', null),
  207.       SnapshotRetentionLimit: new ResourceAttribute('SnapshotRetentionLimit', Number, 'No', null),
  208.       SnapshotWindow: new ResourceAttribute('SnapshotWindow', String, 'No', null)
  209.     }
  210.     super(name, resourceType, properties, propertiesObject)
  211.   }
  212. }
  214. /** @memberof module:ElastiCache
  215. *   @extends WKResource
  216. * @property {String} Description Required: No. A description for the cache security group.Update requires: Updates are not supported.
  217. */
  218. class SecurityGroup extends WKResource {
  219.   constructor (name, propertiesObject) {
  220.     let resourceType = 'AWS::ElastiCache::SecurityGroup'
  221.     let properties = {
  222.       Description: new ResourceAttribute('Description', String, 'No', null)
  223.     }
  224.     super(name, resourceType, properties, propertiesObject)
  225.   }
  226. }
  228. /** @memberof module:ElastiCache
  229. *   @extends WKResource
  230. * @property {String} CacheSecurityGroupName Required: Yes. The name of the Cache Security Group to authorize.Update requires: Updates are not supported.
  231. * @property {String} EC2SecurityGroupName Required: Yes. Name of the EC2 Security Group to include in the authorization.Update requires: Updates are not supported.
  232. * @property {String} EC2SecurityGroupOwnerId Required: No. Specifies the AWS Account ID of the owner of the EC2 security group specified
  233.                   in the EC2SecurityGroupName property. The AWS access key ID is not an acceptable
  234.                   value.Update requires: Updates are not supported.
  235. */
  236. class SecurityGroupIngress extends WKResource {
  237.   constructor (name, propertiesObject) {
  238.     let resourceType = 'AWS::ElastiCache::SecurityGroupIngress'
  239.     let properties = {
  240.       CacheSecurityGroupName: new ResourceAttribute('CacheSecurityGroupName', String, 'Yes', null),
  241.       EC2SecurityGroupName: new ResourceAttribute('EC2SecurityGroupName', String, 'Yes', null),
  242.       EC2SecurityGroupOwnerId: new ResourceAttribute('EC2SecurityGroupOwnerId', String, 'No', null)
  243.     }
  244.     super(name, resourceType, properties, propertiesObject)
  245.   }
  246. }
  248. /** @memberof module:ElastiCache
  249. *   @extends WKResource
  250. * @property {String} Description Required: Yes. The description for the cache subnet group.Update requires: No interruption
  251. * @property {String} SubnetIds Required: Yes. The Amazon EC2 subnet IDs for the cache subnet group.Update requires: No interruption
  252. */
  253. class SubnetGroup extends WKResource {
  254.   constructor (name, propertiesObject) {
  255.     let resourceType = 'AWS::ElastiCache::SubnetGroup'
  256.     let properties = {
  257.       Description: new ResourceAttribute('Description', String, 'Yes', null),
  258.       SubnetIds: new ResourceAttributeArray('SubnetIds', String, 'Yes', null)
  259.     }
  260.     super(name, resourceType, properties, propertiesObject)
  261.   }
  262. }
  264. module.exports = {  CacheCluster: CacheCluster,
  265.   ParameterGroup: ParameterGroup,
  266.   ReplicationGroup: ReplicationGroup,
  267.   SecurityGroup: SecurityGroup,
  268.   SecurityGroupIngress: SecurityGroupIngress,
  269.   SubnetGroup: SubnetGroup
  270. }