| Package | Description |
|---|---|
| com.amazonaws.services.docdb |
Amazon DocumentDB API documentation
|
| com.amazonaws.services.docdb.model |
| Modifier and Type | Method and Description |
|---|---|
DBCluster |
AbstractAmazonDocDB.createDBCluster(CreateDBClusterRequest request) |
DBCluster |
AmazonDocDB.createDBCluster(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon DocumentDB cluster.
|
DBCluster |
AmazonDocDBClient.createDBCluster(CreateDBClusterRequest request)
Creates a new Amazon DocumentDB cluster.
|
DBCluster |
AbstractAmazonDocDB.deleteDBCluster(DeleteDBClusterRequest request) |
DBCluster |
AmazonDocDB.deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)
Deletes a previously provisioned cluster.
|
DBCluster |
AmazonDocDBClient.deleteDBCluster(DeleteDBClusterRequest request)
Deletes a previously provisioned cluster.
|
DBCluster |
AbstractAmazonDocDB.failoverDBCluster(FailoverDBClusterRequest request) |
DBCluster |
AmazonDocDB.failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)
Forces a failover for a cluster.
|
DBCluster |
AmazonDocDBClient.failoverDBCluster(FailoverDBClusterRequest request)
Forces a failover for a cluster.
|
DBCluster |
AbstractAmazonDocDB.modifyDBCluster(ModifyDBClusterRequest request) |
DBCluster |
AmazonDocDB.modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster.
|
DBCluster |
AmazonDocDBClient.modifyDBCluster(ModifyDBClusterRequest request)
Modifies a setting for an Amazon DocumentDB cluster.
|
DBCluster |
AbstractAmazonDocDB.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request) |
DBCluster |
AmazonDocDB.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
|
DBCluster |
AmazonDocDBClient.restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
Creates a new cluster from a snapshot or cluster snapshot.
|
DBCluster |
AbstractAmazonDocDB.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request) |
DBCluster |
AmazonDocDB.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time.
|
DBCluster |
AmazonDocDBClient.restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
Restores a cluster to an arbitrary point in time.
|
DBCluster |
AbstractAmazonDocDB.startDBCluster(StartDBClusterRequest request) |
DBCluster |
AmazonDocDB.startDBCluster(StartDBClusterRequest startDBClusterRequest)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
DBCluster |
AmazonDocDBClient.startDBCluster(StartDBClusterRequest request)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
DBCluster |
AbstractAmazonDocDB.stopDBCluster(StopDBClusterRequest request) |
DBCluster |
AmazonDocDB.stopDBCluster(StopDBClusterRequest stopDBClusterRequest)
Stops the running cluster that is specified by
DBClusterIdentifier. |
DBCluster |
AmazonDocDBClient.stopDBCluster(StopDBClusterRequest request)
Stops the running cluster that is specified by
DBClusterIdentifier. |
| Modifier and Type | Method and Description |
|---|---|
DBCluster |
DBCluster.clone() |
DBCluster |
DBCluster.withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
DBCluster |
DBCluster.withAssociatedRoles(DBClusterRole... associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
DBCluster |
DBCluster.withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
DBCluster |
DBCluster.withAvailabilityZones(String... availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
DBCluster |
DBCluster.withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic snapshots are retained.
|
DBCluster |
DBCluster.withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
DBCluster |
DBCluster.withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
DBCluster.withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the cluster.
|
DBCluster |
DBCluster.withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied cluster identifier.
|
DBCluster |
DBCluster.withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the cluster.
|
DBCluster |
DBCluster.withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the cluster.
|
DBCluster |
DBCluster.withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the cluster parameter group for the cluster.
|
DBCluster |
DBCluster.withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the cluster.
|
DBCluster |
DBCluster.withDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group that is associated with the cluster, including the name, description,
and subnets in the subnet group.
|
DBCluster |
DBCluster.withDeletionProtection(Boolean deletionProtection)
Specifies whether this cluster can be deleted.
|
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 cluster is configured to export to Amazon CloudWatch Logs.
|
DBCluster |
DBCluster.withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
|
DBCluster |
DBCluster.withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the cluster.
|
DBCluster |
DBCluster.withEngine(String engine)
Provides the name of the database engine to be used for this cluster.
|
DBCluster |
DBCluster.withEngineVersion(String engineVersion)
Indicates the database engine version.
|
DBCluster |
DBCluster.withHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster |
DBCluster.withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the KMS key identifier for the encrypted cluster. |
DBCluster |
DBCluster.withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
DBCluster |
DBCluster.withMasterUsername(String masterUsername)
Contains the master user name for the cluster.
|
DBCluster |
DBCluster.withMultiAZ(Boolean multiAZ)
Specifies whether the cluster has instances in multiple Availability Zones.
|
DBCluster |
DBCluster.withPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
|
DBCluster |
DBCluster.withPort(Integer port)
Specifies the port that the database engine is listening on.
|
DBCluster |
DBCluster.withPreferredBackupWindow(String preferredBackupWindow)
Specifies 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)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster |
DBCluster.withReaderEndpoint(String readerEndpoint)
The reader endpoint for the cluster.
|
DBCluster |
DBCluster.withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
DBCluster |
DBCluster.withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
DBCluster |
DBCluster.withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source cluster if this cluster is a secondary cluster.
|
DBCluster |
DBCluster.withStatus(String status)
Specifies the current state of this cluster.
|
DBCluster |
DBCluster.withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster is encrypted.
|
DBCluster |
DBCluster.withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
DBCluster |
DBCluster.withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
| Modifier and Type | Method and Description |
|---|---|
List<DBCluster> |
DescribeDBClustersResult.getDBClusters()
A list of clusters.
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDBClustersResult |
DescribeDBClustersResult.withDBClusters(DBCluster... dBClusters)
A list of clusters.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DescribeDBClustersResult.setDBClusters(Collection<DBCluster> dBClusters)
A list of clusters.
|
DescribeDBClustersResult |
DescribeDBClustersResult.withDBClusters(Collection<DBCluster> dBClusters)
A list of clusters.
|
Copyright © 2023. All rights reserved.