Package software.amazon.awssdk.services.memorydb.model

Interface CreateClusterRequest.Builder

    • Method Detail

      • clusterName

        CreateClusterRequest.Builder clusterName​(String clusterName)

        The name of the cluster. This value must be unique as it also serves as the cluster identifier.

        Parameters:
        clusterName - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nodeType

        CreateClusterRequest.Builder nodeType​(String nodeType)

        The compute and memory capacity of the nodes in the cluster.

        Parameters:
        nodeType - The compute and memory capacity of the nodes in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiRegionClusterName

        CreateClusterRequest.Builder multiRegionClusterName​(String multiRegionClusterName)

        The name of the multi-Region cluster to be created.

        Parameters:
        multiRegionClusterName - The name of the multi-Region cluster to be created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameterGroupName

        CreateClusterRequest.Builder parameterGroupName​(String parameterGroupName)

        The name of the parameter group associated with the cluster.

        Parameters:
        parameterGroupName - The name of the parameter group associated with the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateClusterRequest.Builder description​(String description)

        An optional description of the cluster.

        Parameters:
        description - An optional description of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numShards

        CreateClusterRequest.Builder numShards​(Integer numShards)

        The number of shards the cluster will contain. The default value is 1.

        Parameters:
        numShards - The number of shards the cluster will contain. The default value is 1.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • numReplicasPerShard

        CreateClusterRequest.Builder numReplicasPerShard​(Integer numReplicasPerShard)

        The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

        Parameters:
        numReplicasPerShard - The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetGroupName

        CreateClusterRequest.Builder subnetGroupName​(String subnetGroupName)

        The name of the subnet group to be used for the cluster.

        Parameters:
        subnetGroupName - The name of the subnet group to be used for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        CreateClusterRequest.Builder securityGroupIds​(Collection<String> securityGroupIds)

        A list of security group names to associate with this cluster.

        Parameters:
        securityGroupIds - A list of security group names to associate with this cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroupIds

        CreateClusterRequest.Builder securityGroupIds​(String... securityGroupIds)

        A list of security group names to associate with this cluster.

        Parameters:
        securityGroupIds - A list of security group names to associate with this cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maintenanceWindow

        CreateClusterRequest.Builder maintenanceWindow​(String maintenanceWindow)

        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

        Parameters:
        maintenanceWindow - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        CreateClusterRequest.Builder port​(Integer port)

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

        Parameters:
        port - The port number on which each of the nodes accepts connections.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snsTopicArn

        CreateClusterRequest.Builder snsTopicArn​(String snsTopicArn)

        The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

        Parameters:
        snsTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tlsEnabled

        CreateClusterRequest.Builder tlsEnabled​(Boolean tlsEnabled)

        A flag to enable in-transit encryption on the cluster.

        Parameters:
        tlsEnabled - A flag to enable in-transit encryption on the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        CreateClusterRequest.Builder kmsKeyId​(String kmsKeyId)

        The ID of the KMS key used to encrypt the cluster.

        Parameters:
        kmsKeyId - The ID of the KMS key used to encrypt the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotArns

        CreateClusterRequest.Builder snapshotArns​(Collection<String> snapshotArns)

        A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

        Parameters:
        snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotArns

        CreateClusterRequest.Builder snapshotArns​(String... snapshotArns)

        A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

        Parameters:
        snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotName

        CreateClusterRequest.Builder snapshotName​(String snapshotName)

        The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

        Parameters:
        snapshotName - The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotRetentionLimit

        CreateClusterRequest.Builder snapshotRetentionLimit​(Integer snapshotRetentionLimit)

        The number of days for which MemoryDB 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.

        Parameters:
        snapshotRetentionLimit - The number of days for which MemoryDB 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Collection<Tag> tags)

        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.

        Parameters:
        tags - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Tag... tags)

        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.

        Parameters:
        tags - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateClusterRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • snapshotWindow

        CreateClusterRequest.Builder snapshotWindow​(String snapshotWindow)

        The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

        Example: 05:00-09:00

        If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        Parameters:
        snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

        Example: 05:00-09:00

        If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aclName

        CreateClusterRequest.Builder aclName​(String aclName)

        The name of the Access Control List to associate with the cluster.

        Parameters:
        aclName - The name of the Access Control List to associate with the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        CreateClusterRequest.Builder engine​(String engine)

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

        Parameters:
        engine - The name of the engine to be used for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        CreateClusterRequest.Builder engineVersion​(String engineVersion)

        The version number of the Redis OSS engine to be used for the cluster.

        Parameters:
        engineVersion - The version number of the Redis OSS engine to be used for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        CreateClusterRequest.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        When set to true, the cluster will automatically receive minor engine version upgrades after launch.

        Parameters:
        autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataTiering

        CreateClusterRequest.Builder dataTiering​(Boolean dataTiering)

        Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

        Parameters:
        dataTiering - Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
        Returns:
        Returns a reference to this object so that method calls can be chained together.