public static interface DBCluster.Builder extends CopyableBuilder<DBCluster.Builder,DBCluster>
Modifier and Type | Method and Description |
---|---|
DBCluster.Builder |
allocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage
size in gigabytes (GB). |
DBCluster.Builder |
associatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
associatedRoles(DBClusterRole... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
availabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
DBCluster.Builder |
availabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
DBCluster.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
|
DBCluster.Builder |
characterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster.Builder |
cloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
DBCluster.Builder |
clusterCreateTime(Instant clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster.Builder |
databaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
DBCluster.Builder |
dbClusterArn(String dbClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
Contains a user-supplied DB cluster identifier.
|
DBCluster.Builder |
dbClusterMembers(Collection<DBClusterMember> dbClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterMembers(DBClusterMember... dbClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterParameterGroup(String dbClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
|
DBCluster.Builder |
dbClusterResourceId(String dbClusterResourceId)
The AWS Region-unique, immutable identifier for the DB cluster.
|
DBCluster.Builder |
dbSubnetGroup(String dbSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.
|
DBCluster.Builder |
earliestRestorableTime(Instant earliestRestorableTime)
Specifies the earliest time to which a database can be restored with point-in-time restore.
|
DBCluster.Builder |
endpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
|
DBCluster.Builder |
engine(String engine)
Provides the name of the database engine to be used for this DB 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 |
iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
otherwise false.
|
DBCluster.Builder |
kmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB 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 username for the DB cluster.
|
DBCluster.Builder |
multiAZ(Boolean multiAZ)
Specifies whether the DB 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 DB cluster.
|
DBCluster.Builder |
readReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
DBCluster.Builder |
readReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
DBCluster.Builder |
replicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
|
DBCluster.Builder |
status(String status)
Specifies the current state of this DB cluster.
|
DBCluster.Builder |
storageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
DBCluster.Builder |
vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
copy
applyMutation, build
DBCluster.Builder allocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage
size in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster
storage size is not fixed, but instead automatically adjusts as needed.
allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated
storage size in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because
Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.DBCluster.Builder availabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.DBCluster.Builder availabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.DBCluster.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.DBCluster.Builder characterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.DBCluster.Builder databaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
databaseName
- Contains the name of the initial database of this DB cluster that was provided at create time, if one
was specified when the DB cluster was created. This same name is returned for the life of the DB
cluster.DBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
dbClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB
cluster.DBCluster.Builder dbClusterParameterGroup(String dbClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
dbClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.DBCluster.Builder dbSubnetGroup(String dbSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dbSubnetGroup
- Specifies information on the subnet group associated with the DB cluster, including the name,
description, and subnets in the subnet group.DBCluster.Builder status(String status)
Specifies the current state of this DB cluster.
status
- Specifies the current state of this DB cluster.DBCluster.Builder percentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
percentProgress
- Specifies the progress of the operation as a percentage.DBCluster.Builder earliestRestorableTime(Instant earliestRestorableTime)
Specifies the earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- Specifies the earliest time to which a database can be restored with point-in-time restore.DBCluster.Builder endpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the DB cluster.DBCluster.Builder readerEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections
across the Aurora Replicas that are available in a DB cluster. As clients request new connections to
the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB
cluster. This functionality can help balance your read workload across multiple Aurora Replicas in
your DB cluster.
If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
DBCluster.Builder multiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the DB cluster has instances in multiple Availability Zones.DBCluster.Builder engine(String engine)
Provides the name of the database engine to be used for this DB cluster.
engine
- Provides the name of the database engine to be used for this DB cluster.DBCluster.Builder engineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.DBCluster.Builder latestRestorableTime(Instant latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.DBCluster.Builder port(Integer port)
Specifies the port that the database engine is listening on.
port
- Specifies the port that the database engine is listening on.DBCluster.Builder masterUsername(String masterUsername)
Contains the master username for the DB cluster.
masterUsername
- Contains the master username for the DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dbClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dbClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
This is a convenience that creates an instance of theList.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 #dbClusterOptionGroupMemberships(List)
.dbClusterOptionGroupMemberships
- a consumer that will call methods on List.Builder
#dbClusterOptionGroupMemberships(List)
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
.
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).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated
Time (UTC).DBCluster.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
replicationSourceIdentifier
- Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.DBCluster.Builder readReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB cluster.DBCluster.Builder readReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB cluster.DBCluster.Builder dbClusterMembers(Collection<DBClusterMember> dbClusterMembers)
Provides the list of instances that make up the DB cluster.
dbClusterMembers
- Provides the list of instances that make up the DB cluster.DBCluster.Builder dbClusterMembers(DBClusterMember... dbClusterMembers)
Provides the list of instances that make up the DB cluster.
dbClusterMembers
- Provides the list of instances that make up the DB cluster.DBCluster.Builder dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
Provides the list of instances that make up the DB cluster.
This is a convenience that creates an instance of theList.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)
.dbClusterMembers
- a consumer that will call methods on List.Builder
#dbClusterMembers(List)
DBCluster.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.DBCluster.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.DBCluster.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
This is a convenience that creates an instance of theList.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)
.vpcSecurityGroups
- a consumer that will call methods on List.Builder
#vpcSecurityGroups(List)
DBCluster.Builder hostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.DBCluster.Builder storageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.DBCluster.Builder kmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster.
kmsKeyId
- If StorageEncrypted
is true, the AWS KMS key identifier for the encrypted DB cluster.DBCluster.Builder dbClusterResourceId(String dbClusterResourceId)
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
dbClusterResourceId
- The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS
CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.DBCluster.Builder dbClusterArn(String dbClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
dbClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.DBCluster.Builder associatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other AWS services on your behalf.DBCluster.Builder associatedRoles(DBClusterRole... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other AWS services on your behalf.DBCluster.Builder associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
This is a convenience that creates an instance of theList.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)
.associatedRoles
- a consumer that will call methods on List.Builder
#associatedRoles(List)
DBCluster.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
iamDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled,
and otherwise false.DBCluster.Builder cloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
cloneGroupId
- Identifies the clone group to which the DB cluster is associated.DBCluster.Builder clusterCreateTime(Instant clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.