software.amazon.awssdk.services.docdb.model

Interface DBCluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DBCluster.Builder,DBCluster>, SdkBuilder<DBCluster.Builder,DBCluster>, SdkPojo

Enclosing class:

DBCluster

public static interface DBCluster.Builder
extends SdkPojo, CopyableBuilder<DBCluster.Builder,DBCluster>

Method Summary

Modifier and Type	Method and Description
DBCluster.Builder	associatedRoles(Collection<DBClusterRole> associatedRoles) Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
DBCluster.Builder	associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles) Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
DBCluster.Builder	associatedRoles(DBClusterRole... associatedRoles) Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
DBCluster.Builder	availabilityZones(Collection<String> availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
DBCluster.Builder	availabilityZones(String... availabilityZones) Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
DBCluster.Builder	backupRetentionPeriod(Integer backupRetentionPeriod) Specifies the number of days for which automatic snapshots are retained.
DBCluster.Builder	clusterCreateTime(Instant clusterCreateTime) Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
DBCluster.Builder	dbClusterArn(String dbClusterArn) The Amazon Resource Name (ARN) for the cluster.
DBCluster.Builder	dbClusterIdentifier(String dbClusterIdentifier) Contains a user-supplied cluster identifier.
DBCluster.Builder	dbClusterMembers(Collection<DBClusterMember> dbClusterMembers) Provides the list of instances that make up the cluster.
DBCluster.Builder	dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers) Provides the list of instances that make up the cluster.
DBCluster.Builder	dbClusterMembers(DBClusterMember... dbClusterMembers) Provides the list of instances that make up the cluster.
DBCluster.Builder	dbClusterParameterGroup(String dbClusterParameterGroup) Specifies the name of the cluster parameter group for the cluster.
DBCluster.Builder	dbClusterResourceId(String dbClusterResourceId) The Region-unique, immutable identifier for the cluster.
DBCluster.Builder	dbSubnetGroup(String dbSubnetGroup) Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
DBCluster.Builder	deletionProtection(Boolean deletionProtection) Specifies whether this cluster can be deleted.
DBCluster.Builder	earliestRestorableTime(Instant earliestRestorableTime) The earliest time to which a database can be restored with point-in-time restore.
DBCluster.Builder	enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports) A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DBCluster.Builder	enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports) A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DBCluster.Builder	endpoint(String endpoint) Specifies the connection endpoint for the primary instance of the cluster.
DBCluster.Builder	engine(String engine) Provides the name of the database engine to be used for this cluster.
DBCluster.Builder	engineVersion(String engineVersion) Indicates the database engine version.
DBCluster.Builder	hostedZoneId(String hostedZoneId) Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
DBCluster.Builder	kmsKeyId(String kmsKeyId) If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DBCluster.Builder	latestRestorableTime(Instant latestRestorableTime) Specifies the latest time to which a database can be restored with point-in-time restore.
DBCluster.Builder	masterUsername(String masterUsername) Contains the master user name for the cluster.
DBCluster.Builder	multiAZ(Boolean multiAZ) Specifies whether the cluster has instances in multiple Availability Zones.
DBCluster.Builder	percentProgress(String percentProgress) Specifies the progress of the operation as a percentage.
DBCluster.Builder	port(Integer port) Specifies the port that the database engine is listening on.
DBCluster.Builder	preferredBackupWindow(String preferredBackupWindow) Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
DBCluster.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
DBCluster.Builder	readerEndpoint(String readerEndpoint) The reader endpoint for the cluster.
DBCluster.Builder	readReplicaIdentifiers(Collection<String> readReplicaIdentifiers) Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBCluster.Builder	readReplicaIdentifiers(String... readReplicaIdentifiers) Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBCluster.Builder	replicationSourceIdentifier(String replicationSourceIdentifier) Contains the identifier of the source cluster if this cluster is a secondary cluster.
DBCluster.Builder	status(String status) Specifies the current state of this cluster.
DBCluster.Builder	storageEncrypted(Boolean storageEncrypted) Specifies whether the cluster is encrypted.
DBCluster.Builder	vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups) Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
DBCluster.Builder	vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups) Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
DBCluster.Builder	vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups) Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

availabilityZones

DBCluster.Builder availabilityZones(Collection<String> availabilityZones)

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Parameters:

availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Returns:

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

availabilityZones

DBCluster.Builder availabilityZones(String... availabilityZones)

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Parameters:

availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Returns:

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

backupRetentionPeriod

DBCluster.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

Specifies the number of days for which automatic snapshots are retained.

Parameters:

backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

Returns:

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

dbClusterIdentifier

DBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Parameters:

dbClusterIdentifier - Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Returns:

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

dbClusterParameterGroup

DBCluster.Builder dbClusterParameterGroup(String dbClusterParameterGroup)

Specifies the name of the cluster parameter group for the cluster.

Parameters:

dbClusterParameterGroup - Specifies the name of the cluster parameter group for the cluster.

Returns:

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

dbSubnetGroup

DBCluster.Builder dbSubnetGroup(String dbSubnetGroup)

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

Parameters:

dbSubnetGroup - Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

Returns:

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

status

DBCluster.Builder status(String status)

Specifies the current state of this cluster.

Parameters:

status - Specifies the current state of this cluster.

Returns:

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

percentProgress

DBCluster.Builder percentProgress(String percentProgress)

Specifies the progress of the operation as a percentage.

Parameters:

percentProgress - Specifies the progress of the operation as a percentage.

Returns:

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

earliestRestorableTime

DBCluster.Builder earliestRestorableTime(Instant earliestRestorableTime)

