| Package | Description |
|---|---|
| com.amazonaws.services.rds |
|
| com.amazonaws.services.rds.model |
| Modifier and Type | Method and Description |
|---|---|
DBCluster |
AbstractAmazonRDS.createDBCluster(CreateDBClusterRequest request) |
DBCluster |
AmazonRDSClient.createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
DBCluster |
AmazonRDS.createDBCluster(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
DBCluster |
AbstractAmazonRDS.deleteDBCluster(DeleteDBClusterRequest request) |
DBCluster |
AmazonRDSClient.deleteDBCluster(DeleteDBClusterRequest request)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
DBCluster |
AmazonRDS.deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)
The DeleteDBCluster action deletes a previously provisioned DB cluster.
|
DBCluster |
AbstractAmazonRDS.failoverDBCluster() |
DBCluster |
AmazonRDSClient.failoverDBCluster() |
DBCluster |
AmazonRDS.failoverDBCluster()
Simplified method form for invoking the FailoverDBCluster operation.
|
DBCluster |
AbstractAmazonRDS.failoverDBCluster(FailoverDBClusterRequest request) |
DBCluster |
AmazonRDSClient.failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a DB cluster.
|
DBCluster |
AmazonRDS.failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)
Forces a failover for a DB cluster.
|
DBCluster |
AbstractAmazonRDS.modifyDBCluster(ModifyDBClusterRequest request) |
DBCluster |
AmazonRDSClient.modifyDBCluster(ModifyDBClusterRequest request)
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
|
DBCluster |
AmazonRDS.modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)
Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
|
DBCluster |
AbstractAmazonRDS.promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request) |
DBCluster |
AmazonRDSClient.promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest request)
Promotes a read replica DB cluster to a standalone DB cluster.
|
DBCluster |
AmazonRDS.promoteReadReplicaDBCluster(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest)
Promotes a read replica DB cluster to a standalone DB cluster.
|
DBCluster |
AbstractAmazonRDS.rebootDBCluster(RebootDBClusterRequest request) |
DBCluster |
AmazonRDSClient.rebootDBCluster(RebootDBClusterRequest request)
You might need to reboot your DB cluster, usually for maintenance reasons.
|
DBCluster |
AmazonRDS.rebootDBCluster(RebootDBClusterRequest rebootDBClusterRequest)
You might need to reboot your DB cluster, usually for maintenance reasons.
|
DBCluster |
AbstractAmazonRDS.restoreDBClusterFromS3(RestoreDBClusterFromS3Request request) |
DBCluster |
AmazonRDSClient.restoreDBClusterFromS3(RestoreDBClusterFromS3Request request)
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.
|
DBCluster |
AmazonRDS.restoreDBClusterFromS3(RestoreDBClusterFromS3Request restoreDBClusterFromS3Request)
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.
|
DBCluster |
AbstractAmazonRDS.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request) |
DBCluster |
AmazonRDSClient.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
DBCluster |
AmazonRDS.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
DBCluster |
AbstractAmazonRDS.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request) |
DBCluster |
AmazonRDSClient.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Restores a DB cluster to an arbitrary point in time.
|
DBCluster |
AmazonRDS.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
Restores a DB cluster to an arbitrary point in time.
|
DBCluster |
AbstractAmazonRDS.startDBCluster(StartDBClusterRequest request) |
DBCluster |
AmazonRDSClient.startDBCluster(StartDBClusterRequest request)
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
CLI command, or the StopDBCluster action.
|
DBCluster |
AmazonRDS.startDBCluster(StartDBClusterRequest startDBClusterRequest)
Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
CLI command, or the StopDBCluster action.
|
DBCluster |
AbstractAmazonRDS.stopDBCluster(StopDBClusterRequest request) |
DBCluster |
AmazonRDSClient.stopDBCluster(StopDBClusterRequest request)
Stops an Amazon Aurora DB cluster.
|
DBCluster |
AmazonRDS.stopDBCluster(StopDBClusterRequest stopDBClusterRequest)
Stops an Amazon Aurora DB cluster.
|
| Modifier and Type | Method and Description |
|---|---|
DBCluster |
DBCluster.clone() |
DBCluster |
DBCluster.withActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBCluster |
DBCluster.withActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBCluster |
DBCluster.withActivityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBCluster |
DBCluster.withActivityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBCluster |
DBCluster.withActivityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBCluster |
DBCluster.withActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBCluster |
DBCluster.withAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). |
DBCluster |
DBCluster.withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster |
DBCluster.withAssociatedRoles(DBClusterRole... associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster |
DBCluster.withAutomaticRestartTime(Date automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
|
DBCluster |
DBCluster.withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBCluster |
DBCluster.withAvailabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster |
DBCluster.withAvailabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster |
DBCluster.withBacktrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
|
DBCluster |
DBCluster.withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
DBCluster |
DBCluster.withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
DBCluster |
DBCluster.withCapacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster.
|
DBCluster |
DBCluster.withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster |
DBCluster.withCloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
|
DBCluster |
DBCluster.withClusterCreateTime(Date clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
DBCluster.withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
DBCluster |
DBCluster.withCrossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
DBCluster |
DBCluster.withCustomEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster |
DBCluster.withCustomEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster |
DBCluster.withDatabaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
|
DBCluster |
DBCluster.withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster |
DBCluster.withDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied identifier for the DB cluster.
|
DBCluster |
DBCluster.withDBClusterInstanceClass(String dBClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBCluster |
DBCluster.withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster |
DBCluster.withDBClusterMembers(DBClusterMember... dBClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster |
DBCluster.withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster |
DBCluster.withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster |
DBCluster.withDBClusterParameterGroup(String dBClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
|
DBCluster |
DBCluster.withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
DBCluster |
DBCluster.withDBSubnetGroup(String dBSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets
in the subnet group.
|
DBCluster |
DBCluster.withDBSystemId(String dBSystemId)
Reserved for future use.
|
DBCluster |
DBCluster.withDeletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled.
|
DBCluster |
DBCluster.withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster |
DBCluster.withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster |
DBCluster.withEarliestBacktrackTime(Date earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
|
DBCluster |
DBCluster.withEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
DBCluster |
DBCluster.withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster |
DBCluster.withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster |
DBCluster.withEndpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
|
DBCluster |
DBCluster.withEngine(String engine)
The database engine used for this DB cluster.
|
DBCluster |
DBCluster.withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless. |
DBCluster |
DBCluster.withEngineVersion(String engineVersion)
The version of the database engine.
|
DBCluster |
DBCluster.withGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
DBCluster |
DBCluster.withGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster |
DBCluster.withGlobalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster |
DBCluster.withHostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster |
DBCluster.withHttpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
|
DBCluster |
DBCluster.withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
DBCluster |
DBCluster.withIOOptimizedNextAllowedModificationTime(Date iOOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
DBCluster |
DBCluster.withIops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
|
DBCluster |
DBCluster.withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
DBCluster |
DBCluster.withLatestRestorableTime(Date latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
|
DBCluster |
DBCluster.withLocalWriteForwardingStatus(LocalWriteForwardingStatus localWriteForwardingStatus)
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
DBCluster |
DBCluster.withLocalWriteForwardingStatus(String localWriteForwardingStatus)
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
DBCluster |
DBCluster.withMasterUsername(String masterUsername)
The master username for the DB cluster.
|
DBCluster |
DBCluster.withMasterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBCluster |
DBCluster.withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
DBCluster |
DBCluster.withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
DBCluster |
DBCluster.withMultiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
DBCluster |
DBCluster.withNetworkType(String networkType)
The network type of the DB instance.
|
DBCluster |
DBCluster.withPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster.
|
DBCluster |
DBCluster.withPercentProgress(String percentProgress)
The progress of the operation as a percentage.
|
DBCluster |
DBCluster.withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
|
DBCluster |
DBCluster.withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBCluster |
DBCluster.withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBCluster |
DBCluster.withPort(Integer port)
The port that the database engine is listening on.
|
DBCluster |
DBCluster.withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the
BackupRetentionPeriod. |
DBCluster |
DBCluster.withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster |
DBCluster.withPubliclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
|
DBCluster |
DBCluster.withReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster.
|
DBCluster |
DBCluster.withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster |
DBCluster.withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster |
DBCluster.withReplicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
|
DBCluster |
DBCluster.withScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo) |
DBCluster |
DBCluster.withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration) |
DBCluster |
DBCluster.withStatus(String status)
The current state of this DB cluster.
|
DBCluster |
DBCluster.withStorageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
|
DBCluster |
DBCluster.withStorageType(String storageType)
The storage type associated with the DB cluster.
|
DBCluster |
DBCluster.withTagList(Collection<Tag> tagList) |
DBCluster |
DBCluster.withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any).
|
DBCluster |
DBCluster.withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster |
DBCluster.withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
List<DBCluster> |
DescribeDBClustersResult.getDBClusters()
Contains a list of DB clusters for the user.
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDBClustersResult |
DescribeDBClustersResult.withDBClusters(DBCluster... dBClusters)
Contains a list of DB clusters for the user.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DescribeDBClustersResult.setDBClusters(Collection<DBCluster> dBClusters)
Contains a list of DB clusters for the user.
|
DescribeDBClustersResult |
DescribeDBClustersResult.withDBClusters(Collection<DBCluster> dBClusters)
Contains a list of DB clusters for the user.
|
Copyright © 2023. All rights reserved.