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()
Specifies the allocated storage size in gigabytes (GB).
|
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 |
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 |
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 |
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.
|
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.
|
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 |
getStatus()
Specifies the current state of this DB cluster.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of VPC security groups that the DB cluster belongs to.
|
int |
hashCode() |
void |
setAllocatedStorage(Integer allocatedStorage)
Specifies the allocated storage size in gigabytes (GB).
|
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 |
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 |
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 |
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 |
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 |
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 |
setStatus(String status)
Specifies the current state of this DB cluster.
|
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)
Specifies the allocated storage size in gigabytes (GB).
|
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 |
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 |
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 |
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 |
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 |
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 |
withStatus(String status)
Specifies the current state of this DB cluster.
|
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 Integer getAllocatedStorage()
public void setAllocatedStorage(Integer allocatedStorage)
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public DBCluster withAllocatedStorage(Integer allocatedStorage)
Returns a reference to this object so that method calls can be chained together.
allocatedStorage
- Specifies the allocated storage size in gigabytes (GB).public List<String> getAvailabilityZones()
public void setAvailabilityZones(Collection<String> availabilityZones)
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB
cluster can be created in.public DBCluster withAvailabilityZones(String... availabilityZones)
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.
Returns a reference to this object so that method calls can be chained together.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB
cluster can be created in.public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
Returns a reference to this object so that method calls can be chained together.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the DB
cluster can be created in.public Integer getBackupRetentionPeriod()
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
Returns a reference to this object so that method calls can be chained together.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are
retained.public String getCharacterSetName()
public void setCharacterSetName(String characterSetName)
characterSetName
- If present, specifies the name of the character set that this cluster
is associated with.public DBCluster withCharacterSetName(String characterSetName)
Returns a reference to this object so that method calls can be chained together.
characterSetName
- If present, specifies the name of the character set that this cluster
is associated with.public String getDatabaseName()
public void setDatabaseName(String databaseName)
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 DBCluster withDatabaseName(String databaseName)
Returns a reference to this object so that method calls can be chained together.
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 getDBClusterIdentifier()
public void setDBClusterIdentifier(String dBClusterIdentifier)
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
Returns a reference to this object so that method calls can be chained together.
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the
unique key that identifies a DB cluster.public String getDBClusterParameterGroup()
public void setDBClusterParameterGroup(String dBClusterParameterGroup)
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB
cluster.public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
Returns a reference to this object so that method calls can be chained together.
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB
cluster.public String getDBSubnetGroup()
public void setDBSubnetGroup(String dBSubnetGroup)
dBSubnetGroup
- 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)
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB
cluster, including the name, description, and subnets in the subnet
group.public String getStatus()
public void setStatus(String status)
status
- Specifies the current state of this DB cluster.public DBCluster withStatus(String status)
Returns a reference to this object so that method calls can be chained together.
status
- Specifies the current state of this DB cluster.public String getPercentProgress()
public void setPercentProgress(String percentProgress)
percentProgress
- Specifies the progress of the operation as a percentage.public DBCluster withPercentProgress(String percentProgress)
Returns a reference to this object so that method calls can be chained together.
percentProgress
- Specifies the progress of the operation as a percentage.public Date getEarliestRestorableTime()
public void setEarliestRestorableTime(Date earliestRestorableTime)
earliestRestorableTime
- Specifies the earliest time to which a database can be restored with
point-in-time restore.public DBCluster withEarliestRestorableTime(Date earliestRestorableTime)
Returns a reference to this object so that method calls can be chained together.
earliestRestorableTime
- Specifies the earliest time to which a database can be restored with
point-in-time restore.public String getEndpoint()
public void setEndpoint(String endpoint)
endpoint
- Specifies the connection endpoint for the primary instance of the DB
cluster.public DBCluster withEndpoint(String endpoint)
Returns a reference to this object so that method calls can be chained together.
endpoint
- Specifies the connection endpoint for the primary instance of the DB
cluster.public String getEngine()
public void setEngine(String engine)
engine
- Provides the name of the database engine to be used for this DB
cluster.public DBCluster withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- Provides the name of the database engine to be used for this DB
cluster.public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- Indicates the database engine version.public DBCluster withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- Indicates the database engine version.public Date getLatestRestorableTime()
public void setLatestRestorableTime(Date latestRestorableTime)
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.public DBCluster withLatestRestorableTime(Date latestRestorableTime)
Returns a reference to this object so that method calls can be chained together.
latestRestorableTime
- Specifies the latest time to which a database can be restored with
point-in-time restore.public Integer getPort()
public void setPort(Integer port)
port
- Specifies the port that the database engine is listening on.public DBCluster withPort(Integer port)
Returns a reference to this object so that method calls can be chained together.
port
- Specifies the port that the database engine is listening on.public String getMasterUsername()
public void setMasterUsername(String masterUsername)
masterUsername
- Contains the master username for the DB cluster.public DBCluster withMasterUsername(String masterUsername)
Returns a reference to this object so that method calls can be chained together.
masterUsername
- Contains the master username for the DB cluster.public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()
public void setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
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.
Returns a reference to this object so that method calls can be chained together.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Returns a reference to this object so that method calls can be chained together.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public String getPreferredBackupWindow()
BackupRetentionPeriod
.BackupRetentionPeriod
.public void setPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.public DBCluster withPreferredBackupWindow(String preferredBackupWindow)
BackupRetentionPeriod
.
Returns a reference to this object so that method calls can be chained together.
preferredBackupWindow
- Specifies the daily time range during which automated backups are
created if automated backups are enabled, as determined by the
BackupRetentionPeriod
.public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).public DBCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can
occur, in Universal Coordinated Time (UTC).public List<DBClusterMember> getDBClusterMembers()
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
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.
Returns a reference to this object so that method calls can be chained together.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Returns a reference to this object so that method calls can be chained together.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
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.
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.