@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBCluster extends Object implements Serializable, Cloneable
Detailed information about a cluster.
Constructor and Description |
---|
DBCluster() |
Modifier and Type | Method and Description |
---|---|
DBCluster |
clone() |
boolean |
equals(Object obj) |
List<DBClusterRole> |
getAssociatedRoles()
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
List<String> |
getAvailabilityZones()
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
Integer |
getBackupRetentionPeriod()
Specifies the number of days for which automatic snapshots are retained.
|
String |
getCloneGroupId()
Identifies the clone group to which the DB cluster is associated.
|
Date |
getClusterCreateTime()
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
String |
getDBClusterArn()
The Amazon Resource Name (ARN) for the cluster.
|
String |
getDBClusterIdentifier()
Contains a user-supplied cluster identifier.
|
List<DBClusterMember> |
getDBClusterMembers()
Provides the list of instances that make up the cluster.
|
String |
getDBClusterParameterGroup()
Specifies the name of the cluster parameter group for the cluster.
|
String |
getDbClusterResourceId()
The Amazon Web Services Region-unique, immutable identifier for the cluster.
|
String |
getDBSubnetGroup()
Specifies information on the subnet group that is associated with the cluster, including the name, description,
and subnets in the subnet group.
|
Boolean |
getDeletionProtection()
Specifies whether this cluster can be deleted.
|
Date |
getEarliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
|
List<String> |
getEnabledCloudwatchLogsExports()
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
|
String |
getEndpoint()
Specifies the connection endpoint for the primary instance of the cluster.
|
String |
getEngine()
Provides the name of the database engine to be used for this cluster.
|
String |
getEngineVersion()
Indicates the database engine version.
|
String |
getHostedZoneId()
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
String |
getKmsKeyId()
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster. |
Date |
getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
|
String |
getMasterUsername()
Contains the master user name for the cluster.
|
Boolean |
getMultiAZ()
Specifies whether the cluster has instances in multiple Availability Zones.
|
String |
getPercentProgress()
Specifies the progress of the operation as a percentage.
|
Integer |
getPort()
Specifies the port that the database engine is listening on.
|
String |
getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
getReaderEndpoint()
The reader endpoint for the cluster.
|
List<String> |
getReadReplicaIdentifiers()
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
String |
getReplicationSourceIdentifier()
Contains the identifier of the source cluster if this cluster is a secondary cluster.
|
String |
getStatus()
Specifies the current state of this cluster.
|
Boolean |
getStorageEncrypted()
Specifies whether the cluster is encrypted.
|
String |
getStorageType()
Storage type associated with your cluster
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
int |
hashCode() |
Boolean |
isDeletionProtection()
Specifies whether this cluster can be deleted.
|
Boolean |
isMultiAZ()
Specifies whether the cluster has instances in multiple Availability Zones.
|
Boolean |
isStorageEncrypted()
Specifies whether the cluster is encrypted.
|
void |
setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic snapshots are retained.
|
void |
setCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
void |
setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
void |
setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied cluster identifier.
|
void |
setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the cluster.
|
void |
setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the cluster parameter group for the cluster.
|
void |
setDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the cluster.
|
void |
setDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group that is associated with the cluster, including the name, description,
and subnets in the subnet group.
|
void |
setDeletionProtection(Boolean deletionProtection)
Specifies whether this cluster can be deleted.
|
void |
setEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
void |
setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
|
void |
setEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the cluster.
|
void |
setEngine(String engine)
Provides the name of the database engine to be used for this cluster.
|
void |
setEngineVersion(String engineVersion)
Indicates the database engine version.
|
void |
setHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster. |
void |
setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
void |
setMasterUsername(String masterUsername)
Contains the master user name for the cluster.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies whether the cluster has instances in multiple Availability Zones.
|
void |
setPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
|
void |
setPort(Integer port)
Specifies the port that the database engine is listening on.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setReaderEndpoint(String readerEndpoint)
The reader endpoint for the cluster.
|
void |
setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
void |
setReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source cluster if this cluster is a secondary cluster.
|
void |
setStatus(String status)
Specifies the current state of this cluster.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster is encrypted.
|
void |
setStorageType(String storageType)
Storage type associated with your cluster
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
String |
toString()
Returns a string representation of this object.
|
DBCluster |
withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
DBCluster |
withAssociatedRoles(DBClusterRole... associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
|
DBCluster |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
DBCluster |
withAvailabilityZones(String... availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
|
DBCluster |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic snapshots are retained.
|
DBCluster |
withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
DBCluster |
withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the cluster.
|
DBCluster |
withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied cluster identifier.
|
DBCluster |
withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the cluster.
|
DBCluster |
withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the cluster.
|
DBCluster |
withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the cluster parameter group for the cluster.
|
DBCluster |
withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the cluster.
|
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 |
withDeletionProtection(Boolean deletionProtection)
Specifies whether this cluster can be deleted.
|
DBCluster |
withEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
|
DBCluster |
withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
|
DBCluster |
withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the cluster.
|
DBCluster |
withEngine(String engine)
Provides the name of the database engine to be used for this cluster.
|
DBCluster |
withEngineVersion(String engineVersion)
Indicates the database engine version.
|
DBCluster |
withHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true , the KMS key identifier for the encrypted cluster. |
DBCluster |
withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withMasterUsername(String masterUsername)
Contains the master user name for the cluster.
|
DBCluster |
withMultiAZ(Boolean multiAZ)
Specifies whether the cluster has instances in multiple Availability Zones.
|
DBCluster |
withPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
|
DBCluster |
withPort(Integer port)
Specifies the port that the database engine is listening on.
|
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 |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster |
withReaderEndpoint(String readerEndpoint)
The reader endpoint for the cluster.
|
DBCluster |
withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
DBCluster |
withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
|
DBCluster |
withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source cluster if this cluster is a secondary cluster.
|
DBCluster |
withStatus(String status)
Specifies the current state of this cluster.
|
DBCluster |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster is encrypted.
|
DBCluster |
withStorageType(String storageType)
Storage type associated with your cluster
|
DBCluster |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
DBCluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
|
public List<String> getAvailabilityZones()
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.public DBCluster withAvailabilityZones(String... availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
availabilityZones
- Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic snapshots are retained.public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic snapshots are retained.
public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic snapshots are retained.public void setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
dBClusterIdentifier
- Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.public String getDBClusterIdentifier()
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
dBClusterIdentifier
- Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.public void setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the cluster parameter group for the cluster.
dBClusterParameterGroup
- Specifies the name of the cluster parameter group for the cluster.public String getDBClusterParameterGroup()
Specifies the name of the cluster parameter group for the cluster.
public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the cluster parameter group for the cluster.
dBClusterParameterGroup
- Specifies the name of the cluster parameter group for the cluster.public void setDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group that is associated with the cluster, including the name,
description, and subnets in the subnet group.public String getDBSubnetGroup()
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
public 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.
dBSubnetGroup
- Specifies information on the subnet group that is associated with the cluster, including the name,
description, and subnets in the subnet group.public void setStatus(String status)
Specifies the current state of this cluster.
status
- Specifies the current state of this cluster.public String getStatus()
Specifies the current state of this cluster.
public DBCluster withStatus(String status)
Specifies the current state of this cluster.
status
- Specifies the current state of this cluster.public void setPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
percentProgress
- Specifies the progress of the operation as a percentage.public String getPercentProgress()
Specifies the progress of the operation as a percentage.
public DBCluster withPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
percentProgress
- Specifies the progress of the operation as a percentage.public void setEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time restore.public Date getEarliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
public DBCluster withEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time restore.public void setEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the cluster.public String getEndpoint()
Specifies the connection endpoint for the primary instance of the cluster.
public DBCluster withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the cluster.public void setReaderEndpoint(String readerEndpoint)
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across
the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the
reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB
replicas in the cluster. This functionality can help balance your read workload across multiple Amazon
DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
public String getReaderEndpoint()
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
public DBCluster withReaderEndpoint(String readerEndpoint)
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across
the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the
reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB
replicas in the cluster. This functionality can help balance your read workload across multiple Amazon
DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
public void setMultiAZ(Boolean multiAZ)
Specifies whether the cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the cluster has instances in multiple Availability Zones.public Boolean getMultiAZ()
Specifies whether the cluster has instances in multiple Availability Zones.
public DBCluster withMultiAZ(Boolean multiAZ)
Specifies whether the cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the cluster has instances in multiple Availability Zones.public Boolean isMultiAZ()
Specifies whether the cluster has instances in multiple Availability Zones.
public void setEngine(String engine)
Provides the name of the database engine to be used for this cluster.
engine
- Provides the name of the database engine to be used for this cluster.public String getEngine()
Provides the name of the database engine to be used for this cluster.
public DBCluster withEngine(String engine)
Provides the name of the database engine to be used for this cluster.
engine
- Provides the name of the database engine to be used for this cluster.public void setEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public String getEngineVersion()
Indicates the database engine version.
public DBCluster withEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public void setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public Date getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public DBCluster withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public void setPort(Integer port)
Specifies the port that the database engine is listening on.
port
- Specifies the port that the database engine is listening on.public Integer getPort()
Specifies the port that the database engine is listening on.
public DBCluster withPort(Integer port)
Specifies the port that the database engine is listening on.
port
- Specifies the port that the database engine is listening on.public void setMasterUsername(String masterUsername)
Contains the master user name for the cluster.
masterUsername
- Contains the master user name for the cluster.public String getMasterUsername()
Contains the master user name for the cluster.
public DBCluster withMasterUsername(String masterUsername)
Contains the master user name for the cluster.
masterUsername
- Contains the master user name for the cluster.public void setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public String getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
BackupRetentionPeriod
.public 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
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public DBCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public void setReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source cluster if this cluster is a secondary cluster.
replicationSourceIdentifier
- Contains the identifier of the source cluster if this cluster is a secondary cluster.public String getReplicationSourceIdentifier()
Contains the identifier of the source cluster if this cluster is a secondary cluster.
public DBCluster withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source cluster if this cluster is a secondary cluster.
replicationSourceIdentifier
- Contains the identifier of the source cluster if this cluster is a secondary cluster.public List<String> getReadReplicaIdentifiers()
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
public void setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the secondary clusters that are associated with this cluster.public DBCluster withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaIdentifiers(java.util.Collection)
or
withReadReplicaIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaIdentifiers
- Contains one or more identifiers of the secondary clusters that are associated with this cluster.public DBCluster withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the secondary clusters that are associated with this cluster.public List<DBClusterMember> getDBClusterMembers()
Provides the list of instances that make up the cluster.
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the cluster.
dBClusterMembers
- Provides the list of instances that make up the cluster.public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setDBClusterMembers(java.util.Collection)
or withDBClusterMembers(java.util.Collection)
if you
want to override the existing values.
dBClusterMembers
- Provides the list of instances that make up the cluster.public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the cluster.
dBClusterMembers
- Provides the list of instances that make up the cluster.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
vpcSecurityGroups
- Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
vpcSecurityGroups
- Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
vpcSecurityGroups
- Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.public void setHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.public String getHostedZoneId()
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
public DBCluster withHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster is encrypted.
storageEncrypted
- Specifies whether the cluster is encrypted.public Boolean getStorageEncrypted()
Specifies whether the cluster is encrypted.
public DBCluster withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the cluster is encrypted.
storageEncrypted
- Specifies whether the cluster is encrypted.public Boolean isStorageEncrypted()
Specifies whether the cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.
kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.public String getKmsKeyId()
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.
StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.public DBCluster withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.
kmsKeyId
- If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster.public void setDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in
CloudTrail log entries whenever the KMS key for the cluster is accessed.public String getDbClusterResourceId()
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
public DBCluster withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in
CloudTrail log entries whenever the KMS key for the cluster is accessed.public void setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the cluster.public String getDBClusterArn()
The Amazon Resource Name (ARN) for the cluster.
public DBCluster withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the cluster.public List<DBClusterRole> getAssociatedRoles()
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
public void setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
associatedRoles
- Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
(IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web
Services services on your behalf.public DBCluster withAssociatedRoles(DBClusterRole... associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
NOTE: This method appends the values to the existing list (if any). Use
setAssociatedRoles(java.util.Collection)
or withAssociatedRoles(java.util.Collection)
if you
want to override the existing values.
associatedRoles
- Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
(IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web
Services services on your behalf.public DBCluster withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
associatedRoles
- Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
(IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web
Services services on your behalf.public void setCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
cloneGroupId
- Identifies the clone group to which the DB cluster is associated.public String getCloneGroupId()
Identifies the clone group to which the DB cluster is associated.
public DBCluster withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
cloneGroupId
- Identifies the clone group to which the DB cluster is associated.public void setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
public DBCluster withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).public List<String> getEnabledCloudwatchLogsExports()
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
public void setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
enabledCloudwatchLogsExports
- A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.public DBCluster withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
NOTE: This method appends the values to the existing list (if any). Use
setEnabledCloudwatchLogsExports(java.util.Collection)
or
withEnabledCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enabledCloudwatchLogsExports
- A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.public DBCluster withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
enabledCloudwatchLogsExports
- A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.public void setDeletionProtection(Boolean deletionProtection)
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot
be deleted unless it is modified and DeletionProtection
is disabled. DeletionProtection
protects clusters from being accidentally deleted.
deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster
cannot be deleted unless it is modified and DeletionProtection
is disabled.
DeletionProtection
protects clusters from being accidentally deleted.public Boolean getDeletionProtection()
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot
be deleted unless it is modified and DeletionProtection
is disabled. DeletionProtection
protects clusters from being accidentally deleted.
DeletionProtection
is enabled, the cluster
cannot be deleted unless it is modified and DeletionProtection
is disabled.
DeletionProtection
protects clusters from being accidentally deleted.public DBCluster withDeletionProtection(Boolean deletionProtection)
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot
be deleted unless it is modified and DeletionProtection
is disabled. DeletionProtection
protects clusters from being accidentally deleted.
deletionProtection
- Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster
cannot be deleted unless it is modified and DeletionProtection
is disabled.
DeletionProtection
protects clusters from being accidentally deleted.public Boolean isDeletionProtection()
Specifies whether this cluster can be deleted. If DeletionProtection
is enabled, the cluster cannot
be deleted unless it is modified and DeletionProtection
is disabled. DeletionProtection
protects clusters from being accidentally deleted.
DeletionProtection
is enabled, the cluster
cannot be deleted unless it is modified and DeletionProtection
is disabled.
DeletionProtection
protects clusters from being accidentally deleted.public void setStorageType(String storageType)
Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
storageType
- Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public String getStorageType()
Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public DBCluster withStorageType(String storageType)
Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
storageType
- Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
public String toString()
toString
in class Object
Object.toString()