Package software.amazon.awssdk.services.docdbelastic.model

Interface ClusterSnapshot.Builder

    • Method Detail

      • adminUserName

        ClusterSnapshot.Builder adminUserName​(String adminUserName)

        The name of the elastic cluster administrator.

        Parameters:
        adminUserName - The name of the elastic cluster administrator.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterArn

        ClusterSnapshot.Builder clusterArn​(String clusterArn)

        The ARN identifier of the elastic cluster.

        Parameters:
        clusterArn - The ARN identifier of the elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterCreationTime

        ClusterSnapshot.Builder clusterCreationTime​(String clusterCreationTime)

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

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

      • kmsKeyId

        ClusterSnapshot.Builder kmsKeyId​(String kmsKeyId)

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

        Parameters:
        kmsKeyId - The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotArn

        ClusterSnapshot.Builder snapshotArn​(String snapshotArn)

        The ARN identifier of the elastic cluster snapshot.

        Parameters:
        snapshotArn - The ARN identifier of the elastic cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotCreationTime

        ClusterSnapshot.Builder snapshotCreationTime​(String snapshotCreationTime)

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

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

      • snapshotName

        ClusterSnapshot.Builder snapshotName​(String snapshotName)

        The name of the elastic cluster snapshot.

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

      • snapshotType

        ClusterSnapshot.Builder snapshotType​(String snapshotType)

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        Parameters:
        snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

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

      • snapshotType

        ClusterSnapshot.Builder snapshotType​(SnapshotType snapshotType)

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

        Parameters:
        snapshotType - The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

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

      • status

        ClusterSnapshot.Builder status​(String status)

        The status of the elastic cluster snapshot.

        Parameters:
        status - The status of the elastic cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status

      • status

        ClusterSnapshot.Builder status​(Status status)

        The status of the elastic cluster snapshot.

        Parameters:
        status - The status of the elastic cluster snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Status, Status

      • subnetIds

        ClusterSnapshot.Builder subnetIds​(Collection<String> subnetIds)

        The Amazon EC2 subnet IDs for the elastic cluster.

        Parameters:
        subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetIds

        ClusterSnapshot.Builder subnetIds​(String... subnetIds)

        The Amazon EC2 subnet IDs for the elastic cluster.

        Parameters:
        subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        ClusterSnapshot.Builder vpcSecurityGroupIds​(Collection<String> vpcSecurityGroupIds)

        A list of EC2 VPC security groups to associate with the elastic cluster.

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        ClusterSnapshot.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

        A list of EC2 VPC security groups to associate with the elastic cluster.

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.