Package software.amazon.awscdk.services.rds

Class DatabaseClusterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.rds.DatabaseClusterAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseClusterAttributes>

Enclosing interface:

DatabaseClusterAttributes

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

A builder for DatabaseClusterAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DatabaseClusterAttributes	build()	Builds the configured instance.
DatabaseClusterAttributes.Builder	clusterEndpointAddress(String clusterEndpointAddress)	Sets the value of DatabaseClusterAttributes.getClusterEndpointAddress()
DatabaseClusterAttributes.Builder	clusterIdentifier(String clusterIdentifier)	Sets the value of DatabaseClusterAttributes.getClusterIdentifier()
DatabaseClusterAttributes.Builder	clusterResourceIdentifier(String clusterResourceIdentifier)	Sets the value of DatabaseClusterAttributes.getClusterResourceIdentifier()
DatabaseClusterAttributes.Builder	dataApiEnabled(Boolean dataApiEnabled)	Sets the value of DatabaseClusterAttributes.getDataApiEnabled()
DatabaseClusterAttributes.Builder	engine(IClusterEngine engine)	Sets the value of DatabaseClusterAttributes.getEngine()
DatabaseClusterAttributes.Builder	instanceEndpointAddresses(List<String> instanceEndpointAddresses)	Sets the value of DatabaseClusterAttributes.getInstanceEndpointAddresses()
DatabaseClusterAttributes.Builder	instanceIdentifiers(List<String> instanceIdentifiers)	Sets the value of DatabaseClusterAttributes.getInstanceIdentifiers()
DatabaseClusterAttributes.Builder	port(Number port)	Sets the value of DatabaseClusterAttributes.getPort()
DatabaseClusterAttributes.Builder	readerEndpointAddress(String readerEndpointAddress)	Sets the value of DatabaseClusterAttributes.getReaderEndpointAddress()
DatabaseClusterAttributes.Builder	secret(ISecret secret)	Sets the value of DatabaseClusterAttributes.getSecret()
DatabaseClusterAttributes.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of DatabaseClusterAttributes.getSecurityGroups()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

clusterIdentifier

@Stability(Stable)
public DatabaseClusterAttributes.Builder clusterIdentifier(String clusterIdentifier)

Sets the value of DatabaseClusterAttributes.getClusterIdentifier()

Parameters:

clusterIdentifier - Identifier for the cluster. This parameter is required.

Returns:

this

clusterEndpointAddress

@Stability(Stable)
public DatabaseClusterAttributes.Builder clusterEndpointAddress(String clusterEndpointAddress)

Sets the value of DatabaseClusterAttributes.getClusterEndpointAddress()

Parameters:

clusterEndpointAddress - Cluster endpoint address.

Returns:

this

clusterResourceIdentifier

@Stability(Stable)
public DatabaseClusterAttributes.Builder clusterResourceIdentifier(String clusterResourceIdentifier)

Sets the value of DatabaseClusterAttributes.getClusterResourceIdentifier()

Parameters:

clusterResourceIdentifier - The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. This AWS Region-unique identifier is used to grant access to the cluster.

Returns:

this

dataApiEnabled

@Stability(Stable)
public DatabaseClusterAttributes.Builder dataApiEnabled(Boolean dataApiEnabled)

Sets the value of DatabaseClusterAttributes.getDataApiEnabled()

Parameters:

dataApiEnabled - Whether the Data API for the cluster is enabled.

Returns:

this

engine

@Stability(Stable)
public DatabaseClusterAttributes.Builder engine(IClusterEngine engine)

Sets the value of DatabaseClusterAttributes.getEngine()

Parameters:

engine - The engine of the existing Cluster.

Returns:

this

instanceEndpointAddresses

@Stability(Stable)
public DatabaseClusterAttributes.Builder instanceEndpointAddresses(List<String> instanceEndpointAddresses)

Sets the value of DatabaseClusterAttributes.getInstanceEndpointAddresses()

Parameters:

instanceEndpointAddresses - Endpoint addresses of individual instances.

Returns:

this

instanceIdentifiers

@Stability(Stable)
public DatabaseClusterAttributes.Builder instanceIdentifiers(List<String> instanceIdentifiers)

Sets the value of DatabaseClusterAttributes.getInstanceIdentifiers()

Parameters:

instanceIdentifiers - Identifier for the instances.

Returns:

this

port

@Stability(Stable)
public DatabaseClusterAttributes.Builder port(Number port)

Sets the value of DatabaseClusterAttributes.getPort()

Parameters:

port - The database port.

Returns:

this

readerEndpointAddress

@Stability(Stable)
public DatabaseClusterAttributes.Builder readerEndpointAddress(String readerEndpointAddress)

Sets the value of DatabaseClusterAttributes.getReaderEndpointAddress()

Parameters:

readerEndpointAddress - Reader endpoint address.

Returns:

this

secret

@Stability(Stable)
public DatabaseClusterAttributes.Builder secret(ISecret secret)

Sets the value of DatabaseClusterAttributes.getSecret()

Parameters:

secret - The secret attached to the database cluster.

Returns:

this

securityGroups

@Stability(Stable)
public DatabaseClusterAttributes.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of DatabaseClusterAttributes.getSecurityGroups()

Parameters:

securityGroups - The security groups of the database cluster.

Returns:

this

build

@Stability(Stable)
public DatabaseClusterAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseClusterAttributes

Throws:

NullPointerException - if any required attribute was not provided