CfnClusterProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.memorydb.CfnClusterProps.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnClusterProps>

Enclosing interface:: CfnClusterProps

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

A builder for CfnClusterProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnClusterProps.Builder`	`aclName(String aclName)` Sets the value of `CfnClusterProps.getAclName()`
`CfnClusterProps.Builder`	`autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` Sets the value of `CfnClusterProps.getAutoMinorVersionUpgrade()`
`CfnClusterProps.Builder`	`autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)` Sets the value of `CfnClusterProps.getAutoMinorVersionUpgrade()`
`CfnClusterProps`	`build()` Builds the configured instance.
`CfnClusterProps.Builder`	`clusterName(String clusterName)` Sets the value of `CfnClusterProps.getClusterName()`
`CfnClusterProps.Builder`	`description(String description)` Sets the value of `CfnClusterProps.getDescription()`
`CfnClusterProps.Builder`	`engineVersion(String engineVersion)` Sets the value of `CfnClusterProps.getEngineVersion()`
`CfnClusterProps.Builder`	`finalSnapshotName(String finalSnapshotName)` Sets the value of `CfnClusterProps.getFinalSnapshotName()`
`CfnClusterProps.Builder`	`kmsKeyId(String kmsKeyId)` Sets the value of `CfnClusterProps.getKmsKeyId()`
`CfnClusterProps.Builder`	`maintenanceWindow(String maintenanceWindow)` Sets the value of `CfnClusterProps.getMaintenanceWindow()`
`CfnClusterProps.Builder`	`nodeType(String nodeType)` Sets the value of `CfnClusterProps.getNodeType()`
`CfnClusterProps.Builder`	`numReplicasPerShard(Number numReplicasPerShard)` Sets the value of `CfnClusterProps.getNumReplicasPerShard()`
`CfnClusterProps.Builder`	`numShards(Number numShards)` Sets the value of `CfnClusterProps.getNumShards()`
`CfnClusterProps.Builder`	`parameterGroupName(String parameterGroupName)` Sets the value of `CfnClusterProps.getParameterGroupName()`
`CfnClusterProps.Builder`	`port(Number port)` Sets the value of `CfnClusterProps.getPort()`
`CfnClusterProps.Builder`	`securityGroupIds(List<String> securityGroupIds)` Sets the value of `CfnClusterProps.getSecurityGroupIds()`
`CfnClusterProps.Builder`	`snapshotArns(List<String> snapshotArns)` Sets the value of `CfnClusterProps.getSnapshotArns()`
`CfnClusterProps.Builder`	`snapshotName(String snapshotName)` Sets the value of `CfnClusterProps.getSnapshotName()`
`CfnClusterProps.Builder`	`snapshotRetentionLimit(Number snapshotRetentionLimit)` Sets the value of `CfnClusterProps.getSnapshotRetentionLimit()`
`CfnClusterProps.Builder`	`snapshotWindow(String snapshotWindow)` Sets the value of `CfnClusterProps.getSnapshotWindow()`
`CfnClusterProps.Builder`	`snsTopicArn(String snsTopicArn)` Sets the value of `CfnClusterProps.getSnsTopicArn()`
`CfnClusterProps.Builder`	`snsTopicStatus(String snsTopicStatus)` Sets the value of `CfnClusterProps.getSnsTopicStatus()`
`CfnClusterProps.Builder`	`subnetGroupName(String subnetGroupName)` Sets the value of `CfnClusterProps.getSubnetGroupName()`
`CfnClusterProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnClusterProps.getTags()`
`CfnClusterProps.Builder`	`tlsEnabled(Boolean tlsEnabled)` Sets the value of `CfnClusterProps.getTlsEnabled()`
`CfnClusterProps.Builder`	`tlsEnabled(IResolvable tlsEnabled)` Sets the value of `CfnClusterProps.getTlsEnabled()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - aclName
```
@Stability(value=Stable)
public CfnClusterProps.Builder aclName(String aclName)
```
    Sets the value of CfnClusterProps.getAclName()
    
    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 CfnClusterProps.Builder clusterName(String clusterName)
```
    Sets the value of CfnClusterProps.getClusterName()
    
    Parameters:
    
    clusterName - The name of the cluster . This parameter is required.
    
    Returns:
    
    this
  - nodeType
```
@Stability(value=Stable)
public CfnClusterProps.Builder nodeType(String nodeType)
```
    Sets the value of CfnClusterProps.getNodeType()
    
    Parameters:
    
    nodeType - The cluster 's node type. This parameter is required.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
@Stability(value=Stable)
public CfnClusterProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    Sets the value of CfnClusterProps.getAutoMinorVersionUpgrade()
    
    Parameters:
    
    autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
@Stability(value=Stable)
public CfnClusterProps.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
```
    Sets the value of CfnClusterProps.getAutoMinorVersionUpgrade()
    
    Parameters:
    
    autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.
    
    Returns:
    
    this
  - description
```
@Stability(value=Stable)
public CfnClusterProps.Builder description(String description)
```
    Sets the value of CfnClusterProps.getDescription()
    
    Parameters:
    
    description - A description of the cluster .
    
    Returns:
    
    this
  - engineVersion
```
@Stability(value=Stable)
public CfnClusterProps.Builder engineVersion(String engineVersion)
```
    Sets the value of CfnClusterProps.getEngineVersion()
    
    Parameters:
    
    engineVersion - The Redis engine version used by the cluster .
    
    Returns:
    
    this
  - finalSnapshotName
```
@Stability(value=Stable)
public CfnClusterProps.Builder finalSnapshotName(String finalSnapshotName)
```
    Sets the value of CfnClusterProps.getFinalSnapshotName()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - kmsKeyId
