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

Class CreateDbShardGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.CreateDbShardGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateDbShardGroupRequest
extends RdsRequest
implements ToCopyableBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDbShardGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateDbShardGroupRequest.Builder	builder()
Integer	computeRedundancy()	Specifies whether to create standby instances for the DB shard group.
String	dbClusterIdentifier()	The name of the primary DB cluster for the DB shard group.
String	dbShardGroupIdentifier()	The name of the DB shard group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	maxACU()	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
Double	minACU()	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
Boolean	publiclyAccessible()	Specifies whether the DB shard group is publicly accessible.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDbShardGroupRequest.Builder>	serializableBuilderClass()
CreateDbShardGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbShardGroupIdentifier

public final String dbShardGroupIdentifier()

The name of the DB shard group.

Returns:

The name of the DB shard group.

dbClusterIdentifier

public final String dbClusterIdentifier()

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

Returns:

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

computeRedundancy

public final 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.

Returns:

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.

maxACU

public final Double maxACU()

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

Returns:

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

minACU

public final Double minACU()

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

Returns:

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

publiclyAccessible

public final 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.

Returns:

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.

toBuilder

public CreateDbShardGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDbShardGroupRequest.Builder,CreateDbShardGroupRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static CreateDbShardGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDbShardGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo