public static interface DBCluster.Builder extends SdkPojo, CopyableBuilder<DBCluster.Builder,DBCluster>
| Modifier and Type | Method and Description |
|---|---|
DBCluster.Builder |
activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBCluster.Builder |
activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBCluster.Builder |
activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBCluster.Builder |
activityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBCluster.Builder |
activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBCluster.Builder |
activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBCluster.Builder |
allocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage
size in gibibytes (GiB). |
DBCluster.Builder |
associatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
associatedRoles(DBClusterRole... associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster.Builder |
automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
|
DBCluster.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBCluster.Builder |
availabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster.Builder |
availabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster.Builder |
backtrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
|
DBCluster.Builder |
backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
DBCluster.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
DBCluster.Builder |
capacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster.
|
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)
The ID of the clone group with which the DB cluster is associated.
|
DBCluster.Builder |
clusterCreateTime(Instant clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
DBCluster.Builder |
crossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
DBCluster.Builder |
customEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster.Builder |
customEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster.Builder |
databaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was
provided.
|
DBCluster.Builder |
dbClusterArn(String dbClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The user-supplied identifier for the DB cluster.
|
DBCluster.Builder |
dbClusterInstanceClass(String dbClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBCluster.Builder |
dbClusterMembers(Collection<DBClusterMember> dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterMembers(DBClusterMember... dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
dbClusterParameterGroup(String dbClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
|
DBCluster.Builder |
dbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
DBCluster.Builder |
dbSubnetGroup(String dbSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
DBCluster.Builder |
dbSystemId(String dbSystemId)
Reserved for future use.
|
DBCluster.Builder |
deletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled.
|
DBCluster.Builder |
domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
earliestBacktrackTime(Instant earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
|
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 DB cluster is configured to export to CloudWatch Logs.
|
DBCluster.Builder |
enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster.Builder |
endpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
|
DBCluster.Builder |
engine(String engine)
The database engine used for this DB cluster.
|
DBCluster.Builder |
engineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless. |
DBCluster.Builder |
engineVersion(String engineVersion)
The version of the database engine.
|
DBCluster.Builder |
globalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
globalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
globalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
hostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster.Builder |
httpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
|
DBCluster.Builder |
iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled.
|
DBCluster.Builder |
ioOptimizedNextAllowedModificationTime(Instant ioOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
DBCluster.Builder |
iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
|
DBCluster.Builder |
kmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
DBCluster.Builder |
latestRestorableTime(Instant latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
|
DBCluster.Builder |
masterUsername(String masterUsername)
The master username for the DB cluster.
|
default DBCluster.Builder |
masterUserSecret(Consumer<MasterUserSecret.Builder> masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBCluster.Builder |
masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBCluster.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
DBCluster.Builder |
monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
DBCluster.Builder |
multiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
DBCluster.Builder |
networkType(String networkType)
The network type of the DB instance.
|
DBCluster.Builder |
pendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster.
|
default DBCluster.Builder |
pendingModifiedValues(Consumer<ClusterPendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB cluster.
|
DBCluster.Builder |
percentProgress(String percentProgress)
The progress of the operation as a percentage.
|
DBCluster.Builder |
performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
|
DBCluster.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBCluster.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBCluster.Builder |
port(Integer port)
The port that the database engine is listening on.
|
DBCluster.Builder |
preferredBackupWindow(String preferredBackupWindow)
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)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster.Builder |
publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
|
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)
The identifier of the source DB cluster if this DB cluster is a read replica.
|
default DBCluster.Builder |
scalingConfigurationInfo(Consumer<ScalingConfigurationInfo.Builder> scalingConfigurationInfo)
Sets the value of the ScalingConfigurationInfo property for this object.
|
DBCluster.Builder |
scalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
Sets the value of the ScalingConfigurationInfo property for this object.
|
default DBCluster.Builder |
serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfigurationInfo.Builder> serverlessV2ScalingConfiguration)
Sets the value of the ServerlessV2ScalingConfiguration property for this object.
|
DBCluster.Builder |
serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)
Sets the value of the ServerlessV2ScalingConfiguration property for this object.
|
DBCluster.Builder |
status(String status)
The current state of this DB cluster.
|
DBCluster.Builder |
storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
|
DBCluster.Builder |
storageType(String storageType)
The storage type associated with the DB cluster.
|
DBCluster.Builder |
tagList(Collection<Tag> tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
tagList(Consumer<Tag.Builder>... tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
tagList(Tag... tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildDBCluster.Builder allocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage
size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB
cluster storage size isn't fixed, but instead automatically adjusts as needed.
allocatedStorage - For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated
storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because
Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.DBCluster.Builder availabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster can be created.DBCluster.Builder availabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster can be created.DBCluster.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
backupRetentionPeriod - 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)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
databaseName - The name of the initial database that was specified for the DB cluster when it was created, if one was
provided. This same name is returned for the life of the DB cluster.DBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
dbClusterIdentifier - The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a
DB cluster.DBCluster.Builder dbClusterParameterGroup(String dbClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
dbClusterParameterGroup - The name of the DB cluster parameter group for the DB cluster.DBCluster.Builder dbSubnetGroup(String dbSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dbSubnetGroup - Information about the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.DBCluster.Builder status(String status)
The current state of this DB cluster.
status - The current state of this DB cluster.DBCluster.Builder automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
automaticRestartTime - The time when a stopped DB cluster is restarted automatically.DBCluster.Builder percentProgress(String percentProgress)
The progress of the operation as a percentage.
percentProgress - The progress of the operation as a percentage.DBCluster.Builder earliestRestorableTime(Instant earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime - The earliest time to which a database can be restored with point-in-time restore.DBCluster.Builder endpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
endpoint - 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 customEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
customEndpoints - The custom endpoints associated with the DB cluster.DBCluster.Builder customEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
customEndpoints - The custom endpoints associated with the DB cluster.DBCluster.Builder multiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
multiAZ - Indicates whether the DB cluster has instances in multiple Availability Zones.DBCluster.Builder engine(String engine)
The database engine used for this DB cluster.
engine - The database engine used for this DB cluster.DBCluster.Builder engineVersion(String engineVersion)
The version of the database engine.
engineVersion - The version of the database engine.DBCluster.Builder latestRestorableTime(Instant latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
latestRestorableTime - The latest time to which a database can be restored with point-in-time restore.DBCluster.Builder port(Integer port)
The port that the database engine is listening on.
port - The port that the database engine is listening on.DBCluster.Builder masterUsername(String masterUsername)
The master username for the DB cluster.
masterUsername - The master username for the DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
dbClusterOptionGroupMemberships - The list of option group memberships for this DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
dbClusterOptionGroupMemberships - The list of option group memberships for this DB cluster.DBCluster.Builder dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
This is a convenience method that creates an instance of theDBClusterOptionGroupStatus.Builder avoiding the need to
create one manually via
DBClusterOptionGroupStatus.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #dbClusterOptionGroupMemberships(List.
dbClusterOptionGroupMemberships - a consumer that will call methods on
DBClusterOptionGroupStatus.Builder#dbClusterOptionGroupMemberships(java.util.Collection) DBCluster.Builder preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
preferredBackupWindow - 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)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).DBCluster.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
replicationSourceIdentifier - 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)
The list of DB instances that make up the DB cluster.
dbClusterMembers - The list of DB instances that make up the DB cluster.DBCluster.Builder dbClusterMembers(DBClusterMember... dbClusterMembers)
The list of DB instances that make up the DB cluster.
dbClusterMembers - The list of DB instances that make up the DB cluster.DBCluster.Builder dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
The list of DB instances that make up the DB cluster.
This is a convenience method that creates an instance of theDBClusterMember.Builder avoiding the need to create one
manually via DBClusterMember.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #dbClusterMembers(List.
dbClusterMembers - a consumer that will call methods on
DBClusterMember.Builder#dbClusterMembers(java.util.Collection) DBCluster.Builder vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups - The list of VPC security groups that the DB cluster belongs to.DBCluster.Builder vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups - The list of VPC security groups that the DB cluster belongs to.DBCluster.Builder vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
This is a convenience method that creates an instance of theVpcSecurityGroupMembership.Builder avoiding the need to
create one manually via
VpcSecurityGroupMembership.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #vpcSecurityGroups(List.
vpcSecurityGroups - a consumer that will call methods on
VpcSecurityGroupMembership.Builder#vpcSecurityGroups(java.util.Collection) DBCluster.Builder hostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId - The ID that Amazon Route 53 assigns when you create a hosted zone.DBCluster.Builder storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
storageEncrypted - Indicates whether the DB cluster is encrypted.DBCluster.Builder kmsKeyId(String kmsKeyId)
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
kmsKeyId - If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the
encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBCluster.Builder dbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
dbClusterResourceId - The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is
found in Amazon Web Services CloudTrail log entries whenever the 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)
A list of the Amazon Web Services 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 Amazon Web Services on your behalf.
associatedRoles - A list of the Amazon Web Services 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 Amazon Web Services on your behalf.DBCluster.Builder associatedRoles(DBClusterRole... associatedRoles)
A list of the Amazon Web Services 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 Amazon Web Services on your behalf.
associatedRoles - A list of the Amazon Web Services 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 Amazon Web Services on your behalf.DBCluster.Builder associatedRoles(Consumer<DBClusterRole.Builder>... associatedRoles)
A list of the Amazon Web Services 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 Amazon Web Services on your behalf.
This is a convenience method that creates an instance of theDBClusterRole.Builder avoiding the need to create one
manually via DBClusterRole.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #associatedRoles(List.
associatedRoles - a consumer that will call methods on
DBClusterRole.Builder#associatedRoles(java.util.Collection) DBCluster.Builder iamDatabaseAuthenticationEnabled(Boolean iamDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iamDatabaseAuthenticationEnabled - Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled.DBCluster.Builder cloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
cloneGroupId - The ID of the clone group with which the DB cluster is associated.DBCluster.Builder clusterCreateTime(Instant clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime - The time when the DB cluster was created, in Universal Coordinated Time (UTC).DBCluster.Builder earliestBacktrackTime(Instant earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
earliestBacktrackTime - The earliest time to which a DB cluster can be backtracked.DBCluster.Builder backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for
the DB cluster. Otherwise, backtracking is enabled.
backtrackWindow - The target backtrack window, in seconds. If this value is set to 0, backtracking is
disabled for the DB cluster. Otherwise, backtracking is enabled.DBCluster.Builder backtrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
backtrackConsumedChangeRecords - The number of change records stored for Backtrack.DBCluster.Builder enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
enabledCloudwatchLogsExports - A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
DBCluster.Builder enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
enabledCloudwatchLogsExports - A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
DBCluster.Builder capacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
capacity - The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when
the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
DBCluster.Builder engineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
engineMode - The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
DBCluster.Builder scalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
scalingConfigurationInfo - The new value for the ScalingConfigurationInfo property for this object.default DBCluster.Builder scalingConfigurationInfo(Consumer<ScalingConfigurationInfo.Builder> scalingConfigurationInfo)
ScalingConfigurationInfo.Builder
avoiding the need to create one manually via ScalingConfigurationInfo.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to scalingConfigurationInfo(ScalingConfigurationInfo).
scalingConfigurationInfo - a consumer that will call methods on ScalingConfigurationInfo.BuilderscalingConfigurationInfo(ScalingConfigurationInfo)DBCluster.Builder deletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
deletionProtection - Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
deletion protection is enabled.DBCluster.Builder httpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
httpEndpointEnabled - Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
DBCluster.Builder activityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an
activity stream event. The database session can handle these events either synchronously or
asynchronously.ActivityStreamMode,
ActivityStreamModeDBCluster.Builder activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activityStreamMode - The mode of the database activity stream. Database events such as a change or access generate an
activity stream event. The database session can handle these events either synchronously or
asynchronously.ActivityStreamMode,
ActivityStreamModeDBCluster.Builder activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus - The status of the database activity stream.ActivityStreamStatus,
ActivityStreamStatusDBCluster.Builder activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
activityStreamStatus - The status of the database activity stream.ActivityStreamStatus,
ActivityStreamStatusDBCluster.Builder activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activityStreamKmsKeyId - The Amazon Web Services KMS key identifier used for encrypting messages in the database activity
stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBCluster.Builder activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName - The name of the Amazon Kinesis data stream used for the database activity stream.DBCluster.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
copyTagsToSnapshot - Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.DBCluster.Builder crossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
crossAccountClone - Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services
account.DBCluster.Builder domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
domainMemberships - The Active Directory Domain membership records associated with the DB cluster.DBCluster.Builder domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
domainMemberships - The Active Directory Domain membership records associated with the DB cluster.DBCluster.Builder domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
This is a convenience method that creates an instance of theDomainMembership.Builder avoiding the need to create one
manually via DomainMembership.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #domainMemberships(List.
domainMemberships - a consumer that will call methods on
DomainMembership.Builder#domainMemberships(java.util.Collection) DBCluster.Builder tagList(Collection<Tag> tagList)
tagList - The new value for the TagList property for this object.DBCluster.Builder tagList(Tag... tagList)
tagList - The new value for the TagList property for this object.DBCluster.Builder tagList(Consumer<Tag.Builder>... tagList)
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tagList(List.
tagList - a consumer that will call methods on Tag.Builder#tagList(java.util.Collection) DBCluster.Builder globalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
globalWriteForwardingStatus - The status of write forwarding for a secondary cluster in an Aurora global database.WriteForwardingStatus,
WriteForwardingStatusDBCluster.Builder globalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
globalWriteForwardingStatus - The status of write forwarding for a secondary cluster in an Aurora global database.WriteForwardingStatus,
WriteForwardingStatusDBCluster.Builder globalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because
write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm
that the request has completed before using the write forwarding feature for this cluster.
globalWriteForwardingRequested - Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database.
Because write forwarding takes time to enable, check the value of
GlobalWriteForwardingStatus to confirm that the request has completed before using the
write forwarding feature for this cluster.DBCluster.Builder pendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
pendingModifiedValues - Information about pending changes to the DB cluster. This information is returned only when there are
pending changes. Specific changes are identified by subelements.default DBCluster.Builder pendingModifiedValues(Consumer<ClusterPendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
This is a convenience method that creates an instance of theClusterPendingModifiedValues.Builder
avoiding the need to create one manually via ClusterPendingModifiedValues.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to pendingModifiedValues(ClusterPendingModifiedValues).
pendingModifiedValues - a consumer that will call methods on ClusterPendingModifiedValues.BuilderpendingModifiedValues(ClusterPendingModifiedValues)DBCluster.Builder dbClusterInstanceClass(String dbClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
dbClusterInstanceClass - The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder storageType(String storageType)
The storage type associated with the DB cluster.
storageType - The storage type associated with the DB cluster.DBCluster.Builder iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
iops - The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
publiclyAccessible - Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
autoMinorVersionUpgrade - Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringRoleArn - The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch
Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
performanceInsightsEnabled - Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
DBCluster.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months *
31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93 (3
months * 31), 341 (11 months * 31), 589 (19 months * 31)
731
Default: 7 days
DBCluster.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration - The new value for the ServerlessV2ScalingConfiguration property for this object.default DBCluster.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfigurationInfo.Builder> serverlessV2ScalingConfiguration)
ServerlessV2ScalingConfigurationInfo.Builder avoiding the need to create one manually via
ServerlessV2ScalingConfigurationInfo.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to
serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo).
serverlessV2ScalingConfiguration - a consumer that will call methods on ServerlessV2ScalingConfigurationInfo.BuilderserverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo)DBCluster.Builder networkType(String networkType)
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
networkType - The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A
DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
DBCluster.Builder dbSystemId(String dbSystemId)
Reserved for future use.
dbSystemId - Reserved for future use.DBCluster.Builder masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
masterUserSecret - The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
default DBCluster.Builder masterUserSecret(Consumer<MasterUserSecret.Builder> masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
This is a convenience method that creates an instance of theMasterUserSecret.Builder avoiding the
need to create one manually via MasterUserSecret.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to masterUserSecret(MasterUserSecret).
masterUserSecret - a consumer that will call methods on MasterUserSecret.BuildermasterUserSecret(MasterUserSecret)DBCluster.Builder ioOptimizedNextAllowedModificationTime(Instant ioOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
ioOptimizedNextAllowedModificationTime - The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.
Copyright © 2023. All rights reserved.