DatabaseClusterProps.Builder (software.amazon.awscdk:monocdk 1.95.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.awscdk.services.neptune.DatabaseClusterProps.Builder

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

Enclosing interface:: DatabaseClusterProps

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

A builder for DatabaseClusterProps

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
`DatabaseClusterProps.Builder`	`associatedRoles(List<? extends IRole> associatedRoles)` Sets the value of `DatabaseClusterProps.getAssociatedRoles()`
`DatabaseClusterProps.Builder`	`backupRetention(Duration backupRetention)` Sets the value of `DatabaseClusterProps.getBackupRetention()`
`DatabaseClusterProps`	`build()` Builds the configured instance.
`DatabaseClusterProps.Builder`	`clusterParameterGroup(IClusterParameterGroup clusterParameterGroup)` Sets the value of `DatabaseClusterProps.getClusterParameterGroup()`
`DatabaseClusterProps.Builder`	`dbClusterName(String dbClusterName)` Sets the value of `DatabaseClusterProps.getDbClusterName()`
`DatabaseClusterProps.Builder`	`deletionProtection(Boolean deletionProtection)` Sets the value of `DatabaseClusterProps.getDeletionProtection()`
`DatabaseClusterProps.Builder`	`engineVersion(EngineVersion engineVersion)` Sets the value of `DatabaseClusterProps.getEngineVersion()`
`DatabaseClusterProps.Builder`	`iamAuthentication(Boolean iamAuthentication)` Sets the value of `DatabaseClusterProps.getIamAuthentication()`
`DatabaseClusterProps.Builder`	`instanceIdentifierBase(String instanceIdentifierBase)` Sets the value of `DatabaseClusterProps.getInstanceIdentifierBase()`
`DatabaseClusterProps.Builder`	`instances(Number instances)` Sets the value of `DatabaseClusterProps.getInstances()`
`DatabaseClusterProps.Builder`	`instanceType(InstanceType instanceType)` Sets the value of `DatabaseClusterProps.getInstanceType()`
`DatabaseClusterProps.Builder`	`kmsKey(IKey kmsKey)` Sets the value of `DatabaseClusterProps.getKmsKey()`
`DatabaseClusterProps.Builder`	`parameterGroup(IParameterGroup parameterGroup)` Sets the value of `DatabaseClusterProps.getParameterGroup()`
`DatabaseClusterProps.Builder`	`port(Number port)` Sets the value of `DatabaseClusterProps.getPort()`
`DatabaseClusterProps.Builder`	`preferredBackupWindow(String preferredBackupWindow)` Sets the value of `DatabaseClusterProps.getPreferredBackupWindow()`
`DatabaseClusterProps.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` Sets the value of `DatabaseClusterProps.getPreferredMaintenanceWindow()`
`DatabaseClusterProps.Builder`	`removalPolicy(RemovalPolicy removalPolicy)` Sets the value of `DatabaseClusterProps.getRemovalPolicy()`
`DatabaseClusterProps.Builder`	`securityGroups(List<? extends ISecurityGroup> securityGroups)` Sets the value of `DatabaseClusterProps.getSecurityGroups()`
`DatabaseClusterProps.Builder`	`storageEncrypted(Boolean storageEncrypted)` Sets the value of `DatabaseClusterProps.getStorageEncrypted()`
`DatabaseClusterProps.Builder`	`subnetGroup(ISubnetGroup subnetGroup)` Sets the value of `DatabaseClusterProps.getSubnetGroup()`
`DatabaseClusterProps.Builder`	`vpc(IVpc vpc)` Sets the value of `DatabaseClusterProps.getVpc()`
`DatabaseClusterProps.Builder`	`vpcSubnets(SubnetSelection vpcSubnets)` Sets the value of `DatabaseClusterProps.getVpcSubnets()`

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
  - instanceType
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder instanceType(InstanceType instanceType)
```
    Sets the value of DatabaseClusterProps.getInstanceType()
    
    Parameters:
    
    instanceType - What type of instance to start for the replicas. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder vpc(IVpc vpc)
```
    Sets the value of DatabaseClusterProps.getVpc()
    
    Parameters:
    
    vpc - What subnets to run the Neptune instances in. This parameter is required. Must be at least 2 subnets in two different AZs.
    
    Returns:
    
    this
  - associatedRoles
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder associatedRoles(List<? extends IRole> associatedRoles)
```
    Sets the value of DatabaseClusterProps.getAssociatedRoles()
    
    Parameters:
    
    associatedRoles - A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
    
    Returns:
    
    this
  - backupRetention
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder backupRetention(Duration backupRetention)
```
    Sets the value of DatabaseClusterProps.getBackupRetention()
    
    Parameters:
    
    backupRetention - How many days to retain the backup.
    
    Returns:
    
    this
  - clusterParameterGroup
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder clusterParameterGroup(IClusterParameterGroup clusterParameterGroup)
```
    Sets the value of DatabaseClusterProps.getClusterParameterGroup()
    
    Parameters:
    
    clusterParameterGroup - Additional parameters to pass to the database engine.
    
    Returns:
    
    this
  - dbClusterName
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder dbClusterName(String dbClusterName)
```
    Sets the value of DatabaseClusterProps.getDbClusterName()
    
    Parameters:
    
    dbClusterName - An optional identifier for the cluster.
    
    Returns:
    
    this
  - deletionProtection
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder deletionProtection(Boolean deletionProtection)
```
    Sets the value of DatabaseClusterProps.getDeletionProtection()
    
    Parameters:
    
    deletionProtection - Indicates whether the DB cluster should have deletion protection enabled.
    
    Returns:
    
    this
  - engineVersion
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder engineVersion(EngineVersion engineVersion)
```
    Sets the value of DatabaseClusterProps.getEngineVersion()
    
    Parameters:
    
    engineVersion - What version of the database to start.
    
    Returns:
    
    this
  - iamAuthentication
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder iamAuthentication(Boolean iamAuthentication)
```
    Sets the value of DatabaseClusterProps.getIamAuthentication()
    
    Parameters:
    
    iamAuthentication - Map AWS Identity and Access Management (IAM) accounts to database accounts.
    
    Returns:
    
    this
  - instanceIdentifierBase
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder instanceIdentifierBase(String instanceIdentifierBase)
```
    Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()
    
    Parameters:
    
    instanceIdentifierBase - Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based.
    
    Returns:
    
    this
  - instances
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder instances(Number instances)
```
    Sets the value of DatabaseClusterProps.getInstances()
    
    Parameters:
    
    instances - Number of Neptune compute instances.
    
    Returns:
    
    this
  - kmsKey
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder kmsKey(IKey kmsKey)
```
    Sets the value of DatabaseClusterProps.getKmsKey()
    
    Parameters:
    
    kmsKey - The KMS key for storage encryption.
    
    Returns:
    
    this
  - parameterGroup
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder parameterGroup(IParameterGroup parameterGroup)
```
    Sets the value of DatabaseClusterProps.getParameterGroup()
    
    Parameters:
    
    parameterGroup - The DB parameter group to associate with the instance.
    
    Returns:
    
    this
  - port
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder port(Number port)
```
    Sets the value of DatabaseClusterProps.getPort()
    
    Parameters:
    
    port - The port the Neptune cluster will listen on.
    
    Returns:
    
    this
  - preferredBackupWindow
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)
```
    Sets the value of DatabaseClusterProps.getPreferredBackupWindow()
    
    Parameters:
    
    preferredBackupWindow - A daily time range in 24-hours UTC format in which backups preferably execute. Must be at least 30 minutes long.
    Example: '01:00-02:00'
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()
    
    Parameters:
    
    preferredMaintenanceWindow - A weekly time range in which maintenance should preferably execute. Must be at least 30 minutes long.
    Example: 'tue:04:17-tue:04:47'
    
    Returns:
    
    this
  - removalPolicy
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder removalPolicy(RemovalPolicy removalPolicy)
```
    Sets the value of DatabaseClusterProps.getRemovalPolicy()
    
    Parameters:
    
    removalPolicy - The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted. This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.
    
    Returns:
    
    this
  - securityGroups
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
```
    Sets the value of DatabaseClusterProps.getSecurityGroups()
    
    Parameters:
    
    securityGroups - Security group.
    
    Returns:
    
    this
  - storageEncrypted
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder storageEncrypted(Boolean storageEncrypted)
```
    Sets the value of DatabaseClusterProps.getStorageEncrypted()
    
    Parameters:
    
    storageEncrypted - Whether to enable storage encryption.
    
    Returns:
    
    this
  - subnetGroup
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder subnetGroup(ISubnetGroup subnetGroup)
```
    Sets the value of DatabaseClusterProps.getSubnetGroup()
    
    Parameters:
    
    subnetGroup - Existing subnet group for the cluster.
    
    Returns:
    
    this
  - vpcSubnets
```
@Stability(value=Experimental)
public DatabaseClusterProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
```
    Sets the value of DatabaseClusterProps.getVpcSubnets()
    
    Parameters:
    
    vpcSubnets - Where to place the instances within the VPC.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public DatabaseClusterProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<DatabaseClusterProps>
    
    Returns:
    
    a new instance of DatabaseClusterProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class DatabaseClusterProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

instanceType

vpc

associatedRoles

backupRetention

clusterParameterGroup

dbClusterName

deletionProtection

engineVersion

iamAuthentication

instanceIdentifierBase

instances

kmsKey

parameterGroup

port

preferredBackupWindow

preferredMaintenanceWindow

removalPolicy

securityGroups

storageEncrypted

subnetGroup

vpcSubnets

build