Package software.amazon.awssdk.services.rds.model

Interface DBClusterSnapshot.Builder

    • Method Detail

      • availabilityZones

        DBClusterSnapshot.Builder availabilityZones​(Collection<String> availabilityZones)

        The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

        Parameters:
        availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        DBClusterSnapshot.Builder availabilityZones​(String... availabilityZones)

        The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

        Parameters:
        availabilityZones - The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterSnapshotIdentifier

        DBClusterSnapshot.Builder dbClusterSnapshotIdentifier​(String dbClusterSnapshotIdentifier)

        The identifier for the DB cluster snapshot.

        Parameters:
        dbClusterSnapshotIdentifier - The identifier for the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterIdentifier

        DBClusterSnapshot.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        Parameters:
        dbClusterIdentifier - The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotCreateTime

        DBClusterSnapshot.Builder snapshotCreateTime​(Instant snapshotCreateTime)

        The time when the snapshot was taken, in Universal Coordinated Time (UTC).

        Parameters:
        snapshotCreateTime - The time when the snapshot was taken, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        DBClusterSnapshot.Builder engine​(String engine)

        The name of the database engine for this DB cluster snapshot.

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

      • engineMode

        DBClusterSnapshot.Builder engineMode​(String engineMode)

        The engine mode of the database engine for this DB cluster snapshot.

        Parameters:
        engineMode - The engine mode of the database engine for this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        DBClusterSnapshot.Builder allocatedStorage​(Integer allocatedStorage)

        The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

        Parameters:
        allocatedStorage - The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        DBClusterSnapshot.Builder status​(String status)

        The status of this DB cluster snapshot. Valid statuses are the following:

        • available

        • copying

        • creating

        Parameters:
        status - The status of this DB cluster snapshot. Valid statuses are the following:

        • available

        • copying

        • creating

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        DBClusterSnapshot.Builder port​(Integer port)

        The port that the DB cluster was listening on at the time of the snapshot.

        Parameters:
        port - The port that the DB cluster was listening on at the time of the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcId

        DBClusterSnapshot.Builder vpcId​(String vpcId)

        The VPC ID associated with the DB cluster snapshot.

        Parameters:
        vpcId - The VPC ID associated with the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterCreateTime

        DBClusterSnapshot.Builder clusterCreateTime​(Instant clusterCreateTime)

        The time when the DB cluster was created, in Universal Coordinated Time (UTC).

        Parameters:
        clusterCreateTime - The time when the DB cluster was created, in Universal Coordinated Time (UTC).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        DBClusterSnapshot.Builder masterUsername​(String masterUsername)

        The master username for this DB cluster snapshot.

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

      • engineVersion

        DBClusterSnapshot.Builder engineVersion​(String engineVersion)

        The version of the database engine for this DB cluster snapshot.

        Parameters:
        engineVersion - The version of the database engine for this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • licenseModel

        DBClusterSnapshot.Builder licenseModel​(String licenseModel)

        The license model information for this DB cluster snapshot.

        Parameters:
        licenseModel - The license model information for this DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotType

        DBClusterSnapshot.Builder snapshotType​(String snapshotType)

        The type of the DB cluster snapshot.

        Parameters:
        snapshotType - The type of the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • percentProgress

        DBClusterSnapshot.Builder percentProgress​(Integer percentProgress)

        The percentage of the estimated data that has been transferred.

        Parameters:
        percentProgress - The percentage of the estimated data that has been transferred.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageEncrypted

        DBClusterSnapshot.Builder storageEncrypted​(Boolean storageEncrypted)

        Indicates whether the DB cluster snapshot is encrypted.

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

      • kmsKeyId

        DBClusterSnapshot.Builder kmsKeyId​(String kmsKeyId)

        If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

        The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

        The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterSnapshotArn

        DBClusterSnapshot.Builder dbClusterSnapshotArn​(String dbClusterSnapshotArn)

        The Amazon Resource Name (ARN) for the DB cluster snapshot.

        Parameters:
        dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the DB cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceDBClusterSnapshotArn

        DBClusterSnapshot.Builder sourceDBClusterSnapshotArn​(String sourceDBClusterSnapshotArn)

        If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

        Parameters:
        sourceDBClusterSnapshotArn - If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iamDatabaseAuthenticationEnabled

        DBClusterSnapshot.Builder iamDatabaseAuthenticationEnabled​(Boolean iamDatabaseAuthenticationEnabled)

        Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        Parameters:
        iamDatabaseAuthenticationEnabled - Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBClusterSnapshot.Builder tagList​(Collection<Tag> tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBClusterSnapshot.Builder tagList​(Tag... tagList)
        Sets the value of the TagList property for this object.
        Parameters:
        tagList - The new value for the TagList property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        DBClusterSnapshot.Builder tagList​(Consumer<Tag.Builder>... tagList)
        Sets the value of the TagList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagList(List).

        Parameters:
        tagList - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tagList(java.util.Collection)

      • dbSystemId

        DBClusterSnapshot.Builder dbSystemId​(String dbSystemId)

        Reserved for future use.

        Parameters:
        dbSystemId - Reserved for future use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        DBClusterSnapshot.Builder storageType​(String storageType)

        The storage type associated with the DB cluster snapshot.

        This setting is only for Aurora DB clusters.

        Parameters:
        storageType - The storage type associated with the DB cluster snapshot.

        This setting is only for Aurora DB clusters.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterResourceId

        DBClusterSnapshot.Builder dbClusterResourceId​(String dbClusterResourceId)

        The resource ID of the DB cluster that this DB cluster snapshot was created from.

        Parameters:
        dbClusterResourceId - The resource ID of the DB cluster that this DB cluster snapshot was created from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.