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

Interface RestoreClusterFromSnapshotRequest.Builder

    • Method Detail

      • clusterName

        RestoreClusterFromSnapshotRequest.Builder clusterName​(String clusterName)

        The name of the elastic cluster.

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

      • kmsKeyId

        RestoreClusterFromSnapshotRequest.Builder kmsKeyId​(String kmsKeyId)

        The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

        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 to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

        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.

      • shardCapacity

        RestoreClusterFromSnapshotRequest.Builder shardCapacity​(Integer shardCapacity)

        The capacity of each shard in the new restored elastic cluster.

        Parameters:
        shardCapacity - The capacity of each shard in the new restored elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shardInstanceCount

        RestoreClusterFromSnapshotRequest.Builder shardInstanceCount​(Integer shardInstanceCount)

        The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

        Parameters:
        shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • snapshotArn

        RestoreClusterFromSnapshotRequest.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.

      • subnetIds

        RestoreClusterFromSnapshotRequest.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

        RestoreClusterFromSnapshotRequest.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.

      • tags

        RestoreClusterFromSnapshotRequest.Builder tags​(Map<String,​String> tags)

        A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

        Parameters:
        tags - A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        RestoreClusterFromSnapshotRequest.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

        RestoreClusterFromSnapshotRequest.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.