@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBCluster extends Object implements Serializable, Cloneable
Contains the result of a successful invocation of the following actions:
This data type is used as a response element in the DescribeDBClusters action.
Constructor and Description |
---|
DBCluster() |
Modifier and Type | Method and Description |
---|---|
DBCluster |
clone() |
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gigabytes (GB). |
List<DBClusterRole> |
getAssociatedRoles()
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
List<String> |
getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
Integer |
getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
|
String |
getCharacterSetName()
If present, specifies the name of the character set that this cluster is associated with.
|
String |
getCloneGroupId()
Identifies the clone group to which the DB cluster is associated.
|
Date |
getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
String |
getDatabaseName()
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
String |
getDBClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
|
String |
getDBClusterIdentifier()
Contains a user-supplied DB cluster identifier.
|
List<DBClusterMember> |
getDBClusterMembers()
Provides the list of instances that make up the DB cluster.
|
List<DBClusterOptionGroupStatus> |
getDBClusterOptionGroupMemberships()
Provides the list of option group memberships for this DB cluster.
|
String |
getDBClusterParameterGroup()
Specifies the name of the DB cluster parameter group for the DB cluster.
|
String |
getDbClusterResourceId()
The region-unique, immutable identifier for the DB cluster.
|
String |
getDBSubnetGroup()
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
Date |
getEarliestRestorableTime()
Specifies the earliest time to which a database can be restored with point-in-time restore.
|
String |
getEndpoint()
Specifies the connection endpoint for the primary instance of the DB cluster.
|
String |
getEngine()
Provides the name of the database engine to be used for this DB cluster.
|
String |
getEngineVersion()
Indicates the database engine version.
|
String |
getHostedZoneId()
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
String |
getKmsKeyId()
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster. |
Date |
getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
|
String |
getMasterUsername()
Contains the master username for the DB cluster.
|
Boolean |
getMultiAZ()
Specifies whether the DB 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 DB cluster.
|
List<String> |
getReadReplicaIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
String |
getReplicationSourceIdentifier()
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
|
String |
getStatus()
Specifies the current state of this DB cluster.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of VPC security groups that the DB cluster belongs to.
|
int |
hashCode() |
Boolean |
isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
Boolean |
isMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB cluster is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gigabytes (GB). |
void |
setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
|
void |
setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
void |
setCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
void |
setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
void |
setDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
void |
setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier.
|
void |
setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
void |
setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
void |
setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
|
void |
setDbClusterResourceId(String dbClusterResourceId)
The region-unique, immutable identifier for the DB cluster.
|
void |
setDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
void |
setEarliestRestorableTime(Date earliestRestorableTime)
Specifies the earliest time to which a database can be restored with point-in-time restore.
|
void |
setEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
|
void |
setEngine(String engine)
Provides the name of the database engine to be used for this DB 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 |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB 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 username for the DB cluster.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies whether the DB 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 DB cluster.
|
void |
setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
void |
setReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
|
void |
setStatus(String status)
Specifies the current state of this DB cluster.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
DBCluster |
withAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gigabytes (GB). |
DBCluster |
withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
DBCluster |
withAssociatedRoles(DBClusterRole... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
|
DBCluster |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
DBCluster |
withAvailabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
|
DBCluster |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
|
DBCluster |
withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster |
withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
DBCluster |
withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
withDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
DBCluster |
withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster |
withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier.
|
DBCluster |
withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster |
withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
|
DBCluster |
withDbClusterResourceId(String dbClusterResourceId)
The region-unique, immutable identifier for the DB cluster.
|
DBCluster |
withDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
DBCluster |
withEarliestRestorableTime(Date earliestRestorableTime)
Specifies the earliest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
|
DBCluster |
withEngine(String engine)
Provides the name of the database engine to be used for this DB 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 |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise
false.
|
DBCluster |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is true, the KMS key identifier for the encrypted DB 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 username for the DB cluster.
|
DBCluster |
withMultiAZ(Boolean multiAZ)
Specifies whether the DB 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 DB cluster.
|
DBCluster |
withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
DBCluster |
withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
|
DBCluster |
withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
|
DBCluster |
withStatus(String status)
Specifies the current state of this DB cluster.
|
DBCluster |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
DBCluster |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
DBCluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
|
public void setAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size is not fixed, but instead automatically adjusts as needed.
allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated
storage size in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora
DB cluster storage size is not fixed, but instead automatically adjusts as needed.public Integer getAllocatedStorage()
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size is not fixed, but instead automatically adjusts as needed.
AllocatedStorage
specifies the allocated
storage size in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because
Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.public DBCluster withAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size is not fixed, but instead automatically adjusts as needed.
allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated
storage size in gigabytes (GB). For Aurora, AllocatedStorage
always returns 1, because Aurora
DB cluster storage size is not fixed, but instead automatically adjusts as needed.public List<String> getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.public DBCluster withAvailabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB 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 EC2 Availability Zones that instances in the DB cluster can be created in.public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public void setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.public String getCharacterSetName()
If present, specifies the name of the character set that this cluster is associated with.
public DBCluster withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.public void setDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
databaseName
- Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created. This same name is returned for the life of the DB cluster.public String getDatabaseName()
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
public DBCluster withDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
databaseName
- Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created. This same name is returned for the life of the DB cluster.public void setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB
cluster.public String getDBClusterIdentifier()
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB
cluster.public void setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.public String getDBClusterParameterGroup()
Specifies the name of the DB cluster parameter group for the DB cluster.
public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.public void setDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.public String getDBSubnetGroup()
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public DBCluster withDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.public void setStatus(String status)
Specifies the current state of this DB cluster.
status
- Specifies the current state of this DB cluster.public String getStatus()
Specifies the current state of this DB cluster.
public DBCluster withStatus(String status)
Specifies the current state of this DB cluster.
status
- Specifies the current state of this DB 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)
Specifies the earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- Specifies the earliest time to which a database can be restored with point-in-time restore.public Date getEarliestRestorableTime()
Specifies the earliest time to which a database can be restored with point-in-time restore.
public DBCluster withEarliestRestorableTime(Date earliestRestorableTime)
Specifies the earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- Specifies 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 DB cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the DB cluster.public String getEndpoint()
Specifies the connection endpoint for the primary instance of the DB cluster.
public DBCluster withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the DB cluster.public void setReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections
across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster.
This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public String getReaderEndpoint()
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public DBCluster withReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections
across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster.
This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public void setMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the DB cluster has instances in multiple Availability Zones.public Boolean getMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
public DBCluster withMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the DB cluster has instances in multiple Availability Zones.public Boolean isMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
public void setEngine(String engine)
Provides the name of the database engine to be used for this DB cluster.
engine
- Provides the name of the database engine to be used for this DB cluster.public String getEngine()
Provides the name of the database engine to be used for this DB cluster.
public DBCluster withEngine(String engine)
Provides the name of the database engine to be used for this DB cluster.
engine
- Provides the name of the database engine to be used for this DB 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 username for the DB cluster.
masterUsername
- Contains the master username for the DB cluster.public String getMasterUsername()
Contains the master username for the DB cluster.
public DBCluster withMasterUsername(String masterUsername)
Contains the master username for the DB cluster.
masterUsername
- Contains the master username for the DB cluster.public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()
Provides the list of option group memberships for this DB cluster.
public void setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setDBClusterOptionGroupMemberships(java.util.Collection)
or
withDBClusterOptionGroupMemberships(java.util.Collection)
if you want to override the existing values.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB 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 DB cluster if this DB cluster is a Read Replica.
replicationSourceIdentifier
- Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.public String getReplicationSourceIdentifier()
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
public DBCluster withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
replicationSourceIdentifier
- Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.public List<String> getReadReplicaIdentifiers()
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
public void setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB cluster.public DBCluster withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB 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 Read Replicas associated with this DB cluster.public DBCluster withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the Read Replicas associated with this DB cluster.public List<DBClusterMember> getDBClusterMembers()
Provides the list of instances that make up the DB cluster.
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the DB 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 DB cluster.public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides a list of VPC security groups that the DB cluster belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a list of VPC security groups that the DB 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 VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB 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 DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
public DBCluster withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean isStorageEncrypted()
Specifies whether the DB cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.
kmsKeyId
- If StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.public String getKmsKeyId()
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.
StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.public DBCluster withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.
kmsKeyId
- If StorageEncrypted
is true, the KMS key identifier for the encrypted DB cluster.public void setDbClusterResourceId(String dbClusterResourceId)
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
dbClusterResourceId
- The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log
entries whenever the KMS key for the DB cluster is accessed.public String getDbClusterResourceId()
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
public DBCluster withDbClusterResourceId(String dbClusterResourceId)
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
dbClusterResourceId
- The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log
entries whenever the KMS key for the DB cluster is accessed.public void setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.public String getDBClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
public DBCluster withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.public List<DBClusterRole> getAssociatedRoles()
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
public void setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other AWS services on your behalf.public DBCluster withAssociatedRoles(DBClusterRole... associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS 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 AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other AWS services on your behalf.public DBCluster withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
associatedRoles
- Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB
cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other AWS services on your behalf.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.public Boolean getIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
public DBCluster withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
iAMDatabaseAuthenticationEnabled
- True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled;
otherwise false.public Boolean isIAMDatabaseAuthenticationEnabled()
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
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 DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
public DBCluster withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.