The earliest time to which a database can be restored with point-in-time restore.

Parameters:

earliestRestorableTime - The earliest time to which a database can be restored with point-in-time restore.

Returns:

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

endpoint

DBCluster.Builder endpoint(String endpoint)

Specifies the connection endpoint for the primary instance of the cluster.

Parameters:

endpoint - Specifies the connection endpoint for the primary instance of the cluster.

Returns:

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

readerEndpoint

DBCluster.Builder readerEndpoint(String readerEndpoint)

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

Parameters:

readerEndpoint - The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

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

multiAZ

DBCluster.Builder multiAZ(Boolean multiAZ)

Specifies whether the cluster has instances in multiple Availability Zones.

Parameters:

multiAZ - Specifies whether the cluster has instances in multiple Availability Zones.

Returns:

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

engine

DBCluster.Builder engine(String engine)

Provides the name of the database engine to be used for this cluster.

Parameters:

engine - Provides the name of the database engine to be used for this cluster.

Returns:

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

engineVersion

DBCluster.Builder engineVersion(String engineVersion)

Indicates the database engine version.

Parameters:

engineVersion - Indicates the database engine version.

Returns:

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

latestRestorableTime

DBCluster.Builder latestRestorableTime(Instant latestRestorableTime)

Specifies the latest time to which a database can be restored with point-in-time restore.

Parameters:

latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

Returns:

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

port

DBCluster.Builder port(Integer port)

Specifies the port that the database engine is listening on.

Parameters:

port - Specifies the port that the database engine is listening on.

Returns:

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

masterUsername

DBCluster.Builder masterUsername(String masterUsername)

Contains the master user name for the cluster.

Parameters:

masterUsername - Contains the master user name for the cluster.

Returns:

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

preferredBackupWindow

DBCluster.Builder preferredBackupWindow(String preferredBackupWindow)

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Parameters:

preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

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

preferredMaintenanceWindow

DBCluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

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

replicationSourceIdentifier

DBCluster.Builder replicationSourceIdentifier(String replicationSourceIdentifier)

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Parameters:

replicationSourceIdentifier - Contains the identifier of the source cluster if this cluster is a secondary cluster.

Returns:

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

readReplicaIdentifiers

DBCluster.Builder readReplicaIdentifiers(Collection<String> readReplicaIdentifiers)

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Parameters:

readReplicaIdentifiers - Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Returns:

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

readReplicaIdentifiers

DBCluster.Builder readReplicaIdentifiers(String... readReplicaIdentifiers)

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Parameters:

readReplicaIdentifiers - Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Returns:

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

dbClusterMembers

DBCluster.Builder dbClusterMembers(Collection<DBClusterMember> dbClusterMembers)

Provides the list of instances that make up the cluster.

Parameters:

dbClusterMembers - Provides the list of instances that make up the cluster.

Returns:

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

dbClusterMembers

DBCluster.Builder dbClusterMembers(DBClusterMember... dbClusterMembers)

Provides the list of instances that make up the cluster.

Parameters:

dbClusterMembers - Provides the list of instances that make up the cluster.

Returns:

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

dbClusterMembers

DBCluster.Builder dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)

Provides the list of instances that make up the cluster.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #dbClusterMembers(List).

Parameters:

dbClusterMembers - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#dbClusterMembers(List)

vpcSecurityGroups

DBCluster.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Parameters:

vpcSecurityGroups - Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Returns:

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

vpcSecurityGroups

DBCluster.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Parameters:

vpcSecurityGroups - Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Returns:

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

vpcSecurityGroups

DBCluster.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #vpcSecurityGroups(List).

Parameters:

vpcSecurityGroups - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#vpcSecurityGroups(List)

hostedZoneId

DBCluster.Builder hostedZoneId(String hostedZoneId)

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Parameters:

hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

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

storageEncrypted

DBCluster.Builder storageEncrypted(Boolean storageEncrypted)

Specifies whether the cluster is encrypted.

Parameters:

storageEncrypted - Specifies whether the cluster is encrypted.

Returns:

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

kmsKeyId

DBCluster.Builder kmsKeyId(String kmsKeyId)

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

Parameters:

kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

Returns:

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

dbClusterResourceId

DBCluster.Builder dbClusterResourceId(String dbClusterResourceId)

The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

Parameters:

dbClusterResourceId - The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

Returns:

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

dbClusterArn

DBCluster.Builder dbClusterArn(String dbClusterArn)

The Amazon Resource Name (ARN) for the cluster.

Parameters:

dbClusterArn - The Amazon Resource Name (ARN) for the cluster.

Returns:

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

associatedRoles

DBCluster.Builder associatedRoles(Collection<DBClusterRole> associatedRoles)

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Parameters:

associatedRoles - Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Returns:

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

associatedRoles

DBCluster.Builder associatedRoles(DBClusterRole... associatedRoles)

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Parameters:

associatedRoles - Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

Returns:

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

associatedRoles

DBCluster.Builder associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles)

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #associatedRoles(List).

Parameters:

associatedRoles - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#associatedRoles(List)

clusterCreateTime

DBCluster.Builder clusterCreateTime(Instant clusterCreateTime)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

Parameters:

clusterCreateTime - Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

Returns:

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

enabledCloudwatchLogsExports

DBCluster.Builder enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Parameters:

enabledCloudwatchLogsExports - A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Returns:

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

enabledCloudwatchLogsExports

DBCluster.Builder enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Parameters:

enabledCloudwatchLogsExports - A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Returns:

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

deletionProtection

DBCluster.Builder deletionProtection(Boolean deletionProtection)

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Parameters:

deletionProtection - Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Returns:

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