| Package | Description |
|---|---|
| software.amazon.awssdk.services.rds.model |
| Modifier and Type | Method and Description |
|---|---|
DBCluster.Builder |
DBCluster.Builder.activityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.activityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.activityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.activityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.activityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.activityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBCluster.Builder |
DBCluster.Builder.allocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage
size in gibibytes (GiB). |
DBCluster.Builder |
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 |
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 |
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 |
DBCluster.Builder.automaticRestartTime(Instant automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
|
DBCluster.Builder |
DBCluster.Builder.autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBCluster.Builder |
DBCluster.Builder.availabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster.Builder |
DBCluster.Builder.availabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster.Builder |
DBCluster.Builder.backtrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
|
DBCluster.Builder |
DBCluster.Builder.backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
DBCluster.Builder |
DBCluster.Builder.backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
static DBCluster.Builder |
DBCluster.builder() |
DBCluster.Builder |
DBCluster.Builder.capacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.characterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster.Builder |
DBCluster.Builder.cloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
|
DBCluster.Builder |
DBCluster.Builder.clusterCreateTime(Instant clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster.Builder |
DBCluster.Builder.copyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
DBCluster.Builder |
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 |
DBCluster.Builder.customEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.customEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster.Builder |
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 |
DBCluster.Builder.dbClusterArn(String dbClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterIdentifier(String dbClusterIdentifier)
The user-supplied identifier for the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterInstanceClass(String dbClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterMembers(Collection<DBClusterMember> dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterMembers(Consumer<DBClusterMember.Builder>... dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterMembers(DBClusterMember... dbClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterOptionGroupMemberships(Consumer<DBClusterOptionGroupStatus.Builder>... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dbClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterParameterGroup(String dbClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.dbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
DBCluster.Builder |
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 |
DBCluster.Builder.dbSystemId(String dbSystemId)
Reserved for future use.
|
DBCluster.Builder |
DBCluster.Builder.deletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled.
|
DBCluster.Builder |
DBCluster.Builder.domainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.domainMemberships(Consumer<DomainMembership.Builder>... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.domainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.earliestBacktrackTime(Instant earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
|
DBCluster.Builder |
DBCluster.Builder.earliestRestorableTime(Instant earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
DBCluster.Builder |
DBCluster.Builder.enabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster.Builder |
DBCluster.Builder.enabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster.Builder |
DBCluster.Builder.endpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.engine(String engine)
The database engine used for this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.engineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless. |
DBCluster.Builder |
DBCluster.Builder.engineVersion(String engineVersion)
The version of the database engine.
|
DBCluster.Builder |
DBCluster.Builder.globalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
DBCluster.Builder.globalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
DBCluster.Builder.globalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster.Builder |
DBCluster.Builder.hostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster.Builder |
DBCluster.Builder.httpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
|
DBCluster.Builder |
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 |
DBCluster.Builder.ioOptimizedNextAllowedModificationTime(Instant ioOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
DBCluster.Builder |
DBCluster.Builder.iops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
|
DBCluster.Builder |
DBCluster.Builder.kmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
DBCluster.Builder |
DBCluster.Builder.latestRestorableTime(Instant latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
|
DBCluster.Builder |
DBCluster.Builder.masterUsername(String masterUsername)
The master username for the DB cluster.
|
default DBCluster.Builder |
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 |
DBCluster.Builder.masterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBCluster.Builder |
DBCluster.Builder.monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
DBCluster.Builder |
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 |
DBCluster.Builder.multiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
DBCluster.Builder |
DBCluster.Builder.networkType(String networkType)
The network type of the DB instance.
|
DBCluster.Builder |
DBCluster.Builder.pendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster.
|
default DBCluster.Builder |
DBCluster.Builder.pendingModifiedValues(Consumer<ClusterPendingModifiedValues.Builder> pendingModifiedValues)
Information about pending changes to the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.percentProgress(String percentProgress)
The progress of the operation as a percentage.
|
DBCluster.Builder |
DBCluster.Builder.performanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBCluster.Builder |
DBCluster.Builder.performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBCluster.Builder |
DBCluster.Builder.port(Integer port)
The port that the database engine is listening on.
|
DBCluster.Builder |
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 |
DBCluster.Builder.preferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster.Builder |
DBCluster.Builder.publiclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
|
DBCluster.Builder |
DBCluster.Builder.readerEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.readReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.readReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.replicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
|
default DBCluster.Builder |
DBCluster.Builder.scalingConfigurationInfo(Consumer<ScalingConfigurationInfo.Builder> scalingConfigurationInfo)
Sets the value of the ScalingConfigurationInfo property for this object.
|
DBCluster.Builder |
DBCluster.Builder.scalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
Sets the value of the ScalingConfigurationInfo property for this object.
|
default DBCluster.Builder |
DBCluster.Builder.serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfigurationInfo.Builder> serverlessV2ScalingConfiguration)
Sets the value of the ServerlessV2ScalingConfiguration property for this object.
|
DBCluster.Builder |
DBCluster.Builder.serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)
Sets the value of the ServerlessV2ScalingConfiguration property for this object.
|
DBCluster.Builder |
DBCluster.Builder.status(String status)
The current state of this DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.storageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
|
DBCluster.Builder |
DBCluster.Builder.storageType(String storageType)
The storage type associated with the DB cluster.
|
DBCluster.Builder |
DBCluster.Builder.tagList(Collection<Tag> tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
DBCluster.Builder.tagList(Consumer<Tag.Builder>... tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
DBCluster.Builder.tagList(Tag... tagList)
Sets the value of the TagList property for this object.
|
DBCluster.Builder |
DBCluster.toBuilder() |
DBCluster.Builder |
DBCluster.Builder.vpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
DBCluster.Builder.vpcSecurityGroups(Consumer<VpcSecurityGroupMembership.Builder>... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster.Builder |
DBCluster.Builder.vpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends DBCluster.Builder> |
DBCluster.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default DeleteDbClusterResponse.Builder |
DeleteDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default ModifyDbClusterResponse.Builder |
ModifyDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default RestoreDbClusterFromS3Response.Builder |
RestoreDbClusterFromS3Response.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default StopDbClusterResponse.Builder |
StopDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default PromoteReadReplicaDbClusterResponse.Builder |
PromoteReadReplicaDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default RestoreDbClusterFromSnapshotResponse.Builder |
RestoreDbClusterFromSnapshotResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default CreateDbClusterResponse.Builder |
CreateDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default StartDbClusterResponse.Builder |
StartDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default RebootDbClusterResponse.Builder |
RebootDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default RestoreDbClusterToPointInTimeResponse.Builder |
RestoreDbClusterToPointInTimeResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
default FailoverDbClusterResponse.Builder |
FailoverDbClusterResponse.Builder.dbCluster(Consumer<DBCluster.Builder> dbCluster)
Sets the value of the DBCluster property for this object.
|
Copyright © 2023. All rights reserved.