Package software.amazon.awssdk.services.docdb.model

Interface DBClusterSnapshot.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>, SdkBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>, SdkPojo
Enclosing class:
DBClusterSnapshot
public static interface DBClusterSnapshot.Builder extends SdkPojo, CopyableBuilder<DBClusterSnapshot.Builder,DBClusterSnapshot>

  • Method Details

    • availabilityZones

      DBClusterSnapshot.Builder availabilityZones(Collection<String> availabilityZones)

      Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

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

    • availabilityZones

      DBClusterSnapshot.Builder availabilityZones(String... availabilityZones)

      Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

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

    • dbClusterSnapshotIdentifier

      DBClusterSnapshot.Builder dbClusterSnapshotIdentifier(String dbClusterSnapshotIdentifier)

      Specifies the identifier for the cluster snapshot.

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

    • dbClusterIdentifier

      DBClusterSnapshot.Builder dbClusterIdentifier(String dbClusterIdentifier)

      Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

      Parameters:
      dbClusterIdentifier - Specifies the cluster identifier of the cluster that this 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)

      Provides the time when the snapshot was taken, in UTC.

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

    • engine

      DBClusterSnapshot.Builder engine(String engine)

      Specifies the name of the database engine.

      Parameters:
      engine - Specifies the name of the database engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DBClusterSnapshot.Builder status(String status)

      Specifies the status of this cluster snapshot.

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

    • port

      DBClusterSnapshot.Builder port(Integer port)

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

      Parameters:
      port - Specifies the port that the 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)

      Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

      Parameters:
      vpcId - Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterCreateTime

      DBClusterSnapshot.Builder clusterCreateTime(Instant clusterCreateTime)

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

      Parameters:
      clusterCreateTime - Specifies the time when the 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)

      Provides the master user name for the cluster snapshot.

      Parameters:
      masterUsername - Provides the master user name for the cluster snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      DBClusterSnapshot.Builder engineVersion(String engineVersion)

      Provides the version of the database engine for this cluster snapshot.

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

    • snapshotType

      DBClusterSnapshot.Builder snapshotType(String snapshotType)

      Provides the type of the cluster snapshot.

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

    • percentProgress

      DBClusterSnapshot.Builder percentProgress(Integer percentProgress)

      Specifies the percentage of the estimated data that has been transferred.

      Parameters:
      percentProgress - Specifies 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)

      Specifies whether the cluster snapshot is encrypted.

      Parameters:
      storageEncrypted - Specifies whether the 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 KMS key identifier for the encrypted cluster snapshot.

      Parameters:
      kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted cluster snapshot.
      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 cluster snapshot.

      Parameters:
      dbClusterSnapshotArn - The Amazon Resource Name (ARN) for the 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 cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

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

    • storageType

      DBClusterSnapshot.Builder storageType(String storageType)

      Storage type associated with your cluster snapshot

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

      Parameters:
      storageType - Storage type associated with your cluster snapshot

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

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