Package software.amazon.awscdk.services.rds

Class CfnDBShardGroup.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBShardGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBShardGroup>

Enclosing class:

CfnDBShardGroup

@Stability(Stable)
public static final class CfnDBShardGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBShardGroup>

A fluent builder for CfnDBShardGroup.

Method Summary

Modifier and Type	Method	Description
CfnDBShardGroup	build()
CfnDBShardGroup.Builder	computeRedundancy(Number computeRedundancy)	Specifies whether to create standby DB shard groups for the DB shard group.
static CfnDBShardGroup.Builder	create(software.constructs.Construct scope, String id)
CfnDBShardGroup.Builder	dbClusterIdentifier(String dbClusterIdentifier)	The name of the primary DB cluster for the DB shard group.
CfnDBShardGroup.Builder	dbShardGroupIdentifier(String dbShardGroupIdentifier)	The name of the DB shard group.
CfnDBShardGroup.Builder	maxAcu(Number maxAcu)	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
CfnDBShardGroup.Builder	minAcu(Number minAcu)	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
CfnDBShardGroup.Builder	publiclyAccessible(Boolean publiclyAccessible)	Specifies whether the DB shard group is publicly accessible.
CfnDBShardGroup.Builder	publiclyAccessible(IResolvable publiclyAccessible)	Specifies whether the DB shard group is publicly accessible.
CfnDBShardGroup.Builder	tags(List<? extends CfnTag> tags)	An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDBShardGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDBShardGroup.Builder.

dbClusterIdentifier

@Stability(Stable)
public CfnDBShardGroup.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbclusteridentifier

maxAcu

@Stability(Stable)
public CfnDBShardGroup.Builder maxAcu(Number 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). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-maxacu

computeRedundancy

@Stability(Stable)
public CfnDBShardGroup.Builder computeRedundancy(Number 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.

Parameters:

computeRedundancy - Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following:. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-computeredundancy

dbShardGroupIdentifier

@Stability(Stable)
public CfnDBShardGroup.Builder dbShardGroupIdentifier(String dbShardGroupIdentifier)

The name of the DB shard group.

Parameters:

dbShardGroupIdentifier - The name of the DB shard group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-dbshardgroupidentifier

minAcu

@Stability(Stable)
public CfnDBShardGroup.Builder minAcu(Number minAcu)

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

Parameters:

minAcu - The minimum capacity of the DB shard group in Aurora capacity units (ACUs). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-minacu

publiclyAccessible

@Stability(Stable)
public CfnDBShardGroup.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-publiclyaccessible

publiclyAccessible

@Stability(Stable)
public CfnDBShardGroup.Builder publiclyAccessible(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-publiclyaccessible

tags

@Stability(Stable)
public CfnDBShardGroup.Builder tags(List<? extends CfnTag> tags)

An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.

Parameters:

tags - An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbshardgroup.html#cfn-rds-dbshardgroup-tags

build

@Stability(Stable)
public CfnDBShardGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBShardGroup>

Returns:

a newly built instance of CfnDBShardGroup.