Package com.amazonaws.services.rds.model

Class DBCluster

    • Constructor Detail

      • DBCluster

        public DBCluster()

    • Method Detail

      • setAllocatedStorage

        public void setAllocatedStorage​(Integer allocatedStorage)

        Specifies the allocated storage size in gigabytes (GB).

        Parameters:
        allocatedStorage - Specifies the allocated storage size in gigabytes (GB).

      • getAllocatedStorage

        public Integer getAllocatedStorage()

        Specifies the allocated storage size in gigabytes (GB).

        Returns:
        Specifies the allocated storage size in gigabytes (GB).

      • withAllocatedStorage

        public DBCluster withAllocatedStorage​(Integer allocatedStorage)

        Specifies the allocated storage size in gigabytes (GB).

        Parameters:
        allocatedStorage - Specifies the allocated storage size in gigabytes (GB).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getAvailabilityZones

        public List<String> getAvailabilityZones()

        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Returns:
        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

      • setAvailabilityZones

        public void setAvailabilityZones​(Collection<String> availabilityZones)

        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

      • withAvailabilityZones

        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.

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • withAvailabilityZones

        public DBCluster withAvailabilityZones​(Collection<String> availabilityZones)

        Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setBackupRetentionPeriod

        public void setBackupRetentionPeriod​(Integer backupRetentionPeriod)

        Specifies the number of days for which automatic DB snapshots are retained.

        Parameters:
        backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.

      • getBackupRetentionPeriod

        public Integer getBackupRetentionPeriod()

        Specifies the number of days for which automatic DB snapshots are retained.

        Returns:
        Specifies the number of days for which automatic DB snapshots are retained.

      • withBackupRetentionPeriod

        public DBCluster withBackupRetentionPeriod​(Integer backupRetentionPeriod)

        Specifies the number of days for which automatic DB snapshots are retained.

        Parameters:
        backupRetentionPeriod - Specifies the number of days for which automatic DB snapshots are retained.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setCharacterSetName

        public void setCharacterSetName​(String characterSetName)

        If present, specifies the name of the character set that this cluster is associated with.

        Parameters:
        characterSetName - If present, specifies the name of the character set that this cluster is associated with.

      • getCharacterSetName

        public String getCharacterSetName()

        If present, specifies the name of the character set that this cluster is associated with.

        Returns:
        If present, specifies the name of the character set that this cluster is associated with.

      • withCharacterSetName

        public DBCluster withCharacterSetName​(String characterSetName)

        If present, specifies the name of the character set that this cluster is associated with.

        Parameters:
        characterSetName - If present, specifies the name of the character set that this cluster is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setDatabaseName

        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.

        Parameters:
        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.

      • getDatabaseName

        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.

        Returns:
        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.

      • withDatabaseName

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setDBClusterIdentifier

        public void setDBClusterIdentifier​(String dBClusterIdentifier)

        Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        Parameters:
        dBClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

      • getDBClusterIdentifier

        public String getDBClusterIdentifier()

        Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        Returns:
        Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

      • withDBClusterIdentifier

        public DBCluster withDBClusterIdentifier​(String dBClusterIdentifier)

        Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        Parameters:
        dBClusterIdentifier - Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setDBClusterParameterGroup

        public void setDBClusterParameterGroup​(String dBClusterParameterGroup)

        Specifies the name of the DB cluster parameter group for the DB cluster.

        Parameters:
        dBClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.

      • getDBClusterParameterGroup

        public String getDBClusterParameterGroup()

        Specifies the name of the DB cluster parameter group for the DB cluster.

        Returns:
        Specifies the name of the DB cluster parameter group for the DB cluster.

      • withDBClusterParameterGroup

        public DBCluster withDBClusterParameterGroup​(String dBClusterParameterGroup)

        Specifies the name of the DB cluster parameter group for the DB cluster.

        Parameters:
        dBClusterParameterGroup - Specifies the name of the DB cluster parameter group for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setDBSubnetGroup

        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.

        Parameters:
        dBSubnetGroup - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

      • getDBSubnetGroup

        public String getDBSubnetGroup()

        Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        Returns:
        Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

      • withDBSubnetGroup

        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.

        Parameters:
        dBSubnetGroup - Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setStatus

        public void setStatus​(String status)

        Specifies the current state of this DB cluster.

        Parameters:
        status - Specifies the current state of this DB cluster.

      • getStatus

        public String getStatus()

        Specifies the current state of this DB cluster.

        Returns:
        Specifies the current state of this DB cluster.

      • withStatus

        public DBCluster withStatus​(String status)

        Specifies the current state of this DB cluster.

        Parameters:
        status - Specifies the current state of this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPercentProgress

        public void setPercentProgress​(String percentProgress)

        Specifies the progress of the operation as a percentage.

        Parameters:
        percentProgress - Specifies the progress of the operation as a percentage.

      • getPercentProgress

        public String getPercentProgress()

        Specifies the progress of the operation as a percentage.

        Returns:
        Specifies the progress of the operation as a percentage.

      • withPercentProgress

        public DBCluster withPercentProgress​(String percentProgress)

        Specifies the progress of the operation as a percentage.

        Parameters:
        percentProgress - Specifies the progress of the operation as a percentage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setEarliestRestorableTime

        public void setEarliestRestorableTime​(Date earliestRestorableTime)

        Specifies the earliest time to which a database can be restored with point-in-time restore.

        Parameters:
        earliestRestorableTime - Specifies the earliest time to which a database can be restored with point-in-time restore.

      • getEarliestRestorableTime

        public Date getEarliestRestorableTime()

        Specifies the earliest time to which a database can be restored with point-in-time restore.

        Returns:
        Specifies the earliest time to which a database can be restored with point-in-time restore.

      • withEarliestRestorableTime

        public DBCluster withEarliestRestorableTime​(Date earliestRestorableTime)

        Specifies the earliest time to which a database can be restored with point-in-time restore.

        Parameters:
        earliestRestorableTime - Specifies the earliest time to which a database can be restored with point-in-time restore.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setEndpoint

        public void setEndpoint​(String endpoint)

        Specifies the connection endpoint for the primary instance of the DB cluster.

        Parameters:
        endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.

      • getEndpoint

        public String getEndpoint()

        Specifies the connection endpoint for the primary instance of the DB cluster.

        Returns:
        Specifies the connection endpoint for the primary instance of the DB cluster.

      • withEndpoint

        public DBCluster withEndpoint​(String endpoint)

        Specifies the connection endpoint for the primary instance of the DB cluster.

        Parameters:
        endpoint - Specifies the connection endpoint for the primary instance of the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setEngine

        public void setEngine​(String engine)

        Provides the name of the database engine to be used for this DB cluster.

        Parameters:
        engine - Provides the name of the database engine to be used for this DB cluster.

      • getEngine

        public String getEngine()

        Provides the name of the database engine to be used for this DB cluster.

        Returns:
        Provides the name of the database engine to be used for this DB cluster.

      • withEngine

        public DBCluster withEngine​(String engine)

        Provides the name of the database engine to be used for this DB cluster.

        Parameters:
        engine - Provides the name of the database engine to be used for this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setEngineVersion

        public void setEngineVersion​(String engineVersion)

        Indicates the database engine version.

        Parameters:
        engineVersion - Indicates the database engine version.

      • getEngineVersion

        public String getEngineVersion()

        Indicates the database engine version.

        Returns:
        Indicates the database engine version.

      • withEngineVersion

        public DBCluster withEngineVersion​(String engineVersion)

        Indicates the database engine version.

        Parameters:
        engineVersion - Indicates the database engine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setLatestRestorableTime

        public void setLatestRestorableTime​(Date latestRestorableTime)

        Specifies the latest time to which a database can be restored with point-in-time restore.

        Parameters:
        latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

      • getLatestRestorableTime

        public Date getLatestRestorableTime()

        Specifies the latest time to which a database can be restored with point-in-time restore.

        Returns:
        Specifies the latest time to which a database can be restored with point-in-time restore.

      • withLatestRestorableTime

        public DBCluster withLatestRestorableTime​(Date latestRestorableTime)

        Specifies the latest time to which a database can be restored with point-in-time restore.

        Parameters:
        latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPort

        public void setPort​(Integer port)

        Specifies the port that the database engine is listening on.

        Parameters:
        port - Specifies the port that the database engine is listening on.

      • getPort

        public Integer getPort()

        Specifies the port that the database engine is listening on.

        Returns:
        Specifies the port that the database engine is listening on.

      • withPort

        public DBCluster withPort​(Integer port)

        Specifies the port that the database engine is listening on.

        Parameters:
        port - Specifies the port that the database engine is listening on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setMasterUsername

        public void setMasterUsername​(String masterUsername)

        Contains the master username for the DB cluster.

        Parameters:
        masterUsername - Contains the master username for the DB cluster.

      • getMasterUsername

        public String getMasterUsername()

        Contains the master username for the DB cluster.

        Returns:
        Contains the master username for the DB cluster.

      • withMasterUsername

        public DBCluster withMasterUsername​(String masterUsername)

        Contains the master username for the DB cluster.

        Parameters:
        masterUsername - Contains the master username for the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getDBClusterOptionGroupMemberships

        public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()

        Provides the list of option group memberships for this DB cluster.

        Returns:
        Provides the list of option group memberships for this DB cluster.

      • setDBClusterOptionGroupMemberships

        public void setDBClusterOptionGroupMemberships​(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)

        Provides the list of option group memberships for this DB cluster.

        Parameters:
        dBClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.

      • withDBClusterOptionGroupMemberships

        public DBCluster withDBClusterOptionGroupMemberships​(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)

        Provides the list of option group memberships for this DB cluster.

        Parameters:
        dBClusterOptionGroupMemberships - Provides the list of option group memberships for this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPreferredBackupWindow

        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.

        Parameters:
        preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

      • getPreferredBackupWindow

        public String getPreferredBackupWindow()

        Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        Returns:
        Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

      • withPreferredBackupWindow

        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.

        Parameters:
        preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setPreferredMaintenanceWindow

        public void setPreferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      • getPreferredMaintenanceWindow

        public String getPreferredMaintenanceWindow()

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Returns:
        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      • withPreferredMaintenanceWindow

        public DBCluster withPreferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getDBClusterMembers

        public List<DBClusterMember> getDBClusterMembers()

        Provides the list of instances that make up the DB cluster.

        Returns:
        Provides the list of instances that make up the DB cluster.

      • setDBClusterMembers

        public void setDBClusterMembers​(Collection<DBClusterMember> dBClusterMembers)

        Provides the list of instances that make up the DB cluster.

        Parameters:
        dBClusterMembers - Provides the list of instances that make up the DB cluster.

      • withDBClusterMembers

        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.

        Parameters:
        dBClusterMembers - Provides the list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • withDBClusterMembers

        public DBCluster withDBClusterMembers​(Collection<DBClusterMember> dBClusterMembers)

        Provides the list of instances that make up the DB cluster.

        Parameters:
        dBClusterMembers - Provides the list of instances that make up the DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • getVpcSecurityGroups

        public List<VpcSecurityGroupMembership> getVpcSecurityGroups()

        Provides a list of VPC security groups that the DB cluster belongs to.

        Returns:
        Provides a list of VPC security groups that the DB cluster belongs to.

      • setVpcSecurityGroups

        public void setVpcSecurityGroups​(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

        Provides a list of VPC security groups that the DB cluster belongs to.

        Parameters:
        vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.

      • withVpcSecurityGroups

        public DBCluster withVpcSecurityGroups​(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

        Provides a list of VPC security groups that the DB cluster belongs to.

        Parameters:
        vpcSecurityGroups - Provides a list of VPC security groups that the DB cluster belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setHostedZoneId

        public void setHostedZoneId​(String hostedZoneId)

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        Parameters:
        hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

      • getHostedZoneId

        public String getHostedZoneId()

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        Returns:
        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

      • withHostedZoneId

        public DBCluster withHostedZoneId​(String hostedZoneId)

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        Parameters:
        hostedZoneId - Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setStorageEncrypted

        public void setStorageEncrypted​(Boolean storageEncrypted)

        Specifies whether the DB cluster is encrypted.

        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted.

      • getStorageEncrypted

        public Boolean getStorageEncrypted()

        Specifies whether the DB cluster is encrypted.

        Returns:
        Specifies whether the DB cluster is encrypted.

      • withStorageEncrypted

        public DBCluster withStorageEncrypted​(Boolean storageEncrypted)

        Specifies whether the DB cluster is encrypted.

        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isStorageEncrypted

        public Boolean isStorageEncrypted()

        Specifies whether the DB cluster is encrypted.

        Returns:
        Specifies whether the DB cluster is encrypted.

      • setKmsKeyId

        public void setKmsKeyId​(String kmsKeyId)

        If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

        Parameters:
        kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

      • getKmsKeyId

        public String getKmsKeyId()

        If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

        Returns:
        If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

      • withKmsKeyId

        public DBCluster withKmsKeyId​(String kmsKeyId)

        If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

        Parameters:
        kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • setDbClusterResourceId

        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.

        Parameters:
        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.

      • getDbClusterResourceId

        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.

        Returns:
        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.

      • withDbClusterResourceId

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object