software.amazon.awscdk.services.memorydb

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.memorydb.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

@Stability(value=Stable)
public static final class CfnCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCluster>

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method and Description
CfnCluster.Builder	aclName(String aclName) The name of the Access Control List to associate with the cluster .
CfnCluster.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) When set to true, the cluster will automatically receive minor engine version upgrades after launch.
CfnCluster.Builder	autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade) When set to true, the cluster will automatically receive minor engine version upgrades after launch.
CfnCluster	build()
CfnCluster.Builder	clusterEndpoint(CfnCluster.EndpointProperty clusterEndpoint) The cluster 's configuration endpoint.
CfnCluster.Builder	clusterEndpoint(IResolvable clusterEndpoint) The cluster 's configuration endpoint.
CfnCluster.Builder	clusterName(String clusterName) The name of the cluster .
static CfnCluster.Builder	create(Construct scope, String id)
CfnCluster.Builder	dataTiering(String dataTiering) Enables data tiering.
CfnCluster.Builder	description(String description) A description of the cluster .
CfnCluster.Builder	engineVersion(String engineVersion) The Redis engine version used by the cluster .
CfnCluster.Builder	finalSnapshotName(String finalSnapshotName) The user-supplied name of a final cluster snapshot.
CfnCluster.Builder	kmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the cluster .
CfnCluster.Builder	maintenanceWindow(String maintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
CfnCluster.Builder	nodeType(String nodeType) The cluster 's node type.
CfnCluster.Builder	numReplicasPerShard(Number numReplicasPerShard) The number of replicas to apply to each shard.
CfnCluster.Builder	numShards(Number numShards) The number of shards in the cluster .
CfnCluster.Builder	parameterGroupName(String parameterGroupName) The name of the parameter group used by the cluster .
CfnCluster.Builder	port(Number port) The port used by the cluster .
CfnCluster.Builder	securityGroupIds(List<String> securityGroupIds) A list of security group names to associate with this cluster .
CfnCluster.Builder	snapshotArns(List<String> snapshotArns) A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
CfnCluster.Builder	snapshotName(String snapshotName) The name of a snapshot from which to restore data into the new cluster .
CfnCluster.Builder	snapshotRetentionLimit(Number snapshotRetentionLimit) The number of days for which MemoryDB retains automatic snapshots before deleting them.
CfnCluster.Builder	snapshotWindow(String snapshotWindow) The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
CfnCluster.Builder	snsTopicArn(String snsTopicArn) When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
CfnCluster.Builder	snsTopicStatus(String snsTopicStatus) The SNS topic must be in Active status to receive notifications.
CfnCluster.Builder	subnetGroupName(String subnetGroupName) The name of the subnet group used by the cluster .
CfnCluster.Builder	tags(List<? extends CfnTag> tags) An array of key-value pairs to apply to this resource.
CfnCluster.Builder	tlsEnabled(Boolean tlsEnabled) A flag to indicate if In-transit encryption is enabled.
CfnCluster.Builder	tlsEnabled(IResolvable tlsEnabled) A flag to indicate if In-transit encryption is enabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnCluster.Builder create(Construct scope,
                                                                 String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCluster.EndpointProperty.Builder.

aclName

@Stability(value=Stable)
public CfnCluster.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 . This parameter is required.

Returns:

this

clusterName

@Stability(value=Stable)
public CfnCluster.Builder clusterName(String clusterName)

The name of the cluster .

Parameters:

clusterName - The name of the cluster . This parameter is required.

Returns:

this

nodeType

@Stability(value=Stable)
public CfnCluster.Builder nodeType(String nodeType)

The cluster 's node type.

Parameters:

nodeType - The cluster 's node type. This parameter is required.

Returns:

this

autoMinorVersionUpgrade

@Stability(value=Stable)
public CfnCluster.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. This parameter is required.

Returns:

this

autoMinorVersionUpgrade

@Stability(value=Stable)
public CfnCluster.Builder autoMinorVersionUpgrade(IResolvable 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. This parameter is required.

Returns:

this

clusterEndpoint

@Stability(value=Stable)
public CfnCluster.Builder clusterEndpoint(IResolvable clusterEndpoint)

The cluster 's configuration endpoint.

Parameters:

clusterEndpoint - The cluster 's configuration endpoint. This parameter is required.

Returns:

this

clusterEndpoint

@Stability(value=Stable)
public CfnCluster.Builder clusterEndpoint(CfnCluster.EndpointProperty clusterEndpoint)

The cluster 's configuration endpoint.

Parameters:

clusterEndpoint - The cluster 's configuration endpoint. This parameter is required.

Returns:

this

dataTiering

@Stability(value=Stable)
public CfnCluster.Builder dataTiering(String dataTiering)

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 .

Parameters:

dataTiering - Enables data tiering. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnCluster.Builder description(String description)

A description of the cluster .

Parameters:

description - A description of the cluster . This parameter is required.

Returns:

this

engineVersion

@Stability(value=Stable)
public CfnCluster.Builder engineVersion(String engineVersion)

The Redis engine version used by the cluster .

Parameters:

engineVersion - The Redis engine version used by the cluster . This parameter is required.

Returns:

this

finalSnapshotName

@Stability(value=Stable)
public CfnCluster.Builder finalSnapshotName(String finalSnapshotName)

The user-supplied name of a final cluster snapshot.

This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

Parameters:

finalSnapshotName - The user-supplied name of a final cluster snapshot. This parameter is required.

Returns:

this

kmsKeyId

@Stability(value=Stable)
public CfnCluster.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 . This parameter is required.

Returns:

this

maintenanceWindow

@Stability(value=Stable)
public CfnCluster.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.

Pattern : ddd:hh24:mi-ddd:hh24:mi

Parameters:

maintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. This parameter is required.

Returns:

this

numReplicasPerShard

@Stability(value=Stable)
public CfnCluster.Builder numReplicasPerShard(Number numReplicasPerShard)

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

Parameters:

numReplicasPerShard - The number of replicas to apply to each shard. This parameter is required.

Returns:

this

numShards

@Stability(value=Stable)
public CfnCluster.Builder numShards(Number numShards)

The number of shards in the cluster .

Parameters:

numShards - The number of shards in the cluster . This parameter is required.

Returns:

this

parameterGroupName

@Stability(value=Stable)
public CfnCluster.Builder parameterGroupName(String parameterGroupName)

The name of the parameter group used by the cluster .

Parameters:

parameterGroupName - The name of the parameter group used by the cluster . This parameter is required.

Returns:

this

port

@Stability(value=Stable)
public CfnCluster.Builder port(Number port)

The port used by the cluster .

Parameters:

port - The port used by the cluster . This parameter is required.

Returns:

this

securityGroupIds

@Stability(value=Stable)
public CfnCluster.Builder securityGroupIds(List<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 . This parameter is required.

Returns:

this

snapshotArns

@Stability(value=Stable)
public CfnCluster.Builder snapshotArns(List<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. This parameter is required.

Returns:

this

snapshotName

@Stability(value=Stable)
public CfnCluster.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 . This parameter is required.

Returns:

this

snapshotRetentionLimit

@Stability(value=Stable)
public CfnCluster.Builder snapshotRetentionLimit(Number 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. This parameter is required.

Returns:

this

snapshotWindow

@Stability(value=Stable)
public CfnCluster.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. This parameter is required.

Returns:

this

snsTopicArn

@Stability(value=Stable)
public CfnCluster.Builder snsTopicArn(String snsTopicArn)

When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.

Parameters:

snsTopicArn - When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`. This parameter is required.

Returns:

this

snsTopicStatus

@Stability(value=Stable)
public CfnCluster.Builder snsTopicStatus(String snsTopicStatus)

The SNS topic must be in Active status to receive notifications.

Parameters:

snsTopicStatus - The SNS topic must be in Active status to receive notifications. This parameter is required.

Returns:

this

subnetGroupName

@Stability(value=Stable)
public CfnCluster.Builder subnetGroupName(String subnetGroupName)

The name of the subnet group used by the cluster .

Parameters:

subnetGroupName - The name of the subnet group used by the cluster . This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnCluster.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

tlsEnabled

@Stability(value=Stable)
public CfnCluster.Builder tlsEnabled(Boolean tlsEnabled)

A flag to indicate if In-transit encryption is enabled.

Parameters:

tlsEnabled - A flag to indicate if In-transit encryption is enabled. This parameter is required.

Returns:

this

tlsEnabled

@Stability(value=Stable)
public CfnCluster.Builder tlsEnabled(IResolvable tlsEnabled)

A flag to indicate if In-transit encryption is enabled.

Parameters:

tlsEnabled - A flag to indicate if In-transit encryption is enabled. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCluster>