Documentation ¶
Index ¶
- func CfnCacheCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCacheCluster_IsCfnElement(x interface{}) *bool
- func CfnCacheCluster_IsCfnResource(x interface{}) *bool
- func CfnCacheCluster_IsConstruct(x interface{}) *bool
- func CfnGlobalReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGlobalReplicationGroup_IsCfnElement(x interface{}) *bool
- func CfnGlobalReplicationGroup_IsCfnResource(x interface{}) *bool
- func CfnGlobalReplicationGroup_IsConstruct(x interface{}) *bool
- func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnParameterGroup_IsCfnResource(x interface{}) *bool
- func CfnParameterGroup_IsConstruct(x interface{}) *bool
- func CfnReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationGroup_IsCfnElement(x interface{}) *bool
- func CfnReplicationGroup_IsCfnResource(x interface{}) *bool
- func CfnReplicationGroup_IsConstruct(x interface{}) *bool
- func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroupIngress_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroupIngress_IsCfnResource(x interface{}) *bool
- func CfnSecurityGroupIngress_IsConstruct(x interface{}) *bool
- func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroup_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroup_IsCfnResource(x interface{}) *bool
- func CfnSecurityGroup_IsConstruct(x interface{}) *bool
- func CfnServerlessCache_CFN_RESOURCE_TYPE_NAME() *string
- func CfnServerlessCache_IsCfnElement(x interface{}) *bool
- func CfnServerlessCache_IsCfnResource(x interface{}) *bool
- func CfnServerlessCache_IsConstruct(x interface{}) *bool
- func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnSubnetGroup_IsCfnResource(x interface{}) *bool
- func CfnSubnetGroup_IsConstruct(x interface{}) *bool
- func CfnUserGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserGroup_IsCfnElement(x interface{}) *bool
- func CfnUserGroup_IsCfnResource(x interface{}) *bool
- func CfnUserGroup_IsConstruct(x interface{}) *bool
- func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUser_IsCfnElement(x interface{}) *bool
- func CfnUser_IsCfnResource(x interface{}) *bool
- func CfnUser_IsConstruct(x interface{}) *bool
- func NewCfnCacheCluster_Override(c CfnCacheCluster, scope constructs.Construct, id *string, ...)
- func NewCfnGlobalReplicationGroup_Override(c CfnGlobalReplicationGroup, scope constructs.Construct, id *string, ...)
- func NewCfnParameterGroup_Override(c CfnParameterGroup, scope constructs.Construct, id *string, ...)
- func NewCfnReplicationGroup_Override(c CfnReplicationGroup, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityGroupIngress_Override(c CfnSecurityGroupIngress, scope constructs.Construct, id *string, ...)
- func NewCfnSecurityGroup_Override(c CfnSecurityGroup, scope constructs.Construct, id *string, ...)
- func NewCfnServerlessCache_Override(c CfnServerlessCache, scope constructs.Construct, id *string, ...)
- func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope constructs.Construct, id *string, ...)
- func NewCfnUserGroup_Override(c CfnUserGroup, scope constructs.Construct, id *string, ...)
- func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
- type CfnCacheCluster
- type CfnCacheClusterProps
- type CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty
- type CfnCacheCluster_DestinationDetailsProperty
- type CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty
- type CfnCacheCluster_LogDeliveryConfigurationRequestProperty
- type CfnGlobalReplicationGroup
- type CfnGlobalReplicationGroupProps
- type CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty
- type CfnGlobalReplicationGroup_RegionalConfigurationProperty
- type CfnGlobalReplicationGroup_ReshardingConfigurationProperty
- type CfnParameterGroup
- type CfnParameterGroupProps
- type CfnReplicationGroup
- type CfnReplicationGroupProps
- type CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty
- type CfnReplicationGroup_DestinationDetailsProperty
- type CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty
- type CfnReplicationGroup_LogDeliveryConfigurationRequestProperty
- type CfnReplicationGroup_NodeGroupConfigurationProperty
- type CfnSecurityGroup
- type CfnSecurityGroupIngress
- type CfnSecurityGroupIngressProps
- type CfnSecurityGroupProps
- type CfnServerlessCache
- type CfnServerlessCacheProps
- type CfnServerlessCache_CacheUsageLimitsProperty
- type CfnServerlessCache_DataStorageProperty
- type CfnServerlessCache_ECPUPerSecondProperty
- type CfnServerlessCache_EndpointProperty
- type CfnSubnetGroup
- type CfnSubnetGroupProps
- type CfnUser
- type CfnUserGroup
- type CfnUserGroupProps
- type CfnUserProps
- type CfnUser_AuthenticationModeProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCacheCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCacheCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCacheCluster_IsCfnElement ¶
func CfnCacheCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCacheCluster_IsCfnResource ¶
func CfnCacheCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCacheCluster_IsConstruct ¶
func CfnCacheCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnGlobalReplicationGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnGlobalReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnGlobalReplicationGroup_IsCfnElement ¶
func CfnGlobalReplicationGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnGlobalReplicationGroup_IsCfnResource ¶
func CfnGlobalReplicationGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGlobalReplicationGroup_IsConstruct ¶
func CfnGlobalReplicationGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnParameterGroup_IsCfnElement ¶
func CfnParameterGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnParameterGroup_IsCfnResource ¶
func CfnParameterGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnParameterGroup_IsConstruct ¶
func CfnParameterGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnReplicationGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnReplicationGroup_IsCfnElement ¶
func CfnReplicationGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnReplicationGroup_IsCfnResource ¶
func CfnReplicationGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnReplicationGroup_IsConstruct ¶
func CfnReplicationGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityGroupIngress_IsCfnElement ¶
func CfnSecurityGroupIngress_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSecurityGroupIngress_IsCfnResource ¶
func CfnSecurityGroupIngress_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityGroupIngress_IsConstruct ¶
func CfnSecurityGroupIngress_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityGroup_IsCfnElement ¶
func CfnSecurityGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSecurityGroup_IsCfnResource ¶
func CfnSecurityGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityGroup_IsConstruct ¶
func CfnSecurityGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnServerlessCache_CFN_RESOURCE_TYPE_NAME ¶ added in v2.113.0
func CfnServerlessCache_CFN_RESOURCE_TYPE_NAME() *string
func CfnServerlessCache_IsCfnElement ¶ added in v2.113.0
func CfnServerlessCache_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnServerlessCache_IsCfnResource ¶ added in v2.113.0
func CfnServerlessCache_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnServerlessCache_IsConstruct ¶ added in v2.113.0
func CfnServerlessCache_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnetGroup_IsCfnElement ¶
func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubnetGroup_IsCfnResource ¶
func CfnSubnetGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnetGroup_IsConstruct ¶
func CfnSubnetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnUserGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnUserGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserGroup_IsCfnElement ¶
func CfnUserGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUserGroup_IsCfnResource ¶
func CfnUserGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserGroup_IsConstruct ¶
func CfnUserGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnUser_CFN_RESOURCE_TYPE_NAME ¶
func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
func CfnUser_IsCfnElement ¶
func CfnUser_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUser_IsCfnResource ¶
func CfnUser_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUser_IsConstruct ¶
func CfnUser_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCacheCluster_Override ¶
func NewCfnCacheCluster_Override(c CfnCacheCluster, scope constructs.Construct, id *string, props *CfnCacheClusterProps)
func NewCfnGlobalReplicationGroup_Override ¶
func NewCfnGlobalReplicationGroup_Override(c CfnGlobalReplicationGroup, scope constructs.Construct, id *string, props *CfnGlobalReplicationGroupProps)
func NewCfnParameterGroup_Override ¶
func NewCfnParameterGroup_Override(c CfnParameterGroup, scope constructs.Construct, id *string, props *CfnParameterGroupProps)
func NewCfnReplicationGroup_Override ¶
func NewCfnReplicationGroup_Override(c CfnReplicationGroup, scope constructs.Construct, id *string, props *CfnReplicationGroupProps)
func NewCfnSecurityGroupIngress_Override ¶
func NewCfnSecurityGroupIngress_Override(c CfnSecurityGroupIngress, scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps)
func NewCfnSecurityGroup_Override ¶
func NewCfnSecurityGroup_Override(c CfnSecurityGroup, scope constructs.Construct, id *string, props *CfnSecurityGroupProps)
func NewCfnServerlessCache_Override ¶ added in v2.113.0
func NewCfnServerlessCache_Override(c CfnServerlessCache, scope constructs.Construct, id *string, props *CfnServerlessCacheProps)
func NewCfnSubnetGroup_Override ¶
func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope constructs.Construct, id *string, props *CfnSubnetGroupProps)
func NewCfnUserGroup_Override ¶
func NewCfnUserGroup_Override(c CfnUserGroup, scope constructs.Construct, id *string, props *CfnUserGroupProps)
func NewCfnUser_Override ¶
func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
Types ¶
type CfnCacheCluster ¶
type CfnCacheCluster interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The DNS hostname of the cache node. // // > Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. AttrConfigurationEndpointAddress() *string // The port number of the configuration endpoint for the Memcached cache cluster. // // > Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. AttrConfigurationEndpointPort() *string // The resource name. AttrId() *string // The DNS address of the configuration endpoint for the Redis cache cluster. AttrRedisEndpointAddress() *string // The port number of the configuration endpoint for the Redis cache cluster. AttrRedisEndpointPort() *string // If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) // Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. AzMode() *string SetAzMode(val *string) // The compute and memory capacity of the nodes in the node group (shard). CacheNodeType() *string SetCacheNodeType(val *string) // The name of the parameter group to associate with this cluster. CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) // A list of security group names to associate with this cluster. CacheSecurityGroupNames() *[]*string SetCacheSecurityGroupNames(val *[]*string) // The name of the subnet group to be used for the cluster. CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A name for the cache cluster. ClusterName() *string SetClusterName(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the cache engine to be used for this cluster. Engine() *string SetEngine(val *string) // The version number of the cache engine to be used for this cluster. EngineVersion() *string SetEngineVersion(val *string) // The network type you choose when modifying a cluster, either `ipv4` | `ipv6` . IpDiscovery() *string SetIpDiscovery(val *string) // Specifies the destination, format and type of the logs. LogDeliveryConfigurations() interface{} SetLogDeliveryConfigurations(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // Must be either `ipv4` | `ipv6` | `dual_stack` . NetworkType() *string SetNetworkType(val *string) // The tree node. Node() constructs.Node // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. NotificationTopicArn() *string SetNotificationTopicArn(val *string) // The number of cache nodes that the cache cluster should have. NumCacheNodes() *float64 SetNumCacheNodes(val *float64) // The port number on which each of the cache nodes accepts connections. Port() *float64 SetPort(val *float64) // The EC2 Availability Zone in which the cluster is created. PreferredAvailabilityZone() *string SetPreferredAvailabilityZone(val *string) // A list of the Availability Zones in which cache nodes are created. PreferredAvailabilityZones() *[]*string SetPreferredAvailabilityZones(val *[]*string) // Specifies the weekly time range during which maintenance on the cluster is performed. PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. SnapshotArns() *[]*string SetSnapshotArns(val *[]*string) // The name of a Redis snapshot from which to restore data into the new node group (shard). SnapshotName() *string SetSnapshotName(val *string) // The number of days for which ElastiCache retains automatic snapshots before deleting them. SnapshotRetentionLimit() *float64 SetSnapshotRetentionLimit(val *float64) // The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). SnapshotWindow() *string SetSnapshotWindow(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of tags to be added to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // A flag that enables in-transit encryption when set to true. TransitEncryptionEnabled() interface{} SetTransitEncryptionEnabled(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // One or more VPC security groups associated with the cluster. VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ElastiCache::CacheCluster` type creates an Amazon ElastiCache cache cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCacheCluster := awscdk.Aws_elasticache.NewCfnCacheCluster(this, jsii.String("MyCfnCacheCluster"), &CfnCacheClusterProps{ CacheNodeType: jsii.String("cacheNodeType"), Engine: jsii.String("engine"), NumCacheNodes: jsii.Number(123), // the properties below are optional AutoMinorVersionUpgrade: jsii.Boolean(false), AzMode: jsii.String("azMode"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), CacheSecurityGroupNames: []*string{ jsii.String("cacheSecurityGroupNames"), }, CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), ClusterName: jsii.String("clusterName"), EngineVersion: jsii.String("engineVersion"), IpDiscovery: jsii.String("ipDiscovery"), LogDeliveryConfigurations: []interface{}{ &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }, }, NetworkType: jsii.String("networkType"), NotificationTopicArn: jsii.String("notificationTopicArn"), Port: jsii.Number(123), PreferredAvailabilityZone: jsii.String("preferredAvailabilityZone"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), SnapshotArns: []*string{ jsii.String("snapshotArns"), }, SnapshotName: jsii.String("snapshotName"), SnapshotRetentionLimit: jsii.Number(123), SnapshotWindow: jsii.String("snapshotWindow"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TransitEncryptionEnabled: jsii.Boolean(false), VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, })
func NewCfnCacheCluster ¶
func NewCfnCacheCluster(scope constructs.Construct, id *string, props *CfnCacheClusterProps) CfnCacheCluster
type CfnCacheClusterProps ¶
type CfnCacheClusterProps struct { // The compute and memory capacity of the nodes in the node group (shard). // // The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the `LogicalResourceId` of the resource. // // - General purpose: // // - Current generation: // // *M6g node types:* `cache.m6g.large` , `cache.m6g.xlarge` , `cache.m6g.2xlarge` , `cache.m6g.4xlarge` , `cache.m6g.8xlarge` , `cache.m6g.12xlarge` , `cache.m6g.16xlarge` , `cache.m6g.24xlarge` // // *M5 node types:* `cache.m5.large` , `cache.m5.xlarge` , `cache.m5.2xlarge` , `cache.m5.4xlarge` , `cache.m5.12xlarge` , `cache.m5.24xlarge` // // *M4 node types:* `cache.m4.large` , `cache.m4.xlarge` , `cache.m4.2xlarge` , `cache.m4.4xlarge` , `cache.m4.10xlarge` // // *T4g node types:* `cache.t4g.micro` , `cache.t4g.small` , `cache.t4g.medium` // // *T3 node types:* `cache.t3.micro` , `cache.t3.small` , `cache.t3.medium` // // *T2 node types:* `cache.t2.micro` , `cache.t2.small` , `cache.t2.medium` // - Previous generation: (not recommended) // // *T1 node types:* `cache.t1.micro` // // *M1 node types:* `cache.m1.small` , `cache.m1.medium` , `cache.m1.large` , `cache.m1.xlarge` // // *M3 node types:* `cache.m3.medium` , `cache.m3.large` , `cache.m3.xlarge` , `cache.m3.2xlarge` // - Compute optimized: // // - Previous generation: (not recommended) // // *C1 node types:* `cache.c1.xlarge` // - Memory optimized: // // - Current generation: // // *R6gd node types:* `cache.r6gd.xlarge` , `cache.r6gd.2xlarge` , `cache.r6gd.4xlarge` , `cache.r6gd.8xlarge` , `cache.r6gd.12xlarge` , `cache.r6gd.16xlarge` // // > The `r6gd` family is available in the following regions: `us-east-2` , `us-east-1` , `us-west-2` , `us-west-1` , `eu-west-1` , `eu-central-1` , `ap-northeast-1` , `ap-southeast-1` , `ap-southeast-2` . // // *R6g node types:* `cache.r6g.large` , `cache.r6g.xlarge` , `cache.r6g.2xlarge` , `cache.r6g.4xlarge` , `cache.r6g.8xlarge` , `cache.r6g.12xlarge` , `cache.r6g.16xlarge` , `cache.r6g.24xlarge` // // *R5 node types:* `cache.r5.large` , `cache.r5.xlarge` , `cache.r5.2xlarge` , `cache.r5.4xlarge` , `cache.r5.12xlarge` , `cache.r5.24xlarge` // // *R4 node types:* `cache.r4.large` , `cache.r4.xlarge` , `cache.r4.2xlarge` , `cache.r4.4xlarge` , `cache.r4.8xlarge` , `cache.r4.16xlarge` // - Previous generation: (not recommended) // // *M2 node types:* `cache.m2.xlarge` , `cache.m2.2xlarge` , `cache.m2.4xlarge` // // *R3 node types:* `cache.r3.large` , `cache.r3.xlarge` , `cache.r3.2xlarge` , `cache.r3.4xlarge` , `cache.r3.8xlarge` // // For region availability, see [Supported Node Types by Region](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) // // *Additional node type info* // // - All current generation instance types are created in Amazon VPC by default. // - Redis append-only files (AOF) are not supported for T1 or T2 instances. // - Redis Multi-AZ with automatic failover is not supported on T1 instances. // - Redis configuration variables `appendonly` and `appendfsync` are not supported on Redis version 2.8.22 and later. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachenodetype // CacheNodeType *string `field:"required" json:"cacheNodeType" yaml:"cacheNodeType"` // The name of the cache engine to be used for this cluster. // // Valid values for this parameter are: `memcached` | `redis`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engine // Engine *string `field:"required" json:"engine" yaml:"engine"` // The number of cache nodes that the cache cluster should have. // // > However, if the `PreferredAvailabilityZone` and `PreferredAvailabilityZones` properties were not previously specified and you don't specify any new values, an update requires [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-numcachenodes // NumCacheNodes *float64 `field:"required" json:"numCacheNodes" yaml:"numCacheNodes"` // If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-autominorversionupgrade // AutoMinorVersionUpgrade interface{} `field:"optional" json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"` // Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. // // This parameter is only supported for Memcached clusters. // // If the `AZMode` and `PreferredAvailabilityZones` are not specified, ElastiCache assumes `single-az` mode. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-azmode // AzMode *string `field:"optional" json:"azMode" yaml:"azMode"` // The name of the parameter group to associate with this cluster. // // If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has `cluster-enabled='yes'` when creating a cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cacheparametergroupname // CacheParameterGroupName *string `field:"optional" json:"cacheParameterGroupName" yaml:"cacheParameterGroupName"` // A list of security group names to associate with this cluster. // // Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesecuritygroupnames // CacheSecurityGroupNames *[]*string `field:"optional" json:"cacheSecurityGroupNames" yaml:"cacheSecurityGroupNames"` // The name of the subnet group to be used for the cluster. // // Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). // // > If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see `[AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html) .` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-cachesubnetgroupname // CacheSubnetGroupName *string `field:"optional" json:"cacheSubnetGroupName" yaml:"cacheSubnetGroupName"` // 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) . // // The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-clustername // ClusterName *string `field:"optional" json:"clusterName" yaml:"clusterName"` // The version number of the cache engine to be used for this cluster. // // To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. // // *Important:* You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-engineversion // EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"` // The network type you choose when modifying a cluster, either `ipv4` | `ipv6` . // // IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-ipdiscovery // IpDiscovery *string `field:"optional" json:"ipDiscovery" yaml:"ipDiscovery"` // Specifies the destination, format and type of the logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-logdeliveryconfigurations // LogDeliveryConfigurations interface{} `field:"optional" json:"logDeliveryConfigurations" yaml:"logDeliveryConfigurations"` // Must be either `ipv4` | `ipv6` | `dual_stack` . // // IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-networktype // NetworkType *string `field:"optional" json:"networkType" yaml:"networkType"` // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. // // > The Amazon SNS topic owner must be the same as the cluster owner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-notificationtopicarn // NotificationTopicArn *string `field:"optional" json:"notificationTopicArn" yaml:"notificationTopicArn"` // The port number on which each of the cache nodes accepts connections. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // The EC2 Availability Zone in which the cluster is created. // // All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use `PreferredAvailabilityZones` . // // Default: System chosen Availability Zone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzone // PreferredAvailabilityZone *string `field:"optional" json:"preferredAvailabilityZone" yaml:"preferredAvailabilityZone"` // A list of the Availability Zones in which cache nodes are created. // // The order of the zones in the list is not important. // // This option is only supported on Memcached. // // > If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. // > // > The number of Availability Zones listed must equal the value of `NumCacheNodes` . // // If you want all the nodes in the same Availability Zone, use `PreferredAvailabilityZone` instead, or repeat the Availability Zone multiple times in the list. // // Default: System chosen Availability Zones. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredavailabilityzones // PreferredAvailabilityZones *[]*string `field:"optional" json:"preferredAvailabilityZones" yaml:"preferredAvailabilityZones"` // Specifies the weekly time range during which maintenance on the cluster is performed. // // It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. // // Valid values for `ddd` are: // // - `sun` // - `mon` // - `tue` // - `wed` // - `thu` // - `fri` // - `sat` // // Example: `sun:23:00-mon:01:30`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-preferredmaintenancewindow // PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // 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 is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. // // > This parameter is only valid if the `Engine` parameter is `redis` . // // Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotarns // SnapshotArns *[]*string `field:"optional" json:"snapshotArns" yaml:"snapshotArns"` // The name of a Redis snapshot from which to restore data into the new node group (shard). // // The snapshot status changes to `restoring` while the new node group (shard) is being created. // // > This parameter is only valid if the `Engine` parameter is `redis` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotname // SnapshotName *string `field:"optional" json:"snapshotName" yaml:"snapshotName"` // The number of days for which ElastiCache retains automatic snapshots before deleting them. // // For example, if you set `SnapshotRetentionLimit` to 5, a snapshot taken today is retained for 5 days before being deleted. // // > This parameter is only valid if the `Engine` parameter is `redis` . // // Default: 0 (i.e., automatic backups are disabled for this cache cluster). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotretentionlimit // SnapshotRetentionLimit *float64 `field:"optional" json:"snapshotRetentionLimit" yaml:"snapshotRetentionLimit"` // The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). // // Example: `05:00-09:00` // // If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. // // > This parameter is only valid if the `Engine` parameter is `redis` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-snapshotwindow // SnapshotWindow *string `field:"optional" json:"snapshotWindow" yaml:"snapshotWindow"` // A list of tags to be added to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // A flag that enables in-transit encryption when set to true. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-transitencryptionenabled // TransitEncryptionEnabled interface{} `field:"optional" json:"transitEncryptionEnabled" yaml:"transitEncryptionEnabled"` // One or more VPC security groups associated with the cluster. // // Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-cachecluster.html#cfn-elasticache-cachecluster-vpcsecuritygroupids // VpcSecurityGroupIds *[]*string `field:"optional" json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Properties for defining a `CfnCacheCluster`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCacheClusterProps := &CfnCacheClusterProps{ CacheNodeType: jsii.String("cacheNodeType"), Engine: jsii.String("engine"), NumCacheNodes: jsii.Number(123), // the properties below are optional AutoMinorVersionUpgrade: jsii.Boolean(false), AzMode: jsii.String("azMode"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), CacheSecurityGroupNames: []*string{ jsii.String("cacheSecurityGroupNames"), }, CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), ClusterName: jsii.String("clusterName"), EngineVersion: jsii.String("engineVersion"), IpDiscovery: jsii.String("ipDiscovery"), LogDeliveryConfigurations: []interface{}{ &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }, }, NetworkType: jsii.String("networkType"), NotificationTopicArn: jsii.String("notificationTopicArn"), Port: jsii.Number(123), PreferredAvailabilityZone: jsii.String("preferredAvailabilityZone"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), SnapshotArns: []*string{ jsii.String("snapshotArns"), }, SnapshotName: jsii.String("snapshotName"), SnapshotRetentionLimit: jsii.Number(123), SnapshotWindow: jsii.String("snapshotWindow"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TransitEncryptionEnabled: jsii.Boolean(false), VpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }
type CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty ¶
type CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty struct { // The name of the CloudWatch Logs log group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-cloudwatchlogsdestinationdetails.html#cfn-elasticache-cachecluster-cloudwatchlogsdestinationdetails-loggroup // LogGroup *string `field:"required" json:"logGroup" yaml:"logGroup"` }
Configuration details of a CloudWatch Logs destination.
Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cloudWatchLogsDestinationDetailsProperty := &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }
type CfnCacheCluster_DestinationDetailsProperty ¶
type CfnCacheCluster_DestinationDetailsProperty struct { // The configuration details of the CloudWatch Logs destination. // // Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-cloudwatchlogsdetails // CloudWatchLogsDetails interface{} `field:"optional" json:"cloudWatchLogsDetails" yaml:"cloudWatchLogsDetails"` // The configuration details of the Kinesis Data Firehose destination. // // Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-destinationdetails.html#cfn-elasticache-cachecluster-destinationdetails-kinesisfirehosedetails // KinesisFirehoseDetails interface{} `field:"optional" json:"kinesisFirehoseDetails" yaml:"kinesisFirehoseDetails"` }
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" destinationDetailsProperty := &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }
type CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty ¶
type CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty struct { // The name of the Kinesis Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-kinesisfirehosedestinationdetails.html#cfn-elasticache-cachecluster-kinesisfirehosedestinationdetails-deliverystream // DeliveryStream *string `field:"required" json:"deliveryStream" yaml:"deliveryStream"` }
The configuration details of the Kinesis Data Firehose destination.
Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kinesisFirehoseDestinationDetailsProperty := &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }
type CfnCacheCluster_LogDeliveryConfigurationRequestProperty ¶
type CfnCacheCluster_LogDeliveryConfigurationRequestProperty struct { // Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationdetails // DestinationDetails interface{} `field:"required" json:"destinationDetails" yaml:"destinationDetails"` // Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. // // Valid values are either `cloudwatch-logs` or `kinesis-firehose` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-destinationtype // DestinationType *string `field:"required" json:"destinationType" yaml:"destinationType"` // Valid values are either `json` or `text` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logformat // LogFormat *string `field:"required" json:"logFormat" yaml:"logFormat"` // Valid value is either `slow-log` , which refers to [slow-log](https://docs.aws.amazon.com/https://redis.io/commands/slowlog) or `engine-log` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html#cfn-elasticache-cachecluster-logdeliveryconfigurationrequest-logtype // LogType *string `field:"required" json:"logType" yaml:"logType"` }
Specifies the destination, format and type of the logs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" logDeliveryConfigurationRequestProperty := &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }
type CfnGlobalReplicationGroup ¶
type CfnGlobalReplicationGroup interface { awscdk.CfnResource awscdk.IInspectable // The ID used to associate a secondary cluster to the Global Replication Group. AttrGlobalReplicationGroupId() *string // The status of the Global Datastore. // // Can be `Creating` , `Modifying` , `Available` , `Deleting` or `Primary-Only` . Primary-only status indicates the global datastore contains only a primary cluster. Either all secondary clusters are deleted or not successfully created. AttrStatus() *string // Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled() interface{} SetAutomaticFailoverEnabled(val interface{}) // The cache node type of the Global datastore. CacheNodeType() *string SetCacheNodeType(val *string) // The name of the cache parameter group to use with the Global datastore. CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Elasticache Redis engine version. EngineVersion() *string SetEngineVersion(val *string) // The number of node groups that comprise the Global Datastore. GlobalNodeGroupCount() *float64 SetGlobalNodeGroupCount(val *float64) // The optional description of the Global datastore. GlobalReplicationGroupDescription() *string SetGlobalReplicationGroupDescription(val *string) // The suffix name of a Global Datastore. GlobalReplicationGroupIdSuffix() *string SetGlobalReplicationGroupIdSuffix(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The replication groups that comprise the Global datastore. Members() interface{} SetMembers(val interface{}) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The Regions that comprise the Global Datastore. RegionalConfigurations() interface{} SetRegionalConfigurations(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
- The *GlobalReplicationGroupIdSuffix* represents the name of the Global datastore, which is what you use to associate a secondary cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGlobalReplicationGroup := awscdk.Aws_elasticache.NewCfnGlobalReplicationGroup(this, jsii.String("MyCfnGlobalReplicationGroup"), &CfnGlobalReplicationGroupProps{ Members: []interface{}{ &GlobalReplicationGroupMemberProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), Role: jsii.String("role"), }, }, // the properties below are optional AutomaticFailoverEnabled: jsii.Boolean(false), CacheNodeType: jsii.String("cacheNodeType"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), EngineVersion: jsii.String("engineVersion"), GlobalNodeGroupCount: jsii.Number(123), GlobalReplicationGroupDescription: jsii.String("globalReplicationGroupDescription"), GlobalReplicationGroupIdSuffix: jsii.String("globalReplicationGroupIdSuffix"), RegionalConfigurations: []interface{}{ &RegionalConfigurationProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), ReshardingConfigurations: []interface{}{ &ReshardingConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, }, }, }, }, })
func NewCfnGlobalReplicationGroup ¶
func NewCfnGlobalReplicationGroup(scope constructs.Construct, id *string, props *CfnGlobalReplicationGroupProps) CfnGlobalReplicationGroup
type CfnGlobalReplicationGroupProps ¶
type CfnGlobalReplicationGroupProps struct { // The replication groups that comprise the Global datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-members // Members interface{} `field:"required" json:"members" yaml:"members"` // Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. // // `AutomaticFailoverEnabled` must be enabled for Redis (cluster mode enabled) replication groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-automaticfailoverenabled // AutomaticFailoverEnabled interface{} `field:"optional" json:"automaticFailoverEnabled" yaml:"automaticFailoverEnabled"` // The cache node type of the Global datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cachenodetype // CacheNodeType *string `field:"optional" json:"cacheNodeType" yaml:"cacheNodeType"` // The name of the cache parameter group to use with the Global datastore. // // It must be compatible with the major engine version used by the Global datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-cacheparametergroupname // CacheParameterGroupName *string `field:"optional" json:"cacheParameterGroupName" yaml:"cacheParameterGroupName"` // The Elasticache Redis engine version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engineversion // EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"` // The number of node groups that comprise the Global Datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalnodegroupcount // GlobalNodeGroupCount *float64 `field:"optional" json:"globalNodeGroupCount" yaml:"globalNodeGroupCount"` // The optional description of the Global datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupdescription // GlobalReplicationGroupDescription *string `field:"optional" json:"globalReplicationGroupDescription" yaml:"globalReplicationGroupDescription"` // The suffix name of a Global Datastore. // // The suffix guarantees uniqueness of the Global Datastore name across multiple regions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupidsuffix // GlobalReplicationGroupIdSuffix *string `field:"optional" json:"globalReplicationGroupIdSuffix" yaml:"globalReplicationGroupIdSuffix"` // The Regions that comprise the Global Datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-regionalconfigurations // RegionalConfigurations interface{} `field:"optional" json:"regionalConfigurations" yaml:"regionalConfigurations"` }
Properties for defining a `CfnGlobalReplicationGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGlobalReplicationGroupProps := &CfnGlobalReplicationGroupProps{ Members: []interface{}{ &GlobalReplicationGroupMemberProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), Role: jsii.String("role"), }, }, // the properties below are optional AutomaticFailoverEnabled: jsii.Boolean(false), CacheNodeType: jsii.String("cacheNodeType"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), EngineVersion: jsii.String("engineVersion"), GlobalNodeGroupCount: jsii.Number(123), GlobalReplicationGroupDescription: jsii.String("globalReplicationGroupDescription"), GlobalReplicationGroupIdSuffix: jsii.String("globalReplicationGroupIdSuffix"), RegionalConfigurations: []interface{}{ &RegionalConfigurationProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), ReshardingConfigurations: []interface{}{ &ReshardingConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, }, }, }, }, }
type CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty ¶
type CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty struct { // The replication group id of the Global datastore member. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupid // ReplicationGroupId *string `field:"optional" json:"replicationGroupId" yaml:"replicationGroupId"` // The Amazon region of the Global datastore member. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-replicationgroupregion // ReplicationGroupRegion *string `field:"optional" json:"replicationGroupRegion" yaml:"replicationGroupRegion"` // Indicates the role of the replication group, `PRIMARY` or `SECONDARY` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html#cfn-elasticache-globalreplicationgroup-globalreplicationgroupmember-role // Role *string `field:"optional" json:"role" yaml:"role"` }
A member of a Global datastore.
It contains the Replication Group Id, the Amazon region and the role of the replication group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" globalReplicationGroupMemberProperty := &GlobalReplicationGroupMemberProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), Role: jsii.String("role"), }
type CfnGlobalReplicationGroup_RegionalConfigurationProperty ¶
type CfnGlobalReplicationGroup_RegionalConfigurationProperty struct { // The name of the secondary cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupid // ReplicationGroupId *string `field:"optional" json:"replicationGroupId" yaml:"replicationGroupId"` // The Amazon region where the cluster is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-replicationgroupregion // ReplicationGroupRegion *string `field:"optional" json:"replicationGroupRegion" yaml:"replicationGroupRegion"` // A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html#cfn-elasticache-globalreplicationgroup-regionalconfiguration-reshardingconfigurations // ReshardingConfigurations interface{} `field:"optional" json:"reshardingConfigurations" yaml:"reshardingConfigurations"` }
A list of the replication groups.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" regionalConfigurationProperty := &RegionalConfigurationProperty{ ReplicationGroupId: jsii.String("replicationGroupId"), ReplicationGroupRegion: jsii.String("replicationGroupRegion"), ReshardingConfigurations: []interface{}{ &ReshardingConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, }, }, }
type CfnGlobalReplicationGroup_ReshardingConfigurationProperty ¶
type CfnGlobalReplicationGroup_ReshardingConfigurationProperty struct { // Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-nodegroupid // NodeGroupId *string `field:"optional" json:"nodeGroupId" yaml:"nodeGroupId"` // A list of preferred availability zones for the nodes in this cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-reshardingconfiguration.html#cfn-elasticache-globalreplicationgroup-reshardingconfiguration-preferredavailabilityzones // PreferredAvailabilityZones *[]*string `field:"optional" json:"preferredAvailabilityZones" yaml:"preferredAvailabilityZones"` }
A list of `PreferredAvailabilityZones` objects that specifies the configuration of a node group in the resharded cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" reshardingConfigurationProperty := &ReshardingConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PreferredAvailabilityZones: []*string{ jsii.String("preferredAvailabilityZones"), }, }
type CfnParameterGroup ¶
type CfnParameterGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // The name of the cache parameter group family that this cache parameter group is compatible with. CacheParameterGroupFamily() *string SetCacheParameterGroupFamily(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description for this cache parameter group. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // A comma-delimited list of parameter name/value pairs. Properties() interface{} SetProperties(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A tag that can be added to an ElastiCache parameter group. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ElastiCache::ParameterGroup` type creates a new cache parameter group.
Cache parameter groups control the parameters for a cache cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnParameterGroup := awscdk.Aws_elasticache.NewCfnParameterGroup(this, jsii.String("MyCfnParameterGroup"), &CfnParameterGroupProps{ CacheParameterGroupFamily: jsii.String("cacheParameterGroupFamily"), Description: jsii.String("description"), // the properties below are optional Properties: map[string]*string{ "propertiesKey": jsii.String("properties"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnParameterGroup ¶
func NewCfnParameterGroup(scope constructs.Construct, id *string, props *CfnParameterGroupProps) CfnParameterGroup
type CfnParameterGroupProps ¶
type CfnParameterGroupProps struct { // The name of the cache parameter group family that this cache parameter group is compatible with. // // Valid values are: `memcached1.4` | `memcached1.5` | `memcached1.6` | `redis2.6` | `redis2.8` | `redis3.2` | `redis4.0` | `redis5.0` | `redis6.x` | `redis7` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-cacheparametergroupfamily // CacheParameterGroupFamily *string `field:"required" json:"cacheParameterGroupFamily" yaml:"cacheParameterGroupFamily"` // The description for this cache parameter group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-description // Description *string `field:"required" json:"description" yaml:"description"` // A comma-delimited list of parameter name/value pairs. // // For example: // // “` // "Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02" // } // “`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-properties // Properties interface{} `field:"optional" json:"properties" yaml:"properties"` // A tag that can be added to an ElastiCache parameter group. // // Tags are composed of a Key/Value pair. You can use tags to categorize and track all your parameter groups. A tag with a null Value is permitted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnParameterGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnParameterGroupProps := &CfnParameterGroupProps{ CacheParameterGroupFamily: jsii.String("cacheParameterGroupFamily"), Description: jsii.String("description"), // the properties below are optional Properties: map[string]*string{ "propertiesKey": jsii.String("properties"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnReplicationGroup ¶
type CfnReplicationGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A flag that enables encryption at rest when set to `true` . AtRestEncryptionEnabled() interface{} SetAtRestEncryptionEnabled(val interface{}) // The DNS hostname of the cache node. // // > Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. For Redis (cluster mode disabled) replication groups, use the `PrimaryEndpoint` or `ReadEndpoint` attributes. AttrConfigurationEndPointAddress() *string // The port number that the cache engine is listening on. AttrConfigurationEndPointPort() *string // The DNS address of the primary read-write cache node. AttrPrimaryEndPointAddress() *string // The number of the port that the primary read-write cache engine is listening on. AttrPrimaryEndPointPort() *string // A string with a list of endpoints for the primary and read-only replicas. // // The order of the addresses maps to the order of the ports from the `ReadEndPoint.Ports` attribute. AttrReadEndPointAddresses() *string // A string with a list of endpoints for the read-only replicas. // // The order of the addresses maps to the order of the ports from the `ReadEndPoint.Ports` attribute. AttrReadEndPointAddressesList() *[]*string // A string with a list of ports for the read-only replicas. // // The order of the ports maps to the order of the addresses from the `ReadEndPoint.Addresses` attribute. AttrReadEndPointPorts() *string // A string with a list of ports for the read-only replicas. // // The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute. AttrReadEndPointPortsList() *[]*string // The address of the reader endpoint. AttrReaderEndPointAddress() *string // The port used by the reader endpoint. AttrReaderEndPointPort() *string // *Reserved parameter.* The password used to access a password protected server. AuthToken() *string SetAuthToken(val *string) // Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled() interface{} SetAutomaticFailoverEnabled(val interface{}) // If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) // The compute and memory capacity of the nodes in the node group (shard). CacheNodeType() *string SetCacheNodeType(val *string) // The name of the parameter group to associate with this replication group. CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) // A list of cache security group names to associate with this replication group. CacheSecurityGroupNames() *[]*string SetCacheSecurityGroupNames(val *[]*string) // The name of the cache subnet group to be used for the replication group. CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Enabled or Disabled. ClusterMode() *string SetClusterMode(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Enables data tiering. DataTieringEnabled() interface{} SetDataTieringEnabled(val interface{}) // The name of the cache engine to be used for the clusters in this replication group. Engine() *string SetEngine(val *string) // The version number of the cache engine to be used for the clusters in this replication group. EngineVersion() *string SetEngineVersion(val *string) // The name of the Global datastore. GlobalReplicationGroupId() *string SetGlobalReplicationGroupId(val *string) // The network type you choose when creating a replication group, either `ipv4` | `ipv6` . IpDiscovery() *string SetIpDiscovery(val *string) // The ID of the KMS key used to encrypt the disk on the cluster. KmsKeyId() *string SetKmsKeyId(val *string) // Specifies the destination, format and type of the logs. LogDeliveryConfigurations() interface{} SetLogDeliveryConfigurations(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. MultiAzEnabled() interface{} SetMultiAzEnabled(val interface{}) // Must be either `ipv4` | `ipv6` | `dual_stack` . NetworkType() *string SetNetworkType(val *string) // The tree node. Node() constructs.Node // `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. NodeGroupConfiguration() interface{} SetNodeGroupConfiguration(val interface{}) // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. NotificationTopicArn() *string SetNotificationTopicArn(val *string) // The number of clusters this replication group initially has. NumCacheClusters() *float64 SetNumCacheClusters(val *float64) // An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. NumNodeGroups() *float64 SetNumNodeGroups(val *float64) // The port number on which each member of the replication group accepts connections. Port() *float64 SetPort(val *float64) // A list of EC2 Availability Zones in which the replication group's clusters are created. PreferredCacheClusterAZs() *[]*string SetPreferredCacheClusterAZs(val *[]*string) // Specifies the weekly time range during which maintenance on the cluster is performed. PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) // The identifier of the cluster that serves as the primary for this replication group. PrimaryClusterId() *string SetPrimaryClusterId(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // An optional parameter that specifies the number of replica nodes in each node group (shard). ReplicasPerNodeGroup() *float64 SetReplicasPerNodeGroup(val *float64) // A user-created description for the replication group. ReplicationGroupDescription() *string SetReplicationGroupDescription(val *string) ReplicationGroupId() *string SetReplicationGroupId(val *string) // One or more Amazon VPC security groups associated with this replication group. SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. SnapshotArns() *[]*string SetSnapshotArns(val *[]*string) // The name of a snapshot from which to restore data into the new replication group. SnapshotName() *string SetSnapshotName(val *string) // The number of days for which ElastiCache retains automatic snapshots before deleting them. SnapshotRetentionLimit() *float64 SetSnapshotRetentionLimit(val *float64) // The cluster ID that is used as the daily snapshot source for the replication group. SnapshottingClusterId() *string SetSnapshottingClusterId(val *string) // The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). SnapshotWindow() *string SetSnapshotWindow(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A list of tags to be added to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // A flag that enables in-transit encryption when set to `true` . TransitEncryptionEnabled() interface{} SetTransitEncryptionEnabled(val interface{}) // A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. TransitEncryptionMode() *string SetTransitEncryptionMode(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of user group to associate with the replication group. UserGroupIds() *[]*string SetUserGroupIds(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ElastiCache::ReplicationGroup` resource creates an Amazon ElastiCache Redis replication group.
A Redis (cluster mode disabled) replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas.
A Redis (cluster mode enabled) cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see [Creating a Subnet Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html) . For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see [Amazon Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) and choose the limit type *Nodes per cluster per instance type* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationGroup := awscdk.Aws_elasticache.NewCfnReplicationGroup(this, jsii.String("MyCfnReplicationGroup"), &CfnReplicationGroupProps{ ReplicationGroupDescription: jsii.String("replicationGroupDescription"), // the properties below are optional AtRestEncryptionEnabled: jsii.Boolean(false), AuthToken: jsii.String("authToken"), AutomaticFailoverEnabled: jsii.Boolean(false), AutoMinorVersionUpgrade: jsii.Boolean(false), CacheNodeType: jsii.String("cacheNodeType"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), CacheSecurityGroupNames: []*string{ jsii.String("cacheSecurityGroupNames"), }, CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), ClusterMode: jsii.String("clusterMode"), DataTieringEnabled: jsii.Boolean(false), Engine: jsii.String("engine"), EngineVersion: jsii.String("engineVersion"), GlobalReplicationGroupId: jsii.String("globalReplicationGroupId"), IpDiscovery: jsii.String("ipDiscovery"), KmsKeyId: jsii.String("kmsKeyId"), LogDeliveryConfigurations: []interface{}{ &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }, }, MultiAzEnabled: jsii.Boolean(false), NetworkType: jsii.String("networkType"), NodeGroupConfiguration: []interface{}{ &NodeGroupConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PrimaryAvailabilityZone: jsii.String("primaryAvailabilityZone"), ReplicaAvailabilityZones: []*string{ jsii.String("replicaAvailabilityZones"), }, ReplicaCount: jsii.Number(123), Slots: jsii.String("slots"), }, }, NotificationTopicArn: jsii.String("notificationTopicArn"), NumCacheClusters: jsii.Number(123), NumNodeGroups: jsii.Number(123), Port: jsii.Number(123), PreferredCacheClusterAZs: []*string{ jsii.String("preferredCacheClusterAZs"), }, PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), PrimaryClusterId: jsii.String("primaryClusterId"), ReplicasPerNodeGroup: jsii.Number(123), ReplicationGroupId: jsii.String("replicationGroupId"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SnapshotArns: []*string{ jsii.String("snapshotArns"), }, SnapshotName: jsii.String("snapshotName"), SnapshotRetentionLimit: jsii.Number(123), SnapshottingClusterId: jsii.String("snapshottingClusterId"), SnapshotWindow: jsii.String("snapshotWindow"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TransitEncryptionEnabled: jsii.Boolean(false), TransitEncryptionMode: jsii.String("transitEncryptionMode"), UserGroupIds: []*string{ jsii.String("userGroupIds"), }, })
func NewCfnReplicationGroup ¶
func NewCfnReplicationGroup(scope constructs.Construct, id *string, props *CfnReplicationGroupProps) CfnReplicationGroup
type CfnReplicationGroupProps ¶
type CfnReplicationGroupProps struct { // A user-created description for the replication group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription // ReplicationGroupDescription *string `field:"required" json:"replicationGroupDescription" yaml:"replicationGroupDescription"` // A flag that enables encryption at rest when set to `true` . // // You cannot modify the value of `AtRestEncryptionEnabled` after the replication group is created. To enable encryption at rest on a replication group you must set `AtRestEncryptionEnabled` to `true` when you create the replication group. // // *Required:* Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward. // // Default: `false`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled // AtRestEncryptionEnabled interface{} `field:"optional" json:"atRestEncryptionEnabled" yaml:"atRestEncryptionEnabled"` // *Reserved parameter.* The password used to access a password protected server. // // `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true` . For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html) . // // > For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true` , an `AuthToken` , and a `CacheSubnetGroup` . // // Password constraints: // // - Must be only printable ASCII characters. // - Must be at least 16 characters and no more than 128 characters in length. // - Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ). // // For more information, see [AUTH password](https://docs.aws.amazon.com/http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH. // // > If ADDING the AuthToken, update requires [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken // AuthToken *string `field:"optional" json:"authToken" yaml:"authToken"` // Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. // // `AutomaticFailoverEnabled` must be enabled for Redis (cluster mode enabled) replication groups. // // Default: false. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled // AutomaticFailoverEnabled interface{} `field:"optional" json:"automaticFailoverEnabled" yaml:"automaticFailoverEnabled"` // If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-autominorversionupgrade // AutoMinorVersionUpgrade interface{} `field:"optional" json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"` // The compute and memory capacity of the nodes in the node group (shard). // // The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. // // - General purpose: // // - Current generation: // // *M6g node types:* `cache.m6g.large` , `cache.m6g.xlarge` , `cache.m6g.2xlarge` , `cache.m6g.4xlarge` , `cache.m6g.12xlarge` , `cache.m6g.24xlarge` // // *M5 node types:* `cache.m5.large` , `cache.m5.xlarge` , `cache.m5.2xlarge` , `cache.m5.4xlarge` , `cache.m5.12xlarge` , `cache.m5.24xlarge` // // *M4 node types:* `cache.m4.large` , `cache.m4.xlarge` , `cache.m4.2xlarge` , `cache.m4.4xlarge` , `cache.m4.10xlarge` // // *T4g node types:* `cache.t4g.micro` , `cache.t4g.small` , `cache.t4g.medium` // // *T3 node types:* `cache.t3.micro` , `cache.t3.small` , `cache.t3.medium` // // *T2 node types:* `cache.t2.micro` , `cache.t2.small` , `cache.t2.medium` // - Previous generation: (not recommended) // // *T1 node types:* `cache.t1.micro` // // *M1 node types:* `cache.m1.small` , `cache.m1.medium` , `cache.m1.large` , `cache.m1.xlarge` // // *M3 node types:* `cache.m3.medium` , `cache.m3.large` , `cache.m3.xlarge` , `cache.m3.2xlarge` // - Compute optimized: // // - Previous generation: (not recommended) // // *C1 node types:* `cache.c1.xlarge` // - Memory optimized: // // - Current generation: // // *R6gd node types:* `cache.r6gd.xlarge` , `cache.r6gd.2xlarge` , `cache.r6gd.4xlarge` , `cache.r6gd.8xlarge` , `cache.r6gd.12xlarge` , `cache.r6gd.16xlarge` // // > The `r6gd` family is available in the following regions: `us-east-2` , `us-east-1` , `us-west-2` , `us-west-1` , `eu-west-1` , `eu-central-1` , `ap-northeast-1` , `ap-southeast-1` , `ap-southeast-2` . // // *R6g node types:* `cache.r6g.large` , `cache.r6g.xlarge` , `cache.r6g.2xlarge` , `cache.r6g.4xlarge` , `cache.r6g.12xlarge` , `cache.r6g.24xlarge` // // *R5 node types:* `cache.r5.large` , `cache.r5.xlarge` , `cache.r5.2xlarge` , `cache.r5.4xlarge` , `cache.r5.12xlarge` , `cache.r5.24xlarge` // // *R4 node types:* `cache.r4.large` , `cache.r4.xlarge` , `cache.r4.2xlarge` , `cache.r4.4xlarge` , `cache.r4.8xlarge` , `cache.r4.16xlarge` // - Previous generation: (not recommended) // // *M2 node types:* `cache.m2.xlarge` , `cache.m2.2xlarge` , `cache.m2.4xlarge` // // *R3 node types:* `cache.r3.large` , `cache.r3.xlarge` , `cache.r3.2xlarge` , `cache.r3.4xlarge` , `cache.r3.8xlarge` // // For region availability, see [Supported Node Types by Amazon Region](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype // CacheNodeType *string `field:"optional" json:"cacheNodeType" yaml:"cacheNodeType"` // The name of the parameter group to associate with this replication group. // // If this argument is omitted, the default cache parameter group for the specified engine is used. // // If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. // // - To create a Redis (cluster mode disabled) replication group, use `CacheParameterGroupName=default.redis3.2` . // - To create a Redis (cluster mode enabled) replication group, use `CacheParameterGroupName=default.redis3.2.cluster.on` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname // CacheParameterGroupName *string `field:"optional" json:"cacheParameterGroupName" yaml:"cacheParameterGroupName"` // A list of cache security group names to associate with this replication group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames // CacheSecurityGroupNames *[]*string `field:"optional" json:"cacheSecurityGroupNames" yaml:"cacheSecurityGroupNames"` // The name of the cache subnet group to be used for the replication group. // // > If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname // CacheSubnetGroupName *string `field:"optional" json:"cacheSubnetGroupName" yaml:"cacheSubnetGroupName"` // Enabled or Disabled. // // To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see [Modify cluster mode](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/modify-cluster-mode.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-clustermode // ClusterMode *string `field:"optional" json:"clusterMode" yaml:"clusterMode"` // Enables data tiering. // // Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-datatieringenabled // DataTieringEnabled interface{} `field:"optional" json:"dataTieringEnabled" yaml:"dataTieringEnabled"` // The name of the cache engine to be used for the clusters in this replication group. // // The value must be set to `Redis` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine // Engine *string `field:"optional" json:"engine" yaml:"engine"` // The version number of the cache engine to be used for the clusters in this replication group. // // To view the supported cache engine versions, use the `DescribeCacheEngineVersions` operation. // // *Important:* You can upgrade to a newer engine version (see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement) ) in the *ElastiCache User Guide* , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engineversion // EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"` // The name of the Global datastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-globalreplicationgroupid // GlobalReplicationGroupId *string `field:"optional" json:"globalReplicationGroupId" yaml:"globalReplicationGroupId"` // The network type you choose when creating a replication group, either `ipv4` | `ipv6` . // // IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-ipdiscovery // IpDiscovery *string `field:"optional" json:"ipDiscovery" yaml:"ipDiscovery"` // The ID of the KMS key used to encrypt the disk on the cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies the destination, format and type of the logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-logdeliveryconfigurations // LogDeliveryConfigurations interface{} `field:"optional" json:"logDeliveryConfigurations" yaml:"logDeliveryConfigurations"` // A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. // // For more information, see [Minimizing Downtime: Multi-AZ](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-multiazenabled // MultiAzEnabled interface{} `field:"optional" json:"multiAzEnabled" yaml:"multiAzEnabled"` // Must be either `ipv4` | `ipv6` | `dual_stack` . // // IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the [Nitro system](https://docs.aws.amazon.com/ec2/nitro/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-networktype // NetworkType *string `field:"optional" json:"networkType" yaml:"networkType"` // `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. // // If you set [UseOnlineResharding](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding) to `true` , you can update `NodeGroupConfiguration` without interruption. When `UseOnlineResharding` is set to `false` , or is not specified, updating `NodeGroupConfiguration` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration // NodeGroupConfiguration interface{} `field:"optional" json:"nodeGroupConfiguration" yaml:"nodeGroupConfiguration"` // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. // // > The Amazon SNS topic owner must be the same as the cluster owner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn // NotificationTopicArn *string `field:"optional" json:"notificationTopicArn" yaml:"notificationTopicArn"` // The number of clusters this replication group initially has. // // This parameter is not used if there is more than one node group (shard). You should use `ReplicasPerNodeGroup` instead. // // If `AutomaticFailoverEnabled` is `true` , the value of this parameter must be at least 2. If `AutomaticFailoverEnabled` is `false` you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6. // // The maximum permitted value for `NumCacheClusters` is 6 (1 primary plus 5 replicas). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters // NumCacheClusters *float64 `field:"optional" json:"numCacheClusters" yaml:"numCacheClusters"` // An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. // // For Redis (cluster mode disabled) either omit this parameter or set it to 1. // // If you set [UseOnlineResharding](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding) to `true` , you can update `NumNodeGroups` without interruption. When `UseOnlineResharding` is set to `false` , or is not specified, updating `NumNodeGroups` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) . // // Default: 1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups // NumNodeGroups *float64 `field:"optional" json:"numNodeGroups" yaml:"numNodeGroups"` // The port number on which each member of the replication group accepts connections. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // A list of EC2 Availability Zones in which the replication group's clusters are created. // // The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. // // This parameter is not used if there is more than one node group (shard). You should use `NodeGroupConfiguration` instead. // // > If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. // > // > The number of Availability Zones listed must equal the value of `NumCacheClusters` . // // Default: system chosen Availability Zones. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs // PreferredCacheClusterAZs *[]*string `field:"optional" json:"preferredCacheClusterAZs" yaml:"preferredCacheClusterAZs"` // Specifies the weekly time range during which maintenance on the cluster is performed. // // It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. // // Valid values for `ddd` are: // // - `sun` // - `mon` // - `tue` // - `wed` // - `thu` // - `fri` // - `sat` // // Example: `sun:23:00-mon:01:30`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow // PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // The identifier of the cluster that serves as the primary for this replication group. // // This cluster must already exist and have a status of `available` . // // This parameter is not required if `NumCacheClusters` , `NumNodeGroups` , or `ReplicasPerNodeGroup` is specified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid // PrimaryClusterId *string `field:"optional" json:"primaryClusterId" yaml:"primaryClusterId"` // An optional parameter that specifies the number of replica nodes in each node group (shard). // // Valid values are 0 to 5. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup // ReplicasPerNodeGroup *float64 `field:"optional" json:"replicasPerNodeGroup" yaml:"replicasPerNodeGroup"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid // ReplicationGroupId *string `field:"optional" json:"replicationGroupId" yaml:"replicationGroupId"` // One or more Amazon VPC security groups associated with this replication group. // // Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` // A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. // // The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter *NumNodeGroups* or the number of node groups configured by *NodeGroupConfiguration* regardless of the number of ARNs specified here. // // Example of an Amazon S3 ARN: `arn:aws:s3:::my_bucket/snapshot1.rdb` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotarns // SnapshotArns *[]*string `field:"optional" json:"snapshotArns" yaml:"snapshotArns"` // The name of a snapshot from which to restore data into the new replication group. // // The snapshot status changes to `restoring` while the new replication group is being created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotname // SnapshotName *string `field:"optional" json:"snapshotName" yaml:"snapshotName"` // The number of days for which ElastiCache retains automatic snapshots before deleting them. // // For example, if you set `SnapshotRetentionLimit` to 5, a snapshot that was taken today is retained for 5 days before being deleted. // // Default: 0 (i.e., automatic backups are disabled for this cluster). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotretentionlimit // SnapshotRetentionLimit *float64 `field:"optional" json:"snapshotRetentionLimit" yaml:"snapshotRetentionLimit"` // The cluster ID that is used as the daily snapshot source for the replication group. // // This parameter cannot be set for Redis (cluster mode enabled) replication groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid // SnapshottingClusterId *string `field:"optional" json:"snapshottingClusterId" yaml:"snapshottingClusterId"` // The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). // // Example: `05:00-09:00` // // If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotwindow // SnapshotWindow *string `field:"optional" json:"snapshotWindow" yaml:"snapshotWindow"` // A list of tags to be added to this resource. // // Tags are comma-separated key,value pairs (e.g. Key= `myKey` , Value= `myKeyValue` . You can include multiple tags as shown following: Key= `myKey` , Value= `myKeyValue` Key= `mySecondKey` , Value= `mySecondKeyValue` . Tags on replication groups will be replicated to all nodes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // A flag that enables in-transit encryption when set to `true` . // // You cannot modify the value of `TransitEncryptionEnabled` after the cluster is created. To enable in-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster. // // This parameter is valid only if the `Engine` parameter is `redis` , the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC. // // If you enable in-transit encryption, you must also specify a value for `CacheSubnetGroup` . // // *Required:* Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward. // // Default: `false` // // > For HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true` , an `AuthToken` , and a `CacheSubnetGroup` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled // TransitEncryptionEnabled interface{} `field:"optional" json:"transitEncryptionEnabled" yaml:"transitEncryptionEnabled"` // A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. // // When setting `TransitEncryptionEnabled` to `true` , you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only. // // Setting `TransitEncryptionMode` to `required` is a two-step process that requires you to first set the `TransitEncryptionMode` to `preferred` , after that you can set `TransitEncryptionMode` to `required` . // // This process will not trigger the replacement of the replication group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionmode // TransitEncryptionMode *string `field:"optional" json:"transitEncryptionMode" yaml:"transitEncryptionMode"` // The ID of user group to associate with the replication group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-usergroupids // UserGroupIds *[]*string `field:"optional" json:"userGroupIds" yaml:"userGroupIds"` }
Properties for defining a `CfnReplicationGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnReplicationGroupProps := &CfnReplicationGroupProps{ ReplicationGroupDescription: jsii.String("replicationGroupDescription"), // the properties below are optional AtRestEncryptionEnabled: jsii.Boolean(false), AuthToken: jsii.String("authToken"), AutomaticFailoverEnabled: jsii.Boolean(false), AutoMinorVersionUpgrade: jsii.Boolean(false), CacheNodeType: jsii.String("cacheNodeType"), CacheParameterGroupName: jsii.String("cacheParameterGroupName"), CacheSecurityGroupNames: []*string{ jsii.String("cacheSecurityGroupNames"), }, CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), ClusterMode: jsii.String("clusterMode"), DataTieringEnabled: jsii.Boolean(false), Engine: jsii.String("engine"), EngineVersion: jsii.String("engineVersion"), GlobalReplicationGroupId: jsii.String("globalReplicationGroupId"), IpDiscovery: jsii.String("ipDiscovery"), KmsKeyId: jsii.String("kmsKeyId"), LogDeliveryConfigurations: []interface{}{ &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }, }, MultiAzEnabled: jsii.Boolean(false), NetworkType: jsii.String("networkType"), NodeGroupConfiguration: []interface{}{ &NodeGroupConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PrimaryAvailabilityZone: jsii.String("primaryAvailabilityZone"), ReplicaAvailabilityZones: []*string{ jsii.String("replicaAvailabilityZones"), }, ReplicaCount: jsii.Number(123), Slots: jsii.String("slots"), }, }, NotificationTopicArn: jsii.String("notificationTopicArn"), NumCacheClusters: jsii.Number(123), NumNodeGroups: jsii.Number(123), Port: jsii.Number(123), PreferredCacheClusterAZs: []*string{ jsii.String("preferredCacheClusterAZs"), }, PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), PrimaryClusterId: jsii.String("primaryClusterId"), ReplicasPerNodeGroup: jsii.Number(123), ReplicationGroupId: jsii.String("replicationGroupId"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SnapshotArns: []*string{ jsii.String("snapshotArns"), }, SnapshotName: jsii.String("snapshotName"), SnapshotRetentionLimit: jsii.Number(123), SnapshottingClusterId: jsii.String("snapshottingClusterId"), SnapshotWindow: jsii.String("snapshotWindow"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, TransitEncryptionEnabled: jsii.Boolean(false), TransitEncryptionMode: jsii.String("transitEncryptionMode"), UserGroupIds: []*string{ jsii.String("userGroupIds"), }, }
type CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty ¶
type CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty struct { // The name of the CloudWatch Logs log group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-cloudwatchlogsdestinationdetails.html#cfn-elasticache-replicationgroup-cloudwatchlogsdestinationdetails-loggroup // LogGroup *string `field:"required" json:"logGroup" yaml:"logGroup"` }
The configuration details of the CloudWatch Logs destination.
Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cloudWatchLogsDestinationDetailsProperty := &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }
type CfnReplicationGroup_DestinationDetailsProperty ¶
type CfnReplicationGroup_DestinationDetailsProperty struct { // The configuration details of the CloudWatch Logs destination. // // Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-destinationdetails.html#cfn-elasticache-replicationgroup-destinationdetails-cloudwatchlogsdetails // CloudWatchLogsDetails interface{} `field:"optional" json:"cloudWatchLogsDetails" yaml:"cloudWatchLogsDetails"` // The configuration details of the Kinesis Data Firehose destination. // // Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-destinationdetails.html#cfn-elasticache-replicationgroup-destinationdetails-kinesisfirehosedetails // KinesisFirehoseDetails interface{} `field:"optional" json:"kinesisFirehoseDetails" yaml:"kinesisFirehoseDetails"` }
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" destinationDetailsProperty := &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }
type CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty ¶
type CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty struct { // The name of the Kinesis Data Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-kinesisfirehosedestinationdetails.html#cfn-elasticache-replicationgroup-kinesisfirehosedestinationdetails-deliverystream // DeliveryStream *string `field:"required" json:"deliveryStream" yaml:"deliveryStream"` }
The configuration details of the Kinesis Data Firehose destination.
Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" kinesisFirehoseDestinationDetailsProperty := &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }
type CfnReplicationGroup_LogDeliveryConfigurationRequestProperty ¶
type CfnReplicationGroup_LogDeliveryConfigurationRequestProperty struct { // Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-destinationdetails // DestinationDetails interface{} `field:"required" json:"destinationDetails" yaml:"destinationDetails"` // Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. // // Valid values are either `cloudwatch-logs` or `kinesis-firehose` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-destinationtype // DestinationType *string `field:"required" json:"destinationType" yaml:"destinationType"` // Valid values are either `json` or `text` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-logformat // LogFormat *string `field:"required" json:"logFormat" yaml:"logFormat"` // Valid value is either `slow-log` , which refers to [slow-log](https://docs.aws.amazon.com/https://redis.io/commands/slowlog) or `engine-log` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html#cfn-elasticache-replicationgroup-logdeliveryconfigurationrequest-logtype // LogType *string `field:"required" json:"logType" yaml:"logType"` }
Specifies the destination, format and type of the logs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" logDeliveryConfigurationRequestProperty := &LogDeliveryConfigurationRequestProperty{ DestinationDetails: &DestinationDetailsProperty{ CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{ LogGroup: jsii.String("logGroup"), }, KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{ DeliveryStream: jsii.String("deliveryStream"), }, }, DestinationType: jsii.String("destinationType"), LogFormat: jsii.String("logFormat"), LogType: jsii.String("logType"), }
type CfnReplicationGroup_NodeGroupConfigurationProperty ¶
type CfnReplicationGroup_NodeGroupConfigurationProperty struct { // Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-nodegroupid // NodeGroupId *string `field:"optional" json:"nodeGroupId" yaml:"nodeGroupId"` // The Availability Zone where the primary node of this node group (shard) is launched. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-primaryavailabilityzone // PrimaryAvailabilityZone *string `field:"optional" json:"primaryAvailabilityZone" yaml:"primaryAvailabilityZone"` // A list of Availability Zones to be used for the read replicas. // // The number of Availability Zones in this list must match the value of `ReplicaCount` or `ReplicasPerNodeGroup` if not specified. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicaavailabilityzones // ReplicaAvailabilityZones *[]*string `field:"optional" json:"replicaAvailabilityZones" yaml:"replicaAvailabilityZones"` // The number of read replica nodes in this node group (shard). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-replicacount // ReplicaCount *float64 `field:"optional" json:"replicaCount" yaml:"replicaCount"` // A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. // // The following example specifies three slots (numbered 0, 1, and 2): `0,1,2,0-4999,5000-9999,10000-16,383` . // // If you don't specify a value, ElastiCache allocates keys equally among each slot. // // When you use an `UseOnlineResharding` update policy to update the number of node groups without interruption, ElastiCache evenly distributes the keyspaces between the specified number of slots. This cannot be updated later. Therefore, after updating the number of node groups in this way, you should remove the value specified for the `Slots` property of each `NodeGroupConfiguration` from the stack template, as it no longer reflects the actual values in each node group. For more information, see [UseOnlineResharding Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html#cfn-elasticache-replicationgroup-nodegroupconfiguration-slots // Slots *string `field:"optional" json:"slots" yaml:"slots"` }
`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" nodeGroupConfigurationProperty := &NodeGroupConfigurationProperty{ NodeGroupId: jsii.String("nodeGroupId"), PrimaryAvailabilityZone: jsii.String("primaryAvailabilityZone"), ReplicaAvailabilityZones: []*string{ jsii.String("replicaAvailabilityZones"), }, ReplicaCount: jsii.Number(123), Slots: jsii.String("slots"), }
type CfnSecurityGroup ¶
type CfnSecurityGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description for the cache security group. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A tag that can be added to an ElastiCache security group. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The `AWS::ElastiCache::SecurityGroup` resource creates a cache security group.
For more information about cache security groups, go to [CacheSecurityGroups](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/VPCs.html) in the *Amazon ElastiCache User Guide* or go to [CreateCacheSecurityGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSecurityGroup.html) in the *Amazon ElastiCache API Reference Guide* .
For more information, see [CreateCacheSubnetGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSecurityGroup := awscdk.Aws_elasticache.NewCfnSecurityGroup(this, jsii.String("MyCfnSecurityGroup"), &CfnSecurityGroupProps{ Description: jsii.String("description"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnSecurityGroup ¶
func NewCfnSecurityGroup(scope constructs.Construct, id *string, props *CfnSecurityGroupProps) CfnSecurityGroup
type CfnSecurityGroupIngress ¶
type CfnSecurityGroupIngress interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The name of the Cache Security Group to authorize. CacheSecurityGroupName() *string SetCacheSecurityGroupName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Name of the EC2 Security Group to include in the authorization. Ec2SecurityGroupName() *string SetEc2SecurityGroupName(val *string) // Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property. Ec2SecurityGroupOwnerId() *string SetEc2SecurityGroupOwnerId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The AWS::ElastiCache::SecurityGroupIngress type authorizes ingress to a cache security group from hosts in specified Amazon EC2 security groups.
For more information about ElastiCache security group ingress, go to [AuthorizeCacheSecurityGroupIngress](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_AuthorizeCacheSecurityGroupIngress.html) in the *Amazon ElastiCache API Reference Guide* .
> Updates are not supported.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSecurityGroupIngress := awscdk.Aws_elasticache.NewCfnSecurityGroupIngress(this, jsii.String("MyCfnSecurityGroupIngress"), &CfnSecurityGroupIngressProps{ CacheSecurityGroupName: jsii.String("cacheSecurityGroupName"), Ec2SecurityGroupName: jsii.String("ec2SecurityGroupName"), // the properties below are optional Ec2SecurityGroupOwnerId: jsii.String("ec2SecurityGroupOwnerId"), })
func NewCfnSecurityGroupIngress ¶
func NewCfnSecurityGroupIngress(scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps) CfnSecurityGroupIngress
type CfnSecurityGroupIngressProps ¶
type CfnSecurityGroupIngressProps struct { // The name of the Cache Security Group to authorize. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroupingress.html#cfn-elasticache-securitygroupingress-cachesecuritygroupname // CacheSecurityGroupName *string `field:"required" json:"cacheSecurityGroupName" yaml:"cacheSecurityGroupName"` // Name of the EC2 Security Group to include in the authorization. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroupingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupname // Ec2SecurityGroupName *string `field:"required" json:"ec2SecurityGroupName" yaml:"ec2SecurityGroupName"` // Specifies the Amazon Account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName property. // // The Amazon access key ID is not an acceptable value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroupingress.html#cfn-elasticache-securitygroupingress-ec2securitygroupownerid // Ec2SecurityGroupOwnerId *string `field:"optional" json:"ec2SecurityGroupOwnerId" yaml:"ec2SecurityGroupOwnerId"` }
Properties for defining a `CfnSecurityGroupIngress`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSecurityGroupIngressProps := &CfnSecurityGroupIngressProps{ CacheSecurityGroupName: jsii.String("cacheSecurityGroupName"), Ec2SecurityGroupName: jsii.String("ec2SecurityGroupName"), // the properties below are optional Ec2SecurityGroupOwnerId: jsii.String("ec2SecurityGroupOwnerId"), }
type CfnSecurityGroupProps ¶
type CfnSecurityGroupProps struct { // A description for the cache security group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroup.html#cfn-elasticache-securitygroup-description // Description *string `field:"required" json:"description" yaml:"description"` // A tag that can be added to an ElastiCache security group. // // Tags are composed of a Key/Value pair. You can use tags to categorize and track all your security groups. A tag with a null Value is permitted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-securitygroup.html#cfn-elasticache-securitygroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSecurityGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSecurityGroupProps := &CfnSecurityGroupProps{ Description: jsii.String("description"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnServerlessCache ¶ added in v2.113.0
type CfnServerlessCache interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the serverless cache. AttrArn() *string // When the serverless cache was created. AttrCreateTime() *string // The DNS hostname of the cache node. AttrEndpointAddress() *string // The port number that the cache engine is listening on. AttrEndpointPort() *string // The name and version number of the engine the serverless cache is compatible with. AttrFullEngineVersion() *string // The DNS hostname of the cache node. AttrReaderEndpointAddress() *string // The port number that the cache engine is listening on. AttrReaderEndpointPort() *string // The current status of the serverless cache. // // The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING. AttrStatus() *string // The cache usage limit for the serverless cache. CacheUsageLimits() interface{} SetCacheUsageLimits(val interface{}) // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The daily time that a cache snapshot will be created. DailySnapshotTime() *string SetDailySnapshotTime(val *string) // A description of the serverless cache. Description() *string SetDescription(val *string) // Represents the information required for client programs to connect to a cache node. Endpoint() interface{} SetEndpoint(val interface{}) // The engine the serverless cache is compatible with. Engine() *string SetEngine(val *string) // The name of the final snapshot taken of a cache before the cache is deleted. FinalSnapshotName() *string SetFinalSnapshotName(val *string) // The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache. KmsKeyId() *string SetKmsKeyId(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The version number of the engine the serverless cache is compatible with. MajorEngineVersion() *string SetMajorEngineVersion(val *string) // The tree node. Node() constructs.Node // Represents the information required for client programs to connect to a cache node. ReaderEndpoint() interface{} SetReaderEndpoint(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The IDs of the EC2 security groups associated with the serverless cache. SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // The unique identifier of the serverless cache. ServerlessCacheName() *string SetServerlessCacheName(val *string) // The ARN of the snapshot from which to restore data into the new cache. SnapshotArnsToRestore() *[]*string SetSnapshotArnsToRestore(val *[]*string) // The current setting for the number of serverless cache snapshots the system will retain. SnapshotRetentionLimit() *float64 SetSnapshotRetentionLimit(val *float64) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // A list of tags to be added to this resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The identifier of the user group associated with the serverless cache. UserGroupId() *string SetUserGroupId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The resource representing a serverless cache.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnServerlessCache := awscdk.Aws_elasticache.NewCfnServerlessCache(this, jsii.String("MyCfnServerlessCache"), &CfnServerlessCacheProps{ Engine: jsii.String("engine"), ServerlessCacheName: jsii.String("serverlessCacheName"), // the properties below are optional CacheUsageLimits: &CacheUsageLimitsProperty{ DataStorage: &DataStorageProperty{ Unit: jsii.String("unit"), // the properties below are optional Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, EcpuPerSecond: &ECPUPerSecondProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, DailySnapshotTime: jsii.String("dailySnapshotTime"), Description: jsii.String("description"), Endpoint: &EndpointProperty{ Address: jsii.String("address"), Port: jsii.String("port"), }, FinalSnapshotName: jsii.String("finalSnapshotName"), KmsKeyId: jsii.String("kmsKeyId"), MajorEngineVersion: jsii.String("majorEngineVersion"), ReaderEndpoint: &EndpointProperty{ Address: jsii.String("address"), Port: jsii.String("port"), }, SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SnapshotArnsToRestore: []*string{ jsii.String("snapshotArnsToRestore"), }, SnapshotRetentionLimit: jsii.Number(123), SubnetIds: []*string{ jsii.String("subnetIds"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UserGroupId: jsii.String("userGroupId"), })
func NewCfnServerlessCache ¶ added in v2.113.0
func NewCfnServerlessCache(scope constructs.Construct, id *string, props *CfnServerlessCacheProps) CfnServerlessCache
type CfnServerlessCacheProps ¶ added in v2.113.0
type CfnServerlessCacheProps struct { // The engine the serverless cache is compatible with. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-engine // Engine *string `field:"required" json:"engine" yaml:"engine"` // The unique identifier of the serverless cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-serverlesscachename // ServerlessCacheName *string `field:"required" json:"serverlessCacheName" yaml:"serverlessCacheName"` // The cache usage limit for the serverless cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-cacheusagelimits // CacheUsageLimits interface{} `field:"optional" json:"cacheUsageLimits" yaml:"cacheUsageLimits"` // The daily time that a cache snapshot will be created. // // Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-dailysnapshottime // DailySnapshotTime *string `field:"optional" json:"dailySnapshotTime" yaml:"dailySnapshotTime"` // A description of the serverless cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-description // Description *string `field:"optional" json:"description" yaml:"description"` // Represents the information required for client programs to connect to a cache node. // // This value is read-only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-endpoint // Endpoint interface{} `field:"optional" json:"endpoint" yaml:"endpoint"` // The name of the final snapshot taken of a cache before the cache is deleted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-finalsnapshotname // FinalSnapshotName *string `field:"optional" json:"finalSnapshotName" yaml:"finalSnapshotName"` // The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // The version number of the engine the serverless cache is compatible with. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-majorengineversion // MajorEngineVersion *string `field:"optional" json:"majorEngineVersion" yaml:"majorEngineVersion"` // Represents the information required for client programs to connect to a cache node. // // This value is read-only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-readerendpoint // ReaderEndpoint interface{} `field:"optional" json:"readerEndpoint" yaml:"readerEndpoint"` // The IDs of the EC2 security groups associated with the serverless cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` // The ARN of the snapshot from which to restore data into the new cache. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotarnstorestore // SnapshotArnsToRestore *[]*string `field:"optional" json:"snapshotArnsToRestore" yaml:"snapshotArnsToRestore"` // The current setting for the number of serverless cache snapshots the system will retain. // // Available for Redis only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-snapshotretentionlimit // SnapshotRetentionLimit *float64 `field:"optional" json:"snapshotRetentionLimit" yaml:"snapshotRetentionLimit"` // If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. // // For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-subnetids // SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"` // A list of tags to be added to this resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // The identifier of the user group associated with the serverless cache. // // Available for Redis only. Default is NULL. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-serverlesscache.html#cfn-elasticache-serverlesscache-usergroupid // UserGroupId *string `field:"optional" json:"userGroupId" yaml:"userGroupId"` }
Properties for defining a `CfnServerlessCache`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnServerlessCacheProps := &CfnServerlessCacheProps{ Engine: jsii.String("engine"), ServerlessCacheName: jsii.String("serverlessCacheName"), // the properties below are optional CacheUsageLimits: &CacheUsageLimitsProperty{ DataStorage: &DataStorageProperty{ Unit: jsii.String("unit"), // the properties below are optional Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, EcpuPerSecond: &ECPUPerSecondProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, DailySnapshotTime: jsii.String("dailySnapshotTime"), Description: jsii.String("description"), Endpoint: &EndpointProperty{ Address: jsii.String("address"), Port: jsii.String("port"), }, FinalSnapshotName: jsii.String("finalSnapshotName"), KmsKeyId: jsii.String("kmsKeyId"), MajorEngineVersion: jsii.String("majorEngineVersion"), ReaderEndpoint: &EndpointProperty{ Address: jsii.String("address"), Port: jsii.String("port"), }, SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SnapshotArnsToRestore: []*string{ jsii.String("snapshotArnsToRestore"), }, SnapshotRetentionLimit: jsii.Number(123), SubnetIds: []*string{ jsii.String("subnetIds"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UserGroupId: jsii.String("userGroupId"), }
type CfnServerlessCache_CacheUsageLimitsProperty ¶ added in v2.113.0
type CfnServerlessCache_CacheUsageLimitsProperty struct { // The maximum data storage limit in the cache, expressed in Gigabytes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-datastorage // DataStorage interface{} `field:"optional" json:"dataStorage" yaml:"dataStorage"` // The number of ElastiCache Processing Units (ECPU) the cache can consume per second. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-cacheusagelimits.html#cfn-elasticache-serverlesscache-cacheusagelimits-ecpupersecond // EcpuPerSecond interface{} `field:"optional" json:"ecpuPerSecond" yaml:"ecpuPerSecond"` }
The usage limits for storage and ElastiCache Processing Units for the cache.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cacheUsageLimitsProperty := &CacheUsageLimitsProperty{ DataStorage: &DataStorageProperty{ Unit: jsii.String("unit"), // the properties below are optional Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, EcpuPerSecond: &ECPUPerSecondProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }
type CfnServerlessCache_DataStorageProperty ¶ added in v2.113.0
type CfnServerlessCache_DataStorageProperty struct { // The unit that the storage is measured in, in GB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-unit // Unit *string `field:"required" json:"unit" yaml:"unit"` // The upper limit for data storage the cache is set to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-maximum // Maximum *float64 `field:"optional" json:"maximum" yaml:"maximum"` // The lower limit for data storage the cache is set to use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-datastorage.html#cfn-elasticache-serverlesscache-datastorage-minimum // Minimum *float64 `field:"optional" json:"minimum" yaml:"minimum"` }
The data storage limit.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataStorageProperty := &DataStorageProperty{ Unit: jsii.String("unit"), // the properties below are optional Maximum: jsii.Number(123), Minimum: jsii.Number(123), }
type CfnServerlessCache_ECPUPerSecondProperty ¶ added in v2.113.0
type CfnServerlessCache_ECPUPerSecondProperty struct { // The configuration for the maximum number of ECPUs the cache can consume per second. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-maximum // Maximum *float64 `field:"optional" json:"maximum" yaml:"maximum"` // The configuration for the minimum number of ECPUs the cache should be able consume per second. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-ecpupersecond.html#cfn-elasticache-serverlesscache-ecpupersecond-minimum // Minimum *float64 `field:"optional" json:"minimum" yaml:"minimum"` }
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eCPUPerSecondProperty := &ECPUPerSecondProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }
type CfnServerlessCache_EndpointProperty ¶ added in v2.113.0
type CfnServerlessCache_EndpointProperty struct { // The DNS hostname of the cache node. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-address // Address *string `field:"optional" json:"address" yaml:"address"` // The port number that the cache engine is listening on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-serverlesscache-endpoint.html#cfn-elasticache-serverlesscache-endpoint-port // Port *string `field:"optional" json:"port" yaml:"port"` }
Represents the information required for client programs to connect to a cache node.
This value is read-only.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointProperty := &EndpointProperty{ Address: jsii.String("address"), Port: jsii.String("port"), }
type CfnSubnetGroup ¶
type CfnSubnetGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The name for the cache subnet group. // // This value is stored as a lowercase string. CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description for the cache subnet group. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The EC2 subnet IDs for the cache subnet group. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A tag that can be added to an ElastiCache subnet group. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a cache subnet group.
For more information about cache subnet groups, go to Cache Subnet Groups in the *Amazon ElastiCache User Guide* or go to [CreateCacheSubnetGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateCacheSubnetGroup.html) in the *Amazon ElastiCache API Reference Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSubnetGroup := awscdk.Aws_elasticache.NewCfnSubnetGroup(this, jsii.String("MyCfnSubnetGroup"), &CfnSubnetGroupProps{ Description: jsii.String("description"), SubnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnSubnetGroup ¶
func NewCfnSubnetGroup(scope constructs.Construct, id *string, props *CfnSubnetGroupProps) CfnSubnetGroup
type CfnSubnetGroupProps ¶
type CfnSubnetGroupProps struct { // The description for the cache subnet group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-description // Description *string `field:"required" json:"description" yaml:"description"` // The EC2 subnet IDs for the cache subnet group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-subnetids // SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` // The name for the cache subnet group. This value is stored as a lowercase string. // // Constraints: Must contain no more than 255 alphanumeric characters or hyphens. // // Example: `mysubnetgroup`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-cachesubnetgroupname // CacheSubnetGroupName *string `field:"optional" json:"cacheSubnetGroupName" yaml:"cacheSubnetGroupName"` // A tag that can be added to an ElastiCache subnet group. // // Tags are composed of a Key/Value pair. You can use tags to categorize and track all your subnet groups. A tag with a null Value is permitted. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-subnetgroup.html#cfn-elasticache-subnetgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSubnetGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSubnetGroupProps := &CfnSubnetGroupProps{ Description: jsii.String("description"), SubnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUser ¶
type CfnUser interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Access permissions string used for this user. AccessString() *string SetAccessString(val *string) // The Amazon Resource Name (ARN) of the user. AttrArn() *string // Indicates the user status. // // Can be "active", "modifying" or "deleting". AttrStatus() *string // Specifies the authentication mode to use. // // Below is an example of the possible JSON values:. AuthenticationMode() interface{} SetAuthenticationMode(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The current supported value is redis. Engine() *string SetEngine(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Indicates a password is not required for this user. NoPasswordRequired() interface{} SetNoPasswordRequired(val interface{}) // Passwords used for this user. Passwords() *[]*string SetPasswords(val *[]*string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this user. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the user. UserId() *string SetUserId(val *string) // The username of the user. UserName() *string SetUserName(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see [Using Role Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authenticationMode interface{} cfnUser := awscdk.Aws_elasticache.NewCfnUser(this, jsii.String("MyCfnUser"), &CfnUserProps{ Engine: jsii.String("engine"), UserId: jsii.String("userId"), UserName: jsii.String("userName"), // the properties below are optional AccessString: jsii.String("accessString"), AuthenticationMode: authenticationMode, NoPasswordRequired: jsii.Boolean(false), Passwords: []*string{ jsii.String("passwords"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html
func NewCfnUser ¶
func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser
type CfnUserGroup ¶
type CfnUserGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the user group. AttrArn() *string // Indicates user group status. // // Can be "creating", "active", "modifying", "deleting". AttrStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The current supported value is redis. Engine() *string SetEngine(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this user. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The ID of the user group. UserGroupId() *string SetUserGroupId(val *string) // The list of user IDs that belong to the user group. UserIds() *[]*string SetUserIds(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see [Using Role Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnUserGroup := awscdk.Aws_elasticache.NewCfnUserGroup(this, jsii.String("MyCfnUserGroup"), &CfnUserGroupProps{ Engine: jsii.String("engine"), UserGroupId: jsii.String("userGroupId"), UserIds: []*string{ jsii.String("userIds"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnUserGroup ¶
func NewCfnUserGroup(scope constructs.Construct, id *string, props *CfnUserGroupProps) CfnUserGroup
type CfnUserGroupProps ¶
type CfnUserGroupProps struct { // The current supported value is redis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-engine // Engine *string `field:"required" json:"engine" yaml:"engine"` // The ID of the user group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-usergroupid // UserGroupId *string `field:"required" json:"userGroupId" yaml:"userGroupId"` // The list of user IDs that belong to the user group. // // A user named `default` must be included. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-userids // UserIds *[]*string `field:"required" json:"userIds" yaml:"userIds"` // An array of key-value pairs to apply to this user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-usergroup.html#cfn-elasticache-usergroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnUserGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnUserGroupProps := &CfnUserGroupProps{ Engine: jsii.String("engine"), UserGroupId: jsii.String("userGroupId"), UserIds: []*string{ jsii.String("userIds"), }, // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnUserProps ¶
type CfnUserProps struct { // The current supported value is redis. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-engine // Engine *string `field:"required" json:"engine" yaml:"engine"` // The ID of the user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-userid // UserId *string `field:"required" json:"userId" yaml:"userId"` // The username of the user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-username // UserName *string `field:"required" json:"userName" yaml:"userName"` // Access permissions string used for this user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-accessstring // AccessString *string `field:"optional" json:"accessString" yaml:"accessString"` // Specifies the authentication mode to use. Below is an example of the possible JSON values:. // // “` // { Passwords: ["*****", "******"] // If Type is password. // } // “`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-authenticationmode // AuthenticationMode interface{} `field:"optional" json:"authenticationMode" yaml:"authenticationMode"` // Indicates a password is not required for this user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-nopasswordrequired // NoPasswordRequired interface{} `field:"optional" json:"noPasswordRequired" yaml:"noPasswordRequired"` // Passwords used for this user. // // You can create up to two passwords for each user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-passwords // Passwords *[]*string `field:"optional" json:"passwords" yaml:"passwords"` // An array of key-value pairs to apply to this user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnUser`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var authenticationMode interface{} cfnUserProps := &CfnUserProps{ Engine: jsii.String("engine"), UserId: jsii.String("userId"), UserName: jsii.String("userName"), // the properties below are optional AccessString: jsii.String("accessString"), AuthenticationMode: authenticationMode, NoPasswordRequired: jsii.Boolean(false), Passwords: []*string{ jsii.String("passwords"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html
type CfnUser_AuthenticationModeProperty ¶ added in v2.55.0
type CfnUser_AuthenticationModeProperty struct { // Specifies the authentication type. // // Possible options are IAM authentication, password and no password. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-type // Type *string `field:"required" json:"type" yaml:"type"` // Specifies the passwords to use for authentication if `Type` is set to `password` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-user-authenticationmode.html#cfn-elasticache-user-authenticationmode-passwords // Passwords *[]*string `field:"optional" json:"passwords" yaml:"passwords"` }
Specifies the authentication mode to use.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" authenticationModeProperty := &AuthenticationModeProperty{ Type: jsii.String("type"), // the properties below are optional Passwords: []*string{ jsii.String("passwords"), }, }
Source Files ¶
- CfnCacheCluster.go
- CfnCacheClusterProps.go
- CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty.go
- CfnCacheCluster_DestinationDetailsProperty.go
- CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty.go
- CfnCacheCluster_LogDeliveryConfigurationRequestProperty.go
- CfnCacheCluster__checks.go
- CfnGlobalReplicationGroup.go
- CfnGlobalReplicationGroupProps.go
- CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty.go
- CfnGlobalReplicationGroup_RegionalConfigurationProperty.go
- CfnGlobalReplicationGroup_ReshardingConfigurationProperty.go
- CfnGlobalReplicationGroup__checks.go
- CfnParameterGroup.go
- CfnParameterGroupProps.go
- CfnParameterGroup__checks.go
- CfnReplicationGroup.go
- CfnReplicationGroupProps.go
- CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty.go
- CfnReplicationGroup_DestinationDetailsProperty.go
- CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty.go
- CfnReplicationGroup_LogDeliveryConfigurationRequestProperty.go
- CfnReplicationGroup_NodeGroupConfigurationProperty.go
- CfnReplicationGroup__checks.go
- CfnSecurityGroup.go
- CfnSecurityGroupIngress.go
- CfnSecurityGroupIngressProps.go
- CfnSecurityGroupIngress__checks.go
- CfnSecurityGroupProps.go
- CfnSecurityGroup__checks.go
- CfnServerlessCache.go
- CfnServerlessCacheProps.go
- CfnServerlessCache_CacheUsageLimitsProperty.go
- CfnServerlessCache_DataStorageProperty.go
- CfnServerlessCache_ECPUPerSecondProperty.go
- CfnServerlessCache_EndpointProperty.go
- CfnServerlessCache__checks.go
- CfnSubnetGroup.go
- CfnSubnetGroupProps.go
- CfnSubnetGroup__checks.go
- CfnUser.go
- CfnUserGroup.go
- CfnUserGroupProps.go
- CfnUserGroup__checks.go
- CfnUserProps.go
- CfnUser_AuthenticationModeProperty.go
- CfnUser__checks.go
- main.go