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

Interface CreateDbShardGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>, RdsRequest.Builder, SdkBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDbShardGroupRequest
public static interface CreateDbShardGroupRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>

  • Method Details

    • dbShardGroupIdentifier

      CreateDbShardGroupRequest.Builder dbShardGroupIdentifier(String dbShardGroupIdentifier)

      The name of the DB shard group.

      Parameters:
      dbShardGroupIdentifier - The name of the DB shard group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbClusterIdentifier

      CreateDbShardGroupRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

      The name of the primary DB cluster for the DB shard group.

      Parameters:
      dbClusterIdentifier - The name of the primary DB cluster for the DB shard group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeRedundancy

      CreateDbShardGroupRequest.Builder computeRedundancy(Integer computeRedundancy)

      Specifies whether to create standby instances for the DB shard group. Valid values are the following:

      • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

      • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

      • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

      Parameters:
      computeRedundancy - Specifies whether to create standby instances for the DB shard group. Valid values are the following:

      • 0 - Creates a single, primary DB instance for each physical shard. This is the default value, and the only one supported for the preview.

      • 1 - Creates a primary DB instance and a standby instance in a different Availability Zone (AZ) for each physical shard.

      • 2 - Creates a primary DB instance and two standby instances in different AZs for each physical shard.

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

    • maxACU

      CreateDbShardGroupRequest.Builder maxACU(Double maxACU)

      The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

      Parameters:
      maxACU - The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publiclyAccessible

      CreateDbShardGroupRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Specifies whether the DB shard group is publicly accessible.

      When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

      When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

      Parameters:
      publiclyAccessible - Specifies whether the DB shard group is publicly accessible.

      When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

      When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

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

    • overrideConfiguration

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

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