Class CfnCacheClusterMixinProps.Jsii$Proxy
- All Implemented Interfaces:
CfnCacheClusterMixinProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnCacheClusterMixinProps
CfnCacheClusterMixinProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.elasticache.mixins.CfnCacheClusterMixinProps
CfnCacheClusterMixinProps.Builder, CfnCacheClusterMixinProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnCacheClusterMixinProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal ObjectIf you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.final StringSpecifies 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.final StringThe compute and memory capacity of the nodes in the node group (shard).final StringThe name of the parameter group to associate with this cluster.A list of security group names to associate with this cluster.final StringThe name of the subnet group to be used for the cluster.final StringA name for the cache cluster.final StringThe name of the cache engine to be used for this cluster.final StringThe version number of the cache engine to be used for this cluster.final StringThe network type you choose when modifying a cluster, eitheripv4|ipv6.final ObjectSpecifies the destination, format and type of the logs.final StringMust be eitheripv4|ipv6|dual_stack.final StringThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.final NumberThe number of cache nodes that the cache cluster should have.final NumbergetPort()The port number on which each of the cache nodes accepts connections.final StringThe EC2 Availability Zone in which the cluster is created.A list of the Availability Zones in which cache nodes are created.final StringSpecifies the weekly time range during which maintenance on the cluster is performed.A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.final StringThe name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).final NumberThe number of days for which ElastiCache retains automatic snapshots before deleting them.final StringThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).getTags()A list of tags to be added to this resource.final ObjectA flag that enables in-transit encryption when set to true.One or more VPC security groups associated with the cluster.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnCacheClusterMixinProps.Builder.
-
-
Method Details
-
getAutoMinorVersionUpgrade
Description copied from interface:CfnCacheClusterMixinPropsIf you are running Valkey 7.2 or later, or Redis OSS 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.Returns union: either
BooleanorIResolvable- Specified by:
getAutoMinorVersionUpgradein interfaceCfnCacheClusterMixinProps- See Also:
-
getAzMode
Description copied from interface:CfnCacheClusterMixinPropsSpecifies 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
AZModeandPreferredAvailabilityZonesare not specified, ElastiCache assumessingle-azmode.- Specified by:
getAzModein interfaceCfnCacheClusterMixinProps- See Also:
-
getCacheNodeType
Description copied from interface:CfnCacheClusterMixinPropsThe 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
LogicalResourceIdof 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.24xlargeM5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT4g node types:
cache.t4g.micro,cache.t4g.small,cache.t4g.mediumT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.medium- Previous generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 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.16xlargeThe
r6gdfamily 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.24xlargeR5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 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.4xlargeR3 node types:
cache.r3.large,cache.r3.xlarge,cache.r3.2xlarge,cache.r3.4xlarge,cache.r3.8xlargeFor region availability, see Supported Node Types by Region
Additional node type info
- All current generation instance types are created in Amazon VPC by default.
- Valkey and Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
- Valkey and Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
- Redis OSS configuration variables
appendonlyandappendfsyncare not supported on Redis OSS version 2.8.22 and later.
- Specified by:
getCacheNodeTypein interfaceCfnCacheClusterMixinProps- See Also:
-
getCacheParameterGroupName
Description copied from interface:CfnCacheClusterMixinPropsThe 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.- Specified by:
getCacheParameterGroupNamein interfaceCfnCacheClusterMixinProps- See Also:
-
getCacheSecurityGroupNames
Description copied from interface:CfnCacheClusterMixinPropsA 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).
- Specified by:
getCacheSecurityGroupNamesin interfaceCfnCacheClusterMixinProps- See Also:
-
getCacheSubnetGroupName
Description copied from interface:CfnCacheClusterMixinPropsThe 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) .- Specified by:
getCacheSubnetGroupNamein interfaceCfnCacheClusterMixinProps- See Also:
-
getClusterName
Description copied from interface:CfnCacheClusterMixinPropsA name for the cache cluster.If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .
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.
- Specified by:
getClusterNamein interfaceCfnCacheClusterMixinProps- See Also:
-
getEngine
Description copied from interface:CfnCacheClusterMixinPropsThe name of the cache engine to be used for this cluster.Valid values for this parameter are:
memcached| valkey |redis- Specified by:
getEnginein interfaceCfnCacheClusterMixinProps- See Also:
-
getEngineVersion
Description copied from interface:CfnCacheClusterMixinPropsThe 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 ), 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.
- Specified by:
getEngineVersionin interfaceCfnCacheClusterMixinProps- See Also:
-
getIpDiscovery
Description copied from interface:CfnCacheClusterMixinPropsThe network type you choose when modifying a cluster, eitheripv4|ipv6.IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .
- Specified by:
getIpDiscoveryin interfaceCfnCacheClusterMixinProps- See Also:
-
getLogDeliveryConfigurations
Description copied from interface:CfnCacheClusterMixinPropsSpecifies the destination, format and type of the logs.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCacheClusterPropsMixin.LogDeliveryConfigurationRequestProperty>- Specified by:
getLogDeliveryConfigurationsin interfaceCfnCacheClusterMixinProps- See Also:
-
getNetworkType
Description copied from interface:CfnCacheClusterMixinPropsMust be eitheripv4|ipv6|dual_stack.IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .
- Specified by:
getNetworkTypein interfaceCfnCacheClusterMixinProps- See Also:
-
getNotificationTopicArn
Description copied from interface:CfnCacheClusterMixinPropsThe 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.
- Specified by:
getNotificationTopicArnin interfaceCfnCacheClusterMixinProps- See Also:
-
getNumCacheNodes
Description copied from interface:CfnCacheClusterMixinPropsThe number of cache nodes that the cache cluster should have.However, if the
PreferredAvailabilityZoneandPreferredAvailabilityZonesproperties were not previously specified and you don't specify any new values, an update requires replacement .- Specified by:
getNumCacheNodesin interfaceCfnCacheClusterMixinProps- See Also:
-
getPort
Description copied from interface:CfnCacheClusterMixinPropsThe port number on which each of the cache nodes accepts connections.- Specified by:
getPortin interfaceCfnCacheClusterMixinProps- See Also:
-
getPreferredAvailabilityZone
Description copied from interface:CfnCacheClusterMixinPropsThe 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.
- Specified by:
getPreferredAvailabilityZonein interfaceCfnCacheClusterMixinProps- See Also:
-
getPreferredAvailabilityZones
Description copied from interface:CfnCacheClusterMixinPropsA 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
PreferredAvailabilityZoneinstead, or repeat the Availability Zone multiple times in the list.Default: System chosen Availability Zones.
- Specified by:
getPreferredAvailabilityZonesin interfaceCfnCacheClusterMixinProps- See Also:
-
getPreferredMaintenanceWindow
Description copied from interface:CfnCacheClusterMixinPropsSpecifies 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
dddare:sunmontuewedthufrisat
Example:
sun:23:00-mon:01:30- Specified by:
getPreferredMaintenanceWindowin interfaceCfnCacheClusterMixinProps- See Also:
-
getSnapshotArns
Description copied from interface:CfnCacheClusterMixinPropsA single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS 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
Engineparameter isredis.Example of an Amazon S3 ARN:
arn:aws:s3:::my_bucket/snapshot1.rdb- Specified by:
getSnapshotArnsin interfaceCfnCacheClusterMixinProps- See Also:
-
getSnapshotName
Description copied from interface:CfnCacheClusterMixinPropsThe name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).The snapshot status changes to
restoringwhile the new node group (shard) is being created.This parameter is only valid if the
Engineparameter isredis.- Specified by:
getSnapshotNamein interfaceCfnCacheClusterMixinProps- See Also:
-
getSnapshotRetentionLimit
Description copied from interface:CfnCacheClusterMixinPropsThe number of days for which ElastiCache retains automatic snapshots before deleting them.For example, if you set
SnapshotRetentionLimitto 5, a snapshot taken today is retained for 5 days before being deleted.This parameter is only valid if the
Engineparameter isredis.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
- Specified by:
getSnapshotRetentionLimitin interfaceCfnCacheClusterMixinProps- See Also:
-
getSnapshotWindow
Description copied from interface:CfnCacheClusterMixinPropsThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).Example:
05:00-09:00If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the
Engineparameter isredis.- Specified by:
getSnapshotWindowin interfaceCfnCacheClusterMixinProps- See Also:
-
getTags
Description copied from interface:CfnCacheClusterMixinPropsA list of tags to be added to this resource.- Specified by:
getTagsin interfaceCfnCacheClusterMixinProps- See Also:
-
getTransitEncryptionEnabled
Description copied from interface:CfnCacheClusterMixinPropsA flag that enables in-transit encryption when set to true.Returns union: either
BooleanorIResolvable- Specified by:
getTransitEncryptionEnabledin interfaceCfnCacheClusterMixinProps- See Also:
-
getVpcSecurityGroupIds
Description copied from interface:CfnCacheClusterMixinPropsOne 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).
- Specified by:
getVpcSecurityGroupIdsin interfaceCfnCacheClusterMixinProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-