```
@Stability(value=Stable)
public CfnClusterProps.Builder kmsKeyId(String kmsKeyId)
```
    Sets the value of CfnClusterProps.getKmsKeyId()
    
    Parameters:
    
    kmsKeyId - The ID of the KMS key used to encrypt the cluster .
    
    Returns:
    
    this
  - maintenanceWindow
```
@Stability(value=Stable)
public CfnClusterProps.Builder maintenanceWindow(String maintenanceWindow)
```
    Sets the value of CfnClusterProps.getMaintenanceWindow()
    
    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.
    Pattern : ddd:hh24:mi-ddd:hh24:mi
    
    Returns:
    
    this
  - numReplicasPerShard
```
@Stability(value=Stable)
public CfnClusterProps.Builder numReplicasPerShard(Number numReplicasPerShard)
```
    Sets the value of CfnClusterProps.getNumReplicasPerShard()
    
    Parameters:
    
    numReplicasPerShard - The number of replicas to apply to each shard. Default value : 1
    Maximum value : 5
    
    Returns:
    
    this
  - numShards
```
@Stability(value=Stable)
public CfnClusterProps.Builder numShards(Number numShards)
```
    Sets the value of CfnClusterProps.getNumShards()
    
    Parameters:
    
    numShards - The number of shards in the cluster .
    
    Returns:
    
    this
  - parameterGroupName
```
@Stability(value=Stable)
public CfnClusterProps.Builder parameterGroupName(String parameterGroupName)
```
    Sets the value of CfnClusterProps.getParameterGroupName()
    
    Parameters:
    
    parameterGroupName - The name of the parameter group used by the cluster .
    
    Returns:
    
    this
  - port
```
@Stability(value=Stable)
public CfnClusterProps.Builder port(Number port)
```
    Sets the value of CfnClusterProps.getPort()
    
    Parameters:
    
    port - The port used by the cluster .
    
    Returns:
    
    this
  - securityGroupIds
```
@Stability(value=Stable)
public CfnClusterProps.Builder securityGroupIds(List<String> securityGroupIds)
```
    Sets the value of CfnClusterProps.getSecurityGroupIds()
    
    Parameters:
    
    securityGroupIds - A list of security group names to associate with this cluster .
    
    Returns:
    
    this
  - snapshotArns
```
@Stability(value=Stable)
public CfnClusterProps.Builder snapshotArns(List<String> snapshotArns)
```
    Sets the value of CfnClusterProps.getSnapshotArns()
    
    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:
    
    this
  - snapshotName
```
@Stability(value=Stable)
public CfnClusterProps.Builder snapshotName(String snapshotName)
```
    Sets the value of CfnClusterProps.getSnapshotName()
    
    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:
    
    this
  - snapshotRetentionLimit
```
@Stability(value=Stable)
public CfnClusterProps.Builder snapshotRetentionLimit(Number snapshotRetentionLimit)
```
    Sets the value of CfnClusterProps.getSnapshotRetentionLimit()
    
    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:
    
    this
  - snapshotWindow
```
@Stability(value=Stable)
public CfnClusterProps.Builder snapshotWindow(String snapshotWindow)
```
    Sets the value of CfnClusterProps.getSnapshotWindow()
    
    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:
    
    this
  - snsTopicArn
```
@Stability(value=Stable)
public CfnClusterProps.Builder snsTopicArn(String snsTopicArn)
```
    Sets the value of CfnClusterProps.getSnsTopicArn()
    
    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`.
    
    Returns:
    
    this
  - snsTopicStatus
```
@Stability(value=Stable)
public CfnClusterProps.Builder snsTopicStatus(String snsTopicStatus)
```
    Sets the value of CfnClusterProps.getSnsTopicStatus()
    
    Parameters:
    
    snsTopicStatus - The SNS topic must be in Active status to receive notifications.
    
    Returns:
    
    this
  - subnetGroupName
```
@Stability(value=Stable)
public CfnClusterProps.Builder subnetGroupName(String subnetGroupName)
```
    Sets the value of CfnClusterProps.getSubnetGroupName()
    
    Parameters:
    
    subnetGroupName - The name of the subnet group used by the cluster .
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnClusterProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnClusterProps.getTags()
    
    Parameters:
    
    tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
    
    Returns:
    
    this
  - tlsEnabled
```
@Stability(value=Stable)
public CfnClusterProps.Builder tlsEnabled(Boolean tlsEnabled)
```
    Sets the value of CfnClusterProps.getTlsEnabled()
    
    Parameters:
    
    tlsEnabled - A flag to indicate if In-transit encryption is enabled.
    
    Returns:
    
    this
  - tlsEnabled
```
@Stability(value=Stable)
public CfnClusterProps.Builder tlsEnabled(IResolvable tlsEnabled)
```
    Sets the value of CfnClusterProps.getTlsEnabled()
    
    Parameters:
    
    tlsEnabled - A flag to indicate if In-transit encryption is enabled.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnClusterProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnClusterProps>
    
    Returns:
    
    a new instance of CfnClusterProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnClusterProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

aclName

clusterName

nodeType

autoMinorVersionUpgrade

autoMinorVersionUpgrade

description

engineVersion

finalSnapshotName

kmsKeyId

maintenanceWindow

numReplicasPerShard

numShards

parameterGroupName

port

securityGroupIds

snapshotArns

snapshotName

snapshotRetentionLimit

snapshotWindow

snsTopicArn

snsTopicStatus

subnetGroupName

tags

tlsEnabled

tlsEnabled

build