Interface DBCluster.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DBCluster.Builder,
,DBCluster> SdkBuilder<DBCluster.Builder,
,DBCluster> SdkPojo
- Enclosing class:
DBCluster
-
Method Summary
Modifier and TypeMethodDescriptionactivityStreamKinesisStreamName
(String activityStreamKinesisStreamName) The name of the Amazon Kinesis data stream used for the database activity stream.activityStreamKmsKeyId
(String activityStreamKmsKeyId) The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.activityStreamMode
(String activityStreamMode) The mode of the database activity stream.activityStreamMode
(ActivityStreamMode activityStreamMode) The mode of the database activity stream.activityStreamStatus
(String activityStreamStatus) The status of the database activity stream.activityStreamStatus
(ActivityStreamStatus activityStreamStatus) The status of the database activity stream.allocatedStorage
(Integer allocatedStorage) For all database engines except Amazon Aurora,AllocatedStorage
specifies the allocated storage size in gibibytes (GiB).associatedRoles
(Collection<DBClusterRole> associatedRoles) A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.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.associatedRoles
(DBClusterRole... associatedRoles) A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.automaticRestartTime
(Instant automaticRestartTime) The time when a stopped DB cluster is restarted automatically.autoMinorVersionUpgrade
(Boolean autoMinorVersionUpgrade) Indicates whether minor version patches are applied automatically.availabilityZones
(String... availabilityZones) The list of Availability Zones (AZs) where instances in the DB cluster can be created.availabilityZones
(Collection<String> availabilityZones) The list of Availability Zones (AZs) where instances in the DB cluster can be created.awsBackupRecoveryPointArn
(String awsBackupRecoveryPointArn) The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.backtrackConsumedChangeRecords
(Long backtrackConsumedChangeRecords) The number of change records stored for Backtrack.backtrackWindow
(Long backtrackWindow) The target backtrack window, in seconds.backupRetentionPeriod
(Integer backupRetentionPeriod) The number of days for which automatic DB snapshots are retained.The current capacity of an Aurora Serverless v1 DB cluster.default DBCluster.Builder
certificateDetails
(Consumer<CertificateDetails.Builder> certificateDetails) Sets the value of the CertificateDetails property for this object.certificateDetails
(CertificateDetails certificateDetails) Sets the value of the CertificateDetails property for this object.characterSetName
(String characterSetName) If present, specifies the name of the character set that this cluster is associated with.cloneGroupId
(String cloneGroupId) The ID of the clone group with which the DB cluster is associated.clusterCreateTime
(Instant clusterCreateTime) The time when the DB cluster was created, in Universal Coordinated Time (UTC).copyTagsToSnapshot
(Boolean copyTagsToSnapshot) Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.crossAccountClone
(Boolean crossAccountClone) Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.customEndpoints
(String... customEndpoints) The custom endpoints associated with the DB cluster.customEndpoints
(Collection<String> customEndpoints) The custom endpoints associated with the DB cluster.databaseName
(String databaseName) The name of the initial database that was specified for the DB cluster when it was created, if one was provided.dbClusterArn
(String dbClusterArn) The Amazon Resource Name (ARN) for the DB cluster.dbClusterIdentifier
(String dbClusterIdentifier) The user-supplied identifier for the DB cluster.dbClusterInstanceClass
(String dbClusterInstanceClass) The name of the compute and memory capacity class of the DB instance.dbClusterMembers
(Collection<DBClusterMember> dbClusterMembers) The list of DB instances that make up the DB cluster.dbClusterMembers
(Consumer<DBClusterMember.Builder>... dbClusterMembers) The list of DB instances that make up the DB cluster.dbClusterMembers
(DBClusterMember... dbClusterMembers) The list of DB instances that make up the DB cluster.dbClusterOptionGroupMemberships
(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships) The list of option group memberships for this DB cluster.dbClusterOptionGroupMemberships
(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships) The list of option group memberships for this DB cluster.dbClusterOptionGroupMemberships
(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships) The list of option group memberships for this DB cluster.dbClusterParameterGroup
(String dbClusterParameterGroup) The name of the DB cluster parameter group for the DB cluster.dbClusterResourceId
(String dbClusterResourceId) The Amazon Web Services Region-unique, immutable identifier for the DB cluster.dbSubnetGroup
(String dbSubnetGroup) Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.dbSystemId
(String dbSystemId) Reserved for future use.deletionProtection
(Boolean deletionProtection) Indicates whether the DB cluster has deletion protection enabled.domainMemberships
(Collection<DomainMembership> domainMemberships) The Active Directory Domain membership records associated with the DB cluster.domainMemberships
(Consumer<DomainMembership.Builder>... domainMemberships) The Active Directory Domain membership records associated with the DB cluster.domainMemberships
(DomainMembership... domainMemberships) The Active Directory Domain membership records associated with the DB cluster.earliestBacktrackTime
(Instant earliestBacktrackTime) The earliest time to which a DB cluster can be backtracked.earliestRestorableTime
(Instant earliestRestorableTime) The earliest time to which a database can be restored with point-in-time restore.enabledCloudwatchLogsExports
(String... enabledCloudwatchLogsExports) A list of log types that this DB cluster is configured to export to CloudWatch Logs.enabledCloudwatchLogsExports
(Collection<String> enabledCloudwatchLogsExports) A list of log types that this DB cluster is configured to export to CloudWatch Logs.The connection endpoint for the primary instance of the DB cluster.The database engine used for this DB cluster.engineMode
(String engineMode) The DB engine mode of the DB cluster, eitherprovisioned
orserverless
.engineVersion
(String engineVersion) The version of the database engine.globalWriteForwardingRequested
(Boolean globalWriteForwardingRequested) Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.globalWriteForwardingStatus
(String globalWriteForwardingStatus) The status of write forwarding for a secondary cluster in an Aurora global database.globalWriteForwardingStatus
(WriteForwardingStatus globalWriteForwardingStatus) The status of write forwarding for a secondary cluster in an Aurora global database.hostedZoneId
(String hostedZoneId) The ID that Amazon Route 53 assigns when you create a hosted zone.httpEndpointEnabled
(Boolean httpEndpointEnabled) Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.iamDatabaseAuthenticationEnabled
(Boolean iamDatabaseAuthenticationEnabled) Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.ioOptimizedNextAllowedModificationTime
(Instant ioOptimizedNextAllowedModificationTime) The next time you can modify the DB cluster to use theaurora-iopt1
storage type.The Provisioned IOPS (I/O operations per second) value.IfStorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.latestRestorableTime
(Instant latestRestorableTime) The latest time to which a database can be restored with point-in-time restore.default DBCluster.Builder
limitlessDatabase
(Consumer<LimitlessDatabase.Builder> limitlessDatabase) The details for Aurora Limitless Database.limitlessDatabase
(LimitlessDatabase limitlessDatabase) The details for Aurora Limitless Database.localWriteForwardingStatus
(String localWriteForwardingStatus) Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.localWriteForwardingStatus
(LocalWriteForwardingStatus localWriteForwardingStatus) Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.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.masterUserSecret
(MasterUserSecret masterUserSecret) The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.monitoringInterval
(Integer monitoringInterval) The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.monitoringRoleArn
(String monitoringRoleArn) The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.Indicates whether the DB cluster has instances in multiple Availability Zones.networkType
(String networkType) The network type of the DB instance.default DBCluster.Builder
pendingModifiedValues
(Consumer<ClusterPendingModifiedValues.Builder> pendingModifiedValues) Information about pending changes to the DB cluster.pendingModifiedValues
(ClusterPendingModifiedValues pendingModifiedValues) Information about pending changes to the DB cluster.percentProgress
(String percentProgress) The progress of the operation as a percentage.performanceInsightsEnabled
(Boolean performanceInsightsEnabled) Indicates whether Performance Insights is enabled for the DB cluster.performanceInsightsKMSKeyId
(String performanceInsightsKMSKeyId) The Amazon Web Services KMS key identifier for encryption of Performance Insights data.performanceInsightsRetentionPeriod
(Integer performanceInsightsRetentionPeriod) The number of days to retain Performance Insights data.The port that the database engine is listening on.preferredBackupWindow
(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).publiclyAccessible
(Boolean publiclyAccessible) Indicates whether the DB cluster is publicly accessible.default DBCluster.Builder
rdsCustomClusterConfiguration
(Consumer<RdsCustomClusterConfiguration.Builder> rdsCustomClusterConfiguration) Reserved for future use.rdsCustomClusterConfiguration
(RdsCustomClusterConfiguration rdsCustomClusterConfiguration) Reserved for future use.readerEndpoint
(String readerEndpoint) The reader endpoint for the DB cluster.readReplicaIdentifiers
(String... readReplicaIdentifiers) Contains one or more identifiers of the read replicas associated with this DB cluster.readReplicaIdentifiers
(Collection<String> readReplicaIdentifiers) Contains one or more identifiers of the read replicas associated with this DB cluster.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.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.serverlessV2ScalingConfiguration
(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration) Sets the value of the ServerlessV2ScalingConfiguration property for this object.The current state of this DB cluster.statusInfos
(Collection<DBClusterStatusInfo> statusInfos) Reserved for future use.statusInfos
(Consumer<DBClusterStatusInfo.Builder>... statusInfos) Reserved for future use.statusInfos
(DBClusterStatusInfo... statusInfos) Reserved for future use.storageEncrypted
(Boolean storageEncrypted) Indicates whether the DB cluster is encrypted.storageThroughput
(Integer storageThroughput) The storage throughput for the DB cluster.storageType
(String storageType) The storage type associated with the DB cluster.tagList
(Collection<Tag> tagList) Sets the value of the TagList property for this object.tagList
(Consumer<Tag.Builder>... tagList) Sets the value of the TagList property for this object.Sets the value of the TagList property for this object.vpcSecurityGroups
(Collection<VpcSecurityGroupMembership> vpcSecurityGroups) The list of VPC security groups that the DB cluster belongs to.vpcSecurityGroups
(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups) The list of VPC security groups that the DB cluster belongs to.vpcSecurityGroups
(VpcSecurityGroupMembership... vpcSecurityGroups) The list of VPC security groups that the DB cluster belongs to.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
- Parameters:
availabilityZones
- The list of Availability Zones (AZs) where instances in the DB cluster can be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availabilityZones
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
- Parameters:
availabilityZones
- The list of Availability Zones (AZs) where instances in the DB cluster can be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backupRetentionPeriod
The number of days for which automatic DB snapshots are retained.
- Parameters:
backupRetentionPeriod
- The number of days for which automatic DB snapshots are retained.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
characterSetName
If present, specifies the name of the character set that this cluster is associated with.
- Parameters:
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterIdentifier
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
- Parameters:
dbClusterIdentifier
- The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterParameterGroup
The name of the DB cluster parameter group for the DB cluster.
- Parameters:
dbClusterParameterGroup
- The name of the DB cluster parameter group for the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbSubnetGroup
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- Parameters:
dbSubnetGroup
- Information about the subnet group associated with the DB 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
The current state of this DB cluster.
- Parameters:
status
- The current state of this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
automaticRestartTime
The time when a stopped DB cluster is restarted automatically.
- Parameters:
automaticRestartTime
- The time when a stopped DB cluster is restarted automatically.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
percentProgress
The progress of the operation as a percentage.
- Parameters:
percentProgress
- The progress of the operation as a percentage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The connection endpoint for the primary instance of the DB cluster.
- Parameters:
endpoint
- The connection endpoint for the primary instance of the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customEndpoints
The custom endpoints associated with the DB cluster.
- Parameters:
customEndpoints
- The custom endpoints associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customEndpoints
The custom endpoints associated with the DB cluster.
- Parameters:
customEndpoints
- The custom endpoints associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiAZ
Indicates whether the DB cluster has instances in multiple Availability Zones.
- Parameters:
multiAZ
- Indicates whether the DB cluster has instances in multiple Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engine
The database engine used for this DB cluster.
- Parameters:
engine
- The database engine used for this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineVersion
The version of the database engine.
- Parameters:
engineVersion
- The version of the database engine.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestRestorableTime
The latest time to which a database can be restored with point-in-time restore.
- Parameters:
latestRestorableTime
- 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
The port that the database engine is listening on.
- Parameters:
port
- 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
The master username for the DB cluster.
- Parameters:
masterUsername
- The master username for the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterOptionGroupMemberships
DBCluster.Builder dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships) The list of option group memberships for this DB cluster.
- Parameters:
dbClusterOptionGroupMemberships
- The list of option group memberships for this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterOptionGroupMemberships
DBCluster.Builder dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships) The list of option group memberships for this DB cluster.
- Parameters:
dbClusterOptionGroupMemberships
- The list of option group memberships for this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterOptionGroupMemberships
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 viaDBClusterOptionGroupStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todbClusterOptionGroupMemberships(List<DBClusterOptionGroupStatus>)
.- Parameters:
dbClusterOptionGroupMemberships
- a consumer that will call methods onDBClusterOptionGroupStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as determined by theBackupRetentionPeriod
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Parameters:
preferredMaintenanceWindow
- 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
The identifier of the source DB cluster if this DB cluster is a read replica.
- Parameters:
replicationSourceIdentifier
- The identifier of the source DB cluster if this DB cluster is a read replica.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readReplicaIdentifiers
Contains one or more identifiers of the read replicas associated with this DB cluster.
- Parameters:
readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
readReplicaIdentifiers
Contains one or more identifiers of the read replicas associated with this DB cluster.
- Parameters:
readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusInfos
Reserved for future use.
- Parameters:
statusInfos
- Reserved for future use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusInfos
Reserved for future use.
- Parameters:
statusInfos
- Reserved for future use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusInfos
Reserved for future use.
This is a convenience method that creates an instance of theDBClusterStatusInfo.Builder
avoiding the need to create one manually viaDBClusterStatusInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatusInfos(List<DBClusterStatusInfo>)
.- Parameters:
statusInfos
- a consumer that will call methods onDBClusterStatusInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dbClusterMembers
The list of DB instances that make up the DB cluster.
- Parameters:
dbClusterMembers
- The list of DB instances that make up the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterMembers
The list of DB instances that make up the DB cluster.
- Parameters:
dbClusterMembers
- The list of DB instances that make up the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaDBClusterMember.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todbClusterMembers(List<DBClusterMember>)
.- Parameters:
dbClusterMembers
- a consumer that will call methods onDBClusterMember.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcSecurityGroups
The list of VPC security groups that the DB cluster belongs to.
- Parameters:
vpcSecurityGroups
- The list of VPC security groups that the DB cluster belongs to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcSecurityGroups
The list of VPC security groups that the DB cluster belongs to.
- Parameters:
vpcSecurityGroups
- The list of VPC security groups that the DB 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) 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 viaVpcSecurityGroupMembership.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcSecurityGroups(List<VpcSecurityGroupMembership>)
.- Parameters:
vpcSecurityGroups
- a consumer that will call methods onVpcSecurityGroupMembership.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hostedZoneId
The ID that Amazon Route 53 assigns when you create a hosted zone.
- Parameters:
hostedZoneId
- 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
Indicates whether the DB cluster is encrypted.
- Parameters:
storageEncrypted
- Indicates whether the DB cluster is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
kmsKeyId
- IfStorageEncrypted
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterArn
The Amazon Resource Name (ARN) for the DB cluster.
- Parameters:
dbClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaDBClusterRole.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassociatedRoles(List<DBClusterRole>)
.- Parameters:
associatedRoles
- a consumer that will call methods onDBClusterRole.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
iamDatabaseAuthenticationEnabled
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- Parameters:
iamDatabaseAuthenticationEnabled
- Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cloneGroupId
The ID of the clone group with which the DB cluster is associated.
- Parameters:
cloneGroupId
- The ID of the clone group with which the DB cluster is associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clusterCreateTime
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
- Parameters:
clusterCreateTime
- The time when the DB cluster was created, in Universal Coordinated Time (UTC).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
earliestBacktrackTime
The earliest time to which a DB cluster can be backtracked.
- Parameters:
earliestBacktrackTime
- The earliest time to which a DB cluster can be backtracked.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
backtrackWindow
- The target backtrack window, in seconds. If this value is set to0
, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
backtrackConsumedChangeRecords
The number of change records stored for Backtrack.
- Parameters:
backtrackConsumedChangeRecords
- The number of change records stored for Backtrack.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
capacity
- The current capacity of an Aurora Serverless v1 DB cluster. The capacity is0
(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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
engineMode
The DB engine mode of the DB cluster, either
provisioned
orserverless
.For more information, see CreateDBCluster.
- Parameters:
engineMode
- The DB engine mode of the DB cluster, eitherprovisioned
orserverless
.For more information, see CreateDBCluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfigurationInfo
Sets the value of the ScalingConfigurationInfo property for this object.- Parameters:
scalingConfigurationInfo
- The new value for the ScalingConfigurationInfo property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfigurationInfo
default DBCluster.Builder scalingConfigurationInfo(Consumer<ScalingConfigurationInfo.Builder> scalingConfigurationInfo) Sets the value of the ScalingConfigurationInfo property for this object. This is a convenience method that creates an instance of theScalingConfigurationInfo.Builder
avoiding the need to create one manually viaScalingConfigurationInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscalingConfigurationInfo(ScalingConfigurationInfo)
.- Parameters:
scalingConfigurationInfo
- a consumer that will call methods onScalingConfigurationInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rdsCustomClusterConfiguration
DBCluster.Builder rdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration) Reserved for future use.
- Parameters:
rdsCustomClusterConfiguration
- Reserved for future use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rdsCustomClusterConfiguration
default DBCluster.Builder rdsCustomClusterConfiguration(Consumer<RdsCustomClusterConfiguration.Builder> rdsCustomClusterConfiguration) Reserved for future use.
This is a convenience method that creates an instance of theRdsCustomClusterConfiguration.Builder
avoiding the need to create one manually viaRdsCustomClusterConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tordsCustomClusterConfiguration(RdsCustomClusterConfiguration)
.- Parameters:
rdsCustomClusterConfiguration
- a consumer that will call methods onRdsCustomClusterConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deletionProtection
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- Parameters:
deletionProtection
- Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpEndpointEnabled
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
- Parameters:
httpEndpointEnabled
- Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
activityStreamStatus
The status of the database activity stream.
- Parameters:
activityStreamStatus
- The status of the database activity stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
activityStreamStatus
The status of the database activity stream.
- Parameters:
activityStreamStatus
- The status of the database activity stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activityStreamKinesisStreamName
The name of the Amazon Kinesis data stream used for the database activity stream.
- Parameters:
activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database activity stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
copyTagsToSnapshot
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
- Parameters:
copyTagsToSnapshot
- Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
crossAccountClone
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
- Parameters:
crossAccountClone
- Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainMemberships
The Active Directory Domain membership records associated with the DB cluster.
- Parameters:
domainMemberships
- The Active Directory Domain membership records associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainMemberships
The Active Directory Domain membership records associated with the DB cluster.
- Parameters:
domainMemberships
- The Active Directory Domain membership records associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaDomainMembership.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todomainMemberships(List<DomainMembership>)
.- Parameters:
domainMemberships
- a consumer that will call methods onDomainMembership.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tagList
Sets the value of the TagList property for this object.- Parameters:
tagList
- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
Sets the value of the TagList property for this object.- Parameters:
tagList
- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
Sets the value of the TagList property for this object. This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagList(List<Tag>)
.- Parameters:
tagList
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
globalWriteForwardingStatus
The status of write forwarding for a secondary cluster in an Aurora global database.
- Parameters:
globalWriteForwardingStatus
- The status of write forwarding for a secondary cluster in an Aurora global database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
globalWriteForwardingStatus
The status of write forwarding for a secondary cluster in an Aurora global database.
- Parameters:
globalWriteForwardingStatus
- The status of write forwarding for a secondary cluster in an Aurora global database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
globalWriteForwardingRequested
Indicates 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.- Parameters:
globalWriteForwardingRequested
- Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value ofGlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingModifiedValues
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 viaClusterPendingModifiedValues.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topendingModifiedValues(ClusterPendingModifiedValues)
.- Parameters:
pendingModifiedValues
- a consumer that will call methods onClusterPendingModifiedValues.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageType
The storage type associated with the DB cluster.
- Parameters:
storageType
- The storage type associated with the DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
iops
- The Provisioned IOPS (I/O operations per second) value.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
autoMinorVersionUpgrade
- Indicates whether minor version patches are applied automatically.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
performanceInsightsEnabled
- Indicates whether Performance Insights is enabled for the DB cluster.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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- Parameters:
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-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
serverlessV2ScalingConfiguration
DBCluster.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration) Sets the value of the ServerlessV2ScalingConfiguration property for this object.- Parameters:
serverlessV2ScalingConfiguration
- The new value for the ServerlessV2ScalingConfiguration property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverlessV2ScalingConfiguration
default DBCluster.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfigurationInfo.Builder> serverlessV2ScalingConfiguration) Sets the value of the ServerlessV2ScalingConfiguration property for this object. This is a convenience method that creates an instance of theServerlessV2ScalingConfigurationInfo.Builder
avoiding the need to create one manually viaServerlessV2ScalingConfigurationInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo)
.- Parameters:
serverlessV2ScalingConfiguration
- a consumer that will call methods onServerlessV2ScalingConfigurationInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
networkType
The network type of the DB instance.
The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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
- Parameters:
networkType
- The network type of the DB instance.The network type is determined by the
DBSubnetGroup
specified for the DB cluster. ADBSubnetGroup
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbSystemId
Reserved for future use.
- Parameters:
dbSystemId
- Reserved for future use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 viaMasterUserSecret.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomasterUserSecret(MasterUserSecret)
.- Parameters:
masterUserSecret
- a consumer that will call methods onMasterUserSecret.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ioOptimizedNextAllowedModificationTime
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.
- Parameters:
ioOptimizedNextAllowedModificationTime
- The next time you can modify the DB cluster to use theaurora-iopt1
storage type.This setting is only for Aurora DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localWriteForwardingStatus
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
- Parameters:
localWriteForwardingStatus
- Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
localWriteForwardingStatus
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
- Parameters:
localWriteForwardingStatus
- Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
awsBackupRecoveryPointArn
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
- Parameters:
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limitlessDatabase
The details for Aurora Limitless Database.
- Parameters:
limitlessDatabase
- The details for Aurora Limitless Database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limitlessDatabase
The details for Aurora Limitless Database.
This is a convenience method that creates an instance of theLimitlessDatabase.Builder
avoiding the need to create one manually viaLimitlessDatabase.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolimitlessDatabase(LimitlessDatabase)
.- Parameters:
limitlessDatabase
- a consumer that will call methods onLimitlessDatabase.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageThroughput
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
- Parameters:
storageThroughput
- The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.This setting is only for non-Aurora Multi-AZ DB clusters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateDetails
Sets the value of the CertificateDetails property for this object.- Parameters:
certificateDetails
- The new value for the CertificateDetails property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
certificateDetails
default DBCluster.Builder certificateDetails(Consumer<CertificateDetails.Builder> certificateDetails) Sets the value of the CertificateDetails property for this object. This is a convenience method that creates an instance of theCertificateDetails.Builder
avoiding the need to create one manually viaCertificateDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocertificateDetails(CertificateDetails)
.- Parameters:
certificateDetails
- a consumer that will call methods onCertificateDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-