Documentation ¶
Index ¶
- func CfnCacheCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCacheCluster_IsCfnElement(x interface{}) *bool
- func CfnCacheCluster_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCacheCluster_IsConstruct(x interface{}) *bool
- func CfnGlobalReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGlobalReplicationGroup_IsCfnElement(x interface{}) *bool
- func CfnGlobalReplicationGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGlobalReplicationGroup_IsConstruct(x interface{}) *bool
- func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnParameterGroup_IsConstruct(x interface{}) *bool
- func CfnReplicationGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnReplicationGroup_IsCfnElement(x interface{}) *bool
- func CfnReplicationGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnReplicationGroup_IsConstruct(x interface{}) *bool
- func CfnSecurityGroupIngress_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroupIngress_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroupIngress_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSecurityGroupIngress_IsConstruct(x interface{}) *bool
- func CfnSecurityGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityGroup_IsCfnElement(x interface{}) *bool
- func CfnSecurityGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSecurityGroup_IsConstruct(x interface{}) *bool
- func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSubnetGroup_IsConstruct(x interface{}) *bool
- func CfnUserGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserGroup_IsCfnElement(x interface{}) *bool
- func CfnUserGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnUserGroup_IsConstruct(x interface{}) *bool
- func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUser_IsCfnElement(x interface{}) *bool
- func CfnUser_IsCfnResource(construct constructs.IConstruct) *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 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 CfnSubnetGroup
- type CfnSubnetGroupProps
- type CfnUser
- type CfnUserGroup
- type CfnUserGroupProps
- type CfnUserProps
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCacheCluster_IsConstruct ¶
func CfnCacheCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGlobalReplicationGroup_IsConstruct ¶
func CfnGlobalReplicationGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnParameterGroup_IsConstruct ¶
func CfnParameterGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnReplicationGroup_IsConstruct ¶
func CfnReplicationGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSecurityGroupIngress_IsConstruct ¶
func CfnSecurityGroupIngress_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSecurityGroup_IsConstruct ¶
func CfnSecurityGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSubnetGroup_IsConstruct ¶
func CfnSubnetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUserGroup_IsConstruct ¶
func CfnUserGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnUser_IsConstruct ¶
func CfnUser_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnCacheCluster_Override ¶
func NewCfnCacheCluster_Override(c CfnCacheCluster, scope constructs.Construct, id *string, props *CfnCacheClusterProps)
Create a new `AWS::ElastiCache::CacheCluster`.
func NewCfnGlobalReplicationGroup_Override ¶
func NewCfnGlobalReplicationGroup_Override(c CfnGlobalReplicationGroup, scope constructs.Construct, id *string, props *CfnGlobalReplicationGroupProps)
Create a new `AWS::ElastiCache::GlobalReplicationGroup`.
func NewCfnParameterGroup_Override ¶
func NewCfnParameterGroup_Override(c CfnParameterGroup, scope constructs.Construct, id *string, props *CfnParameterGroupProps)
Create a new `AWS::ElastiCache::ParameterGroup`.
func NewCfnReplicationGroup_Override ¶
func NewCfnReplicationGroup_Override(c CfnReplicationGroup, scope constructs.Construct, id *string, props *CfnReplicationGroupProps)
Create a new `AWS::ElastiCache::ReplicationGroup`.
func NewCfnSecurityGroupIngress_Override ¶
func NewCfnSecurityGroupIngress_Override(c CfnSecurityGroupIngress, scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps)
Create a new `AWS::ElastiCache::SecurityGroupIngress`.
func NewCfnSecurityGroup_Override ¶
func NewCfnSecurityGroup_Override(c CfnSecurityGroup, scope constructs.Construct, id *string, props *CfnSecurityGroupProps)
Create a new `AWS::ElastiCache::SecurityGroup`.
func NewCfnSubnetGroup_Override ¶
func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope constructs.Construct, id *string, props *CfnSubnetGroupProps)
Create a new `AWS::ElastiCache::SubnetGroup`.
func NewCfnUserGroup_Override ¶
func NewCfnUserGroup_Override(c CfnUserGroup, scope constructs.Construct, id *string, props *CfnUserGroupProps)
Create a new `AWS::ElastiCache::UserGroup`.
func NewCfnUser_Override ¶
func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
Create a new `AWS::ElastiCache::User`.
Types ¶
type CfnCacheCluster ¶
type CfnCacheCluster interface { awscdk.CfnResource awscdk.IInspectable AttrConfigurationEndpointAddress() *string AttrConfigurationEndpointPort() *string AttrRedisEndpointAddress() *string AttrRedisEndpointPort() *string AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) AzMode() *string SetAzMode(val *string) CacheNodeType() *string SetCacheNodeType(val *string) CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) CacheSecurityGroupNames() *[]*string SetCacheSecurityGroupNames(val *[]*string) CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string ClusterName() *string SetClusterName(val *string) CreationStack() *[]*string Engine() *string SetEngine(val *string) EngineVersion() *string SetEngineVersion(val *string) LogDeliveryConfigurations() interface{} SetLogDeliveryConfigurations(val interface{}) LogicalId() *string Node() constructs.Node NotificationTopicArn() *string SetNotificationTopicArn(val *string) NumCacheNodes() *float64 SetNumCacheNodes(val *float64) Port() *float64 SetPort(val *float64) PreferredAvailabilityZone() *string SetPreferredAvailabilityZone(val *string) PreferredAvailabilityZones() *[]*string SetPreferredAvailabilityZones(val *[]*string) PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) Ref() *string SnapshotArns() *[]*string SetSnapshotArns(val *[]*string) SnapshotName() *string SetSnapshotName(val *string) SnapshotRetentionLimit() *float64 SetSnapshotRetentionLimit(val *float64) SnapshotWindow() *string SetSnapshotWindow(val *string) Stack() awscdk.Stack Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::CacheCluster`.
The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.
TODO: EXAMPLE
func NewCfnCacheCluster ¶
func NewCfnCacheCluster(scope constructs.Construct, id *string, props *CfnCacheClusterProps) CfnCacheCluster
Create a new `AWS::ElastiCache::CacheCluster`.
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.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) // // *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. CacheNodeType *string `json:"cacheNodeType" yaml:"cacheNodeType"` // The name of the cache engine to be used for this cluster. // // Valid values for this parameter are: `memcached` | `redis` Engine *string `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) . NumCacheNodes *float64 `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. AutoMinorVersionUpgrade interface{} `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. AzMode *string `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. CacheParameterGroupName *string `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). CacheSecurityGroupNames *[]*string `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) . CacheSubnetGroupName *string `json:"cacheSubnetGroupName" yaml:"cacheSubnetGroupName"` // A name for the cache cluster. // // If you don't specify a name, AWSCloudFormation 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. ClusterName *string `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. EngineVersion *string `json:"engineVersion" yaml:"engineVersion"` // Specifies the destination, format and type of the logs. LogDeliveryConfigurations interface{} `json:"logDeliveryConfigurations" yaml:"logDeliveryConfigurations"` // 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. NotificationTopicArn *string `json:"notificationTopicArn" yaml:"notificationTopicArn"` // The port number on which each of the cache nodes accepts connections. Port *float64 `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. PreferredAvailabilityZone *string `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. PreferredAvailabilityZones *[]*string `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: // // 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` PreferredMaintenanceWindow *string `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` SnapshotArns *[]*string `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` . SnapshotName *string `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). SnapshotRetentionLimit *float64 `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` . SnapshotWindow *string `json:"snapshotWindow" yaml:"snapshotWindow"` // A list of tags to be added to this resource. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` // 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). VpcSecurityGroupIds *[]*string `json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Properties for defining a `CfnCacheCluster`.
TODO: EXAMPLE
type CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty ¶
type CfnCacheCluster_CloudWatchLogsDestinationDetailsProperty struct { // The name of the CloudWatch Logs log group. LogGroup *string `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.
TODO: EXAMPLE
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. CloudWatchLogsDetails interface{} `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. KinesisFirehoseDetails interface{} `json:"kinesisFirehoseDetails" yaml:"kinesisFirehoseDetails"` }
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
TODO: EXAMPLE
type CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty ¶
type CfnCacheCluster_KinesisFirehoseDestinationDetailsProperty struct { // The name of the Kinesis Data Firehose delivery stream. DeliveryStream *string `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.
TODO: EXAMPLE
type CfnCacheCluster_LogDeliveryConfigurationRequestProperty ¶
type CfnCacheCluster_LogDeliveryConfigurationRequestProperty struct { // Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. DestinationDetails interface{} `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` . DestinationType *string `json:"destinationType" yaml:"destinationType"` // Valid values are either `json` or `text` . LogFormat *string `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` . LogType *string `json:"logType" yaml:"logType"` }
Specifies the destination, format and type of the logs.
TODO: EXAMPLE
type CfnGlobalReplicationGroup ¶
type CfnGlobalReplicationGroup interface { awscdk.CfnResource awscdk.IInspectable AttrGlobalReplicationGroupId() *string AttrStatus() *string AutomaticFailoverEnabled() interface{} SetAutomaticFailoverEnabled(val interface{}) CacheNodeType() *string SetCacheNodeType(val *string) CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string EngineVersion() *string SetEngineVersion(val *string) GlobalNodeGroupCount() *float64 SetGlobalNodeGroupCount(val *float64) GlobalReplicationGroupDescription() *string SetGlobalReplicationGroupDescription(val *string) GlobalReplicationGroupIdSuffix() *string SetGlobalReplicationGroupIdSuffix(val *string) LogicalId() *string Members() interface{} SetMembers(val interface{}) Node() constructs.Node Ref() *string RegionalConfigurations() interface{} SetRegionalConfigurations(val interface{}) Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::GlobalReplicationGroup`.
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.
TODO: EXAMPLE
func NewCfnGlobalReplicationGroup ¶
func NewCfnGlobalReplicationGroup(scope constructs.Construct, id *string, props *CfnGlobalReplicationGroupProps) CfnGlobalReplicationGroup
Create a new `AWS::ElastiCache::GlobalReplicationGroup`.
type CfnGlobalReplicationGroupProps ¶
type CfnGlobalReplicationGroupProps struct { // The replication groups that comprise the Global datastore. Members interface{} `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. AutomaticFailoverEnabled interface{} `json:"automaticFailoverEnabled" yaml:"automaticFailoverEnabled"` // The cache node type of the Global datastore. CacheNodeType *string `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. CacheParameterGroupName *string `json:"cacheParameterGroupName" yaml:"cacheParameterGroupName"` // The Elasticache Redis engine version. EngineVersion *string `json:"engineVersion" yaml:"engineVersion"` // The number of node groups that comprise the Global Datastore. GlobalNodeGroupCount *float64 `json:"globalNodeGroupCount" yaml:"globalNodeGroupCount"` // The optional description of the Global datastore. GlobalReplicationGroupDescription *string `json:"globalReplicationGroupDescription" yaml:"globalReplicationGroupDescription"` // The suffix name of a Global Datastore. // // The suffix guarantees uniqueness of the Global Datastore name across multiple regions. GlobalReplicationGroupIdSuffix *string `json:"globalReplicationGroupIdSuffix" yaml:"globalReplicationGroupIdSuffix"` // The Amazon Regions that comprise the Global Datastore. RegionalConfigurations interface{} `json:"regionalConfigurations" yaml:"regionalConfigurations"` }
Properties for defining a `CfnGlobalReplicationGroup`.
TODO: EXAMPLE
type CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty ¶
type CfnGlobalReplicationGroup_GlobalReplicationGroupMemberProperty struct { // The replication group id of the Global datastore member. ReplicationGroupId *string `json:"replicationGroupId" yaml:"replicationGroupId"` // The Amazon region of the Global datastore member. ReplicationGroupRegion *string `json:"replicationGroupRegion" yaml:"replicationGroupRegion"` // Indicates the role of the replication group, `PRIMARY` or `SECONDARY` . Role *string `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.
TODO: EXAMPLE
type CfnGlobalReplicationGroup_RegionalConfigurationProperty ¶
type CfnGlobalReplicationGroup_RegionalConfigurationProperty struct { // The name of the secondary cluster. ReplicationGroupId *string `json:"replicationGroupId" yaml:"replicationGroupId"` // The Amazon region where the cluster is stored. ReplicationGroupRegion *string `json:"replicationGroupRegion" yaml:"replicationGroupRegion"` // A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster. ReshardingConfigurations interface{} `json:"reshardingConfigurations" yaml:"reshardingConfigurations"` }
A list of the replication groups.
TODO: EXAMPLE
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. NodeGroupId *string `json:"nodeGroupId" yaml:"nodeGroupId"` // A list of preferred availability zones for the nodes in this cluster. PreferredAvailabilityZones *[]*string `json:"preferredAvailabilityZones" yaml:"preferredAvailabilityZones"` }
A list of `PreferredAvailabilityZones` objects that specifies the configuration of a node group in the resharded cluster.
TODO: EXAMPLE
type CfnParameterGroup ¶
type CfnParameterGroup interface { awscdk.CfnResource awscdk.IInspectable CacheParameterGroupFamily() *string SetCacheParameterGroupFamily(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) LogicalId() *string Node() constructs.Node Properties() interface{} SetProperties(val interface{}) Ref() *string Stack() awscdk.Stack Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::ParameterGroup`.
The `AWS::ElastiCache::ParameterGroup` type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster.
TODO: EXAMPLE
func NewCfnParameterGroup ¶
func NewCfnParameterGroup(scope constructs.Construct, id *string, props *CfnParameterGroupProps) CfnParameterGroup
Create a new `AWS::ElastiCache::ParameterGroup`.
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` CacheParameterGroupFamily *string `json:"cacheParameterGroupFamily" yaml:"cacheParameterGroupFamily"` // The description for this cache parameter group. Description *string `json:"description" yaml:"description"` // A comma-delimited list of parameter name/value pairs. // // For more information, see [ModifyCacheParameterGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) in the *Amazon ElastiCache API Reference Guide* . // // For example: // // “` // "Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02" // } // “` Properties interface{} `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnParameterGroup`.
TODO: EXAMPLE
type CfnReplicationGroup ¶
type CfnReplicationGroup interface { awscdk.CfnResource awscdk.IInspectable AtRestEncryptionEnabled() interface{} SetAtRestEncryptionEnabled(val interface{}) AttrConfigurationEndPointAddress() *string AttrConfigurationEndPointPort() *string AttrPrimaryEndPointAddress() *string AttrPrimaryEndPointPort() *string AttrReadEndPointAddresses() *string AttrReadEndPointAddressesList() *[]*string AttrReadEndPointPorts() *string AttrReadEndPointPortsList() *[]*string AttrReaderEndPointAddress() *string AttrReaderEndPointPort() *string AuthToken() *string SetAuthToken(val *string) AutomaticFailoverEnabled() interface{} SetAutomaticFailoverEnabled(val interface{}) AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) CacheNodeType() *string SetCacheNodeType(val *string) CacheParameterGroupName() *string SetCacheParameterGroupName(val *string) CacheSecurityGroupNames() *[]*string SetCacheSecurityGroupNames(val *[]*string) CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string DataTieringEnabled() interface{} SetDataTieringEnabled(val interface{}) Engine() *string SetEngine(val *string) EngineVersion() *string SetEngineVersion(val *string) GlobalReplicationGroupId() *string SetGlobalReplicationGroupId(val *string) KmsKeyId() *string SetKmsKeyId(val *string) LogDeliveryConfigurations() interface{} SetLogDeliveryConfigurations(val interface{}) LogicalId() *string MultiAzEnabled() interface{} SetMultiAzEnabled(val interface{}) Node() constructs.Node NodeGroupConfiguration() interface{} SetNodeGroupConfiguration(val interface{}) NotificationTopicArn() *string SetNotificationTopicArn(val *string) NumCacheClusters() *float64 SetNumCacheClusters(val *float64) NumNodeGroups() *float64 SetNumNodeGroups(val *float64) Port() *float64 SetPort(val *float64) PreferredCacheClusterAZs() *[]*string SetPreferredCacheClusterAZs(val *[]*string) PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(val *string) PrimaryClusterId() *string SetPrimaryClusterId(val *string) Ref() *string ReplicasPerNodeGroup() *float64 SetReplicasPerNodeGroup(val *float64) ReplicationGroupDescription() *string SetReplicationGroupDescription(val *string) ReplicationGroupId() *string SetReplicationGroupId(val *string) SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) SnapshotArns() *[]*string SetSnapshotArns(val *[]*string) SnapshotName() *string SetSnapshotName(val *string) SnapshotRetentionLimit() *float64 SetSnapshotRetentionLimit(val *float64) SnapshottingClusterId() *string SetSnapshottingClusterId(val *string) SnapshotWindow() *string SetSnapshotWindow(val *string) Stack() awscdk.Stack Tags() awscdk.TagManager TransitEncryptionEnabled() interface{} SetTransitEncryptionEnabled(val interface{}) UpdatedProperites() *map[string]interface{} UserGroupIds() *[]*string SetUserGroupIds(val *[]*string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::ReplicationGroup`.
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* .
TODO: EXAMPLE
func NewCfnReplicationGroup ¶
func NewCfnReplicationGroup(scope constructs.Construct, id *string, props *CfnReplicationGroupProps) CfnReplicationGroup
Create a new `AWS::ElastiCache::ReplicationGroup`.
type CfnReplicationGroupProps ¶
type CfnReplicationGroupProps struct { // A user-created description for the replication group. ReplicationGroupDescription *string `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` AtRestEncryptionEnabled interface{} `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. // - Cannot contain any of the following characters: '/', '"', or '@'. // // For more information, see [AUTH password](https://docs.aws.amazon.com/http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH. AuthToken *string `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 AutomaticFailoverEnabled interface{} `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. AutoMinorVersionUpgrade interface{} `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) CacheNodeType *string `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` . CacheParameterGroupName *string `json:"cacheParameterGroupName" yaml:"cacheParameterGroupName"` // A list of cache security group names to associate with this replication group. CacheSecurityGroupNames *[]*string `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) . CacheSubnetGroupName *string `json:"cacheSubnetGroupName" yaml:"cacheSubnetGroupName"` // 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) . DataTieringEnabled interface{} `json:"dataTieringEnabled" yaml:"dataTieringEnabled"` // The name of the cache engine to be used for the clusters in this replication group. // // Must be Redis. Engine *string `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. EngineVersion *string `json:"engineVersion" yaml:"engineVersion"` // The name of the Global datastore. GlobalReplicationGroupId *string `json:"globalReplicationGroupId" yaml:"globalReplicationGroupId"` // The ID of the KMS key used to encrypt the disk on the cluster. KmsKeyId *string `json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies the destination, format and type of the logs. LogDeliveryConfigurations interface{} `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) . MultiAzEnabled interface{} `json:"multiAzEnabled" yaml:"multiAzEnabled"` // `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) . NodeGroupConfiguration interface{} `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. NotificationTopicArn *string `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). NumCacheClusters *float64 `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 NumNodeGroups *float64 `json:"numNodeGroups" yaml:"numNodeGroups"` // The port number on which each member of the replication group accepts connections. Port *float64 `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. PreferredCacheClusterAZs *[]*string `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` PreferredMaintenanceWindow *string `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. PrimaryClusterId *string `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. ReplicasPerNodeGroup *float64 `json:"replicasPerNodeGroup" yaml:"replicasPerNodeGroup"` // The replication group identifier. This parameter is stored as a lowercase string. // // Constraints: // // - A name must contain from 1 to 40 alphanumeric characters or hyphens. // - The first character must be a letter. // - A name cannot end with a hyphen or contain two consecutive hyphens. ReplicationGroupId *string `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). SecurityGroupIds *[]*string `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` SnapshotArns *[]*string `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. SnapshotName *string `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). SnapshotRetentionLimit *float64 `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. SnapshottingClusterId *string `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. SnapshotWindow *string `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. Tags *[]*awscdk.CfnTag `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` . TransitEncryptionEnabled interface{} `json:"transitEncryptionEnabled" yaml:"transitEncryptionEnabled"` // The list of user groups to associate with the replication group. UserGroupIds *[]*string `json:"userGroupIds" yaml:"userGroupIds"` }
Properties for defining a `CfnReplicationGroup`.
TODO: EXAMPLE
type CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty ¶
type CfnReplicationGroup_CloudWatchLogsDestinationDetailsProperty struct { // The name of the CloudWatch Logs log group. LogGroup *string `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.
TODO: EXAMPLE
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. CloudWatchLogsDetails interface{} `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. KinesisFirehoseDetails interface{} `json:"kinesisFirehoseDetails" yaml:"kinesisFirehoseDetails"` }
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
TODO: EXAMPLE
type CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty ¶
type CfnReplicationGroup_KinesisFirehoseDestinationDetailsProperty struct { // The name of the Kinesis Data Firehose delivery stream. DeliveryStream *string `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.
TODO: EXAMPLE
type CfnReplicationGroup_LogDeliveryConfigurationRequestProperty ¶
type CfnReplicationGroup_LogDeliveryConfigurationRequestProperty struct { // Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination. DestinationDetails interface{} `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` . DestinationType *string `json:"destinationType" yaml:"destinationType"` // Valid values are either `json` or `text` . LogFormat *string `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` . LogType *string `json:"logType" yaml:"logType"` }
Specifies the destination, format and type of the logs.
TODO: EXAMPLE
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. NodeGroupId *string `json:"nodeGroupId" yaml:"nodeGroupId"` // The Availability Zone where the primary node of this node group (shard) is launched. PrimaryAvailabilityZone *string `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. ReplicaAvailabilityZones *[]*string `json:"replicaAvailabilityZones" yaml:"replicaAvailabilityZones"` // The number of read replica nodes in this node group (shard). ReplicaCount *float64 `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) . Slots *string `json:"slots" yaml:"slots"` }
`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
TODO: EXAMPLE
type CfnSecurityGroup ¶
type CfnSecurityGroup interface { awscdk.CfnResource awscdk.IInspectable CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::SecurityGroup`.
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) .
TODO: EXAMPLE
func NewCfnSecurityGroup ¶
func NewCfnSecurityGroup(scope constructs.Construct, id *string, props *CfnSecurityGroupProps) CfnSecurityGroup
Create a new `AWS::ElastiCache::SecurityGroup`.
type CfnSecurityGroupIngress ¶
type CfnSecurityGroupIngress interface { awscdk.CfnResource awscdk.IInspectable CacheSecurityGroupName() *string SetCacheSecurityGroupName(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Ec2SecurityGroupName() *string SetEc2SecurityGroupName(val *string) Ec2SecurityGroupOwnerId() *string SetEc2SecurityGroupOwnerId(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::SecurityGroupIngress`.
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.
TODO: EXAMPLE
func NewCfnSecurityGroupIngress ¶
func NewCfnSecurityGroupIngress(scope constructs.Construct, id *string, props *CfnSecurityGroupIngressProps) CfnSecurityGroupIngress
Create a new `AWS::ElastiCache::SecurityGroupIngress`.
type CfnSecurityGroupIngressProps ¶
type CfnSecurityGroupIngressProps struct { // The name of the Cache Security Group to authorize. CacheSecurityGroupName *string `json:"cacheSecurityGroupName" yaml:"cacheSecurityGroupName"` // Name of the EC2 Security Group to include in the authorization. Ec2SecurityGroupName *string `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. Ec2SecurityGroupOwnerId *string `json:"ec2SecurityGroupOwnerId" yaml:"ec2SecurityGroupOwnerId"` }
Properties for defining a `CfnSecurityGroupIngress`.
TODO: EXAMPLE
type CfnSecurityGroupProps ¶
type CfnSecurityGroupProps struct { // A description for the cache security group. Description *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnSecurityGroup`.
TODO: EXAMPLE
type CfnSubnetGroup ¶
type CfnSubnetGroup interface { awscdk.CfnResource awscdk.IInspectable CacheSubnetGroupName() *string SetCacheSubnetGroupName(val *string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Description() *string SetDescription(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack SubnetIds() *[]*string SetSubnetIds(val *[]*string) Tags() awscdk.TagManager UpdatedProperites() *map[string]interface{} AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::SubnetGroup`.
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* .
TODO: EXAMPLE
func NewCfnSubnetGroup ¶
func NewCfnSubnetGroup(scope constructs.Construct, id *string, props *CfnSubnetGroupProps) CfnSubnetGroup
Create a new `AWS::ElastiCache::SubnetGroup`.
type CfnSubnetGroupProps ¶
type CfnSubnetGroupProps struct { // The description for the cache subnet group. Description *string `json:"description" yaml:"description"` // The EC2 subnet IDs for the cache subnet group. SubnetIds *[]*string `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` CacheSubnetGroupName *string `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. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnSubnetGroup`.
TODO: EXAMPLE
type CfnUser ¶
type CfnUser interface { awscdk.CfnResource awscdk.IInspectable AccessString() *string SetAccessString(val *string) AttrArn() *string AttrStatus() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Engine() *string SetEngine(val *string) LogicalId() *string Node() constructs.Node NoPasswordRequired() interface{} SetNoPasswordRequired(val interface{}) Passwords() *[]*string SetPasswords(val *[]*string) Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} UserId() *string SetUserId(val *string) UserName() *string SetUserName(val *string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::User`.
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) .
TODO: EXAMPLE
func NewCfnUser ¶
func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser
Create a new `AWS::ElastiCache::User`.
type CfnUserGroup ¶
type CfnUserGroup interface { awscdk.CfnResource awscdk.IInspectable AttrArn() *string AttrStatus() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string Engine() *string SetEngine(val *string) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack UpdatedProperites() *map[string]interface{} UserGroupId() *string SetUserGroupId(val *string) UserIds() *[]*string SetUserIds(val *[]*string) AddDeletionOverride(path *string) AddDependsOn(target awscdk.CfnResource) AddMetadata(key *string, value interface{}) AddOverride(path *string, value interface{}) AddPropertyDeletionOverride(propertyPath *string) AddPropertyOverride(propertyPath *string, value interface{}) ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) GetAtt(attributeName *string) awscdk.Reference GetMetadata(key *string) interface{} Inspect(inspector awscdk.TreeInspector) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ElastiCache::UserGroup`.
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)
TODO: EXAMPLE
func NewCfnUserGroup ¶
func NewCfnUserGroup(scope constructs.Construct, id *string, props *CfnUserGroupProps) CfnUserGroup
Create a new `AWS::ElastiCache::UserGroup`.
type CfnUserGroupProps ¶
type CfnUserGroupProps struct { // The current supported value is redis. Engine *string `json:"engine" yaml:"engine"` // The ID of the user group. UserGroupId *string `json:"userGroupId" yaml:"userGroupId"` // The list of user IDs that belong to the user group. // // A user named `default` must be included. UserIds *[]*string `json:"userIds" yaml:"userIds"` }
Properties for defining a `CfnUserGroup`.
TODO: EXAMPLE
type CfnUserProps ¶
type CfnUserProps struct { // The current supported value is redis. Engine *string `json:"engine" yaml:"engine"` // The ID of the user. UserId *string `json:"userId" yaml:"userId"` // The username of the user. UserName *string `json:"userName" yaml:"userName"` // Access permissions string used for this user. AccessString *string `json:"accessString" yaml:"accessString"` // Indicates a password is not required for this user. NoPasswordRequired interface{} `json:"noPasswordRequired" yaml:"noPasswordRequired"` // Passwords used for this user. // // You can create up to two passwords for each user. Passwords *[]*string `json:"passwords" yaml:"passwords"` }
Properties for defining a `CfnUser`.
TODO: EXAMPLE