Interface CreateClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, DsqlRequest.Builder, SdkBuilder<CreateClusterRequest.Builder,CreateClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateClusterRequest
@Mutable @NotThreadSafe public static interface CreateClusterRequest.Builder extends DsqlRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

  • Method Details

    • deletionProtectionEnabled

      CreateClusterRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.

      Parameters:
      deletionProtectionEnabled - If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsEncryptionKey

      CreateClusterRequest.Builder kmsEncryptionKey(String kmsEncryptionKey)

      The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

      Parameters:
      kmsEncryptionKey - The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateClusterRequest.Builder tags(Map<String,String> tags)

      A map of key and value pairs to use to tag your cluster.

      Parameters:
      tags - A map of key and value pairs to use to tag your cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateClusterRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

      If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

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

    • multiRegionProperties

      CreateClusterRequest.Builder multiRegionProperties(MultiRegionProperties multiRegionProperties)

      The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.

      Parameters:
      multiRegionProperties - The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiRegionProperties

      default CreateClusterRequest.Builder multiRegionProperties(Consumer<MultiRegionProperties.Builder> multiRegionProperties)

      The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.

      This is a convenience method that creates an instance of the MultiRegionProperties.Builder avoiding the need to create one manually via MultiRegionProperties.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multiRegionProperties(MultiRegionProperties).

      Parameters:
      multiRegionProperties - a consumer that will call methods on MultiRegionProperties.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • policy

      CreateClusterRequest.Builder policy(String policy)

      An optional resource-based policy document in JSON format that defines access permissions for the cluster.

      Parameters:
      policy - An optional resource-based policy document in JSON format that defines access permissions for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bypassPolicyLockoutSafetyCheck

      CreateClusterRequest.Builder bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)

      An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

      Parameters:
      bypassPolicyLockoutSafetyCheck - An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.