Package software.amazon.awscdk.services.rds

Class CfnDBShardGroupProps.Builder

java.lang.Object
software.amazon.awscdk.services.rds.CfnDBShardGroupProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBShardGroupProps>
Enclosing interface:
CfnDBShardGroupProps
@Stability(Stable) public static final class CfnDBShardGroupProps.Builder extends Object implements software.amazon.jsii.Builder<CfnDBShardGroupProps>
A builder for CfnDBShardGroupProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • dbClusterIdentifier

      @Stability(Stable) public CfnDBShardGroupProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
      Sets the value of CfnDBShardGroupProps.getDbClusterIdentifier()
      Parameters:
      dbClusterIdentifier - The name of the primary DB cluster for the DB shard group. This parameter is required.
      Returns:
      this

    • maxAcu

      @Stability(Stable) public CfnDBShardGroupProps.Builder maxAcu(Number maxAcu)
      Sets the value of CfnDBShardGroupProps.getMaxAcu()
      Parameters:
      maxAcu - The maximum capacity of the DB shard group in Aurora capacity units (ACUs). This parameter is required.
      Returns:
      this

    • computeRedundancy

      @Stability(Stable) public CfnDBShardGroupProps.Builder computeRedundancy(Number computeRedundancy)
      Sets the value of CfnDBShardGroupProps.getComputeRedundancy()
      Parameters:
      computeRedundancy - Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:.
      • 0 - Creates a DB shard group without a standby DB shard group. This is the default value.
      • 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ).
      • 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
      Returns:
      this

    • dbShardGroupIdentifier

      @Stability(Stable) public CfnDBShardGroupProps.Builder dbShardGroupIdentifier(String dbShardGroupIdentifier)
      Sets the value of CfnDBShardGroupProps.getDbShardGroupIdentifier()
      Parameters:
      dbShardGroupIdentifier - The name of the DB shard group.
      Returns:
      this

    • minAcu

      @Stability(Stable) public CfnDBShardGroupProps.Builder minAcu(Number minAcu)
      Sets the value of CfnDBShardGroupProps.getMinAcu()
      Parameters:
      minAcu - The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
      Returns:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnDBShardGroupProps.Builder publiclyAccessible(Boolean publiclyAccessible)
      Sets the value of CfnDBShardGroupProps.getPubliclyAccessible()
      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:
      this

    • publiclyAccessible

      @Stability(Stable) public CfnDBShardGroupProps.Builder publiclyAccessible(IResolvable publiclyAccessible)
      Sets the value of CfnDBShardGroupProps.getPubliclyAccessible()
      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:
      this

    • tags

      @Stability(Stable) public CfnDBShardGroupProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnDBShardGroupProps.getTags()
      Parameters:
      tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDBShardGroupProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDBShardGroupProps>
      Returns:
      a new instance of CfnDBShardGroupProps
      Throws:
      NullPointerException - if any required attribute was not provided