Class CreateCacheClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest
software.amazon.awssdk.services.elasticache.model.CreateCacheClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCacheClusterRequest.Builder,CreateCacheClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCacheClusterRequest extends ElastiCacheRequest implements ToCopyableBuilder<CreateCacheClusterRequest.Builder,CreateCacheClusterRequest>

Represents the input of a CreateCacheCluster operation.

  • Method Details

    • cacheClusterId

      public final String cacheClusterId()

      The node group (shard) identifier. This parameter is stored as a lowercase string.

      Constraints:

      • A name must contain from 1 to 50 alphanumeric characters or hyphens.

      • The first character must be a letter.

      • A name cannot end with a hyphen or contain two consecutive hyphens.

      Returns:
      The node group (shard) identifier. This parameter is stored as a lowercase string.

      Constraints:

      • A name must contain from 1 to 50 alphanumeric characters or hyphens.

      • The first character must be a letter.

      • A name cannot end with a hyphen or contain two consecutive hyphens.

    • replicationGroupId

      public final String replicationGroupId()

      The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

      If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

      This parameter is only valid if the Engine parameter is redis.

      Returns:
      The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

      If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

      This parameter is only valid if the Engine parameter is redis.

    • azMode

      public final AZMode azMode()

      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.

      If the service returns an enum value that is not available in the current SDK version, azMode will return AZMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

      Returns:
      Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

      This parameter is only supported for Memcached clusters.

      If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

      See Also:

    • azModeAsString

      public final String azModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, azMode will return AZMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

      Returns:
      Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

      This parameter is only supported for Memcached clusters.

      If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

      See Also:

    • preferredAvailabilityZone

      public final String preferredAvailabilityZone()

      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.

      Returns:
      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.

    • hasPreferredAvailabilityZones

      public final boolean hasPreferredAvailabilityZones()
      For responses, this returns true if the service returned a value for the PreferredAvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • preferredAvailabilityZones

      public final List<String> preferredAvailabilityZones()

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPreferredAvailabilityZones() method.

      Returns:
      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.

    • numCacheNodes

      public final Integer numCacheNodes()

      The initial number of cache nodes that the cluster has.

      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us /elasticache-node-limit-request/.

      Returns:
      The initial number of cache nodes that the cluster has.

      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon .com/contact-us/elasticache-node-limit-request/.

    • cacheNodeType

      public final String cacheNodeType()

      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:

          M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          For region availability, see Supported Node Types

          M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          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 (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          For region availability, see Supported Node Types

          R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          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

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

      • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

      • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

      Returns:
      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:

          M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          For region availability, see Supported Node Types

          M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

          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 (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation:

          R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          For region availability, see Supported Node Types

          R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

          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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

          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

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

      • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

      • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    • engine

      public final String engine()

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

      Valid values for this parameter are: memcached | redis

      Returns:
      The name of the cache engine to be used for this cluster.

      Valid values for this parameter are: memcached | redis

    • engineVersion

      public final String engineVersion()

      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), 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.

      Returns:
      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), 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.

    • cacheParameterGroupName

      public final String cacheParameterGroupName()

      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.

      Returns:
      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.

    • cacheSubnetGroupName

      public final String cacheSubnetGroupName()

      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 Subnets and Subnet Groups.

      Returns:
      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 Subnets and Subnet Groups.

    • hasCacheSecurityGroupNames

      public final boolean hasCacheSecurityGroupNames()
      For responses, this returns true if the service returned a value for the CacheSecurityGroupNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • cacheSecurityGroupNames

      public final List<String> cacheSecurityGroupNames()

      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).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCacheSecurityGroupNames() method.

      Returns:
      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).

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

      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).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      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).

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tags to be added to this resource.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags to be added to this resource.

    • hasSnapshotArns

      public final boolean hasSnapshotArns()
      For responses, this returns true if the service returned a value for the SnapshotArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • snapshotArns

      public final List<String> snapshotArns()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSnapshotArns() method.

      Returns:
      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. 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

    • snapshotName

      public final String snapshotName()

      The name of a Valkey or Redis OSS 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.

      Returns:
      The name of a Valkey or Redis OSS 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.

    • preferredMaintenanceWindow

      public final String preferredMaintenanceWindow()

      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.

      Returns:
      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.

    • port

      public final Integer port()

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

      Returns:
      The port number on which each of the cache nodes accepts connections.

    • notificationTopicArn

      public final String notificationTopicArn()

      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.

      Returns:
      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.

    • autoMinorVersionUpgrade

      public final Boolean autoMinorVersionUpgrade()

       If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

      Returns:
       If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    • snapshotRetentionLimit

      public final Integer snapshotRetentionLimit()

      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).

      Returns:
      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).

    • snapshotWindow

      public final String snapshotWindow()

      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.

      Returns:
      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.

    • authToken

      public final String authToken()

      Reserved parameter. The password used to access a password protected server.

      Password constraints:

      • Must be only printable ASCII characters.

      • Must be at least 16 characters and no more than 128 characters in length.

      • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

      For more information, see AUTH password at http://redis.io/commands/AUTH.

      Returns:
      Reserved parameter. The password used to access a password protected server.

      Password constraints:

      • Must be only printable ASCII characters.

      • Must be at least 16 characters and no more than 128 characters in length.

      • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

      For more information, see AUTH password at http://redis.io/commands/AUTH.

    • outpostMode

      public final OutpostMode outpostMode()

      Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

      If the service returns an enum value that is not available in the current SDK version, outpostMode will return OutpostMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outpostModeAsString().

      Returns:
      Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
      See Also:

    • outpostModeAsString

      public final String outpostModeAsString()

      Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

      If the service returns an enum value that is not available in the current SDK version, outpostMode will return OutpostMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outpostModeAsString().

      Returns:
      Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
      See Also:

    • preferredOutpostArn

      public final String preferredOutpostArn()

      The outpost ARN in which the cache cluster is created.

      Returns:
      The outpost ARN in which the cache cluster is created.

    • hasPreferredOutpostArns

      public final boolean hasPreferredOutpostArns()
      For responses, this returns true if the service returned a value for the PreferredOutpostArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • preferredOutpostArns

      public final List<String> preferredOutpostArns()

      The outpost ARNs in which the cache cluster is created.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPreferredOutpostArns() method.

      Returns:
      The outpost ARNs in which the cache cluster is created.

    • hasLogDeliveryConfigurations

      public final boolean hasLogDeliveryConfigurations()
      For responses, this returns true if the service returned a value for the LogDeliveryConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • logDeliveryConfigurations

      public final List<LogDeliveryConfigurationRequest> logDeliveryConfigurations()

      Specifies the destination, format and type of the logs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogDeliveryConfigurations() method.

      Returns:
      Specifies the destination, format and type of the logs.

    • transitEncryptionEnabled

      public final Boolean transitEncryptionEnabled()

      A flag that enables in-transit encryption when set to true.

      Returns:
      A flag that enables in-transit encryption when set to true.

    • networkType

      public final NetworkType networkType()

      Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
      See Also:

    • ipDiscovery

      public final IpDiscovery ipDiscovery()

      The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

      If the service returns an enum value that is not available in the current SDK version, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

      Returns:
      The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
      See Also:

    • ipDiscoveryAsString

      public final String ipDiscoveryAsString()

      The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

      If the service returns an enum value that is not available in the current SDK version, ipDiscovery will return IpDiscovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipDiscoveryAsString().

      Returns:
      The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
      See Also:

    • toBuilder

      public CreateCacheClusterRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateCacheClusterRequest.Builder,CreateCacheClusterRequest>
      Specified by:
      toBuilder in class ElastiCacheRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCacheClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCacheClusterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.