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

Class CreateGlobalClusterRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGlobalClusterRequest.Builder,CreateGlobalClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateGlobalClusterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateGlobalClusterRequest.Builder	builder()
String	databaseName()	The name for your database of up to 64 alphanumeric characters.
Boolean	deletionProtection()	Specifies whether to enable deletion protection for the new global database cluster.
String	engine()	The database engine to use for this global database cluster.
String	engineLifecycleSupport()	The life cycle type for this global database cluster.
String	engineVersion()	The engine version to use for this global database cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalClusterIdentifier()	The cluster identifier for this global database cluster.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGlobalClusterRequest.Builder>	serializableBuilderClass()
String	sourceDBClusterIdentifier()	The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
Boolean	storageEncrypted()	Specifies whether to enable storage encryption for the new global database cluster.
CreateGlobalClusterRequest.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

globalClusterIdentifier

public final String globalClusterIdentifier()

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

Returns:

The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.

sourceDBClusterIdentifier

public final String sourceDBClusterIdentifier()

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

• DatabaseName

• Engine

• EngineVersion

• StorageEncrypted

Returns:

The Amazon Resource Name (ARN) to use as the primary cluster of the global database.

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

• DatabaseName

• Engine

• EngineVersion

• StorageEncrypted

engine

public final String engine()

The database engine to use for this global database cluster.

Valid Values: aurora-mysql | aurora-postgresql

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

Returns:

The database engine to use for this global database cluster.

Valid Values: aurora-mysql | aurora-postgresql

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

engineVersion

public final String engineVersion()

The engine version to use for this global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

Returns:

The engine version to use for this global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

engineLifecycleSupport

public final String engineLifecycleSupport()

The life cycle type for this global database cluster.

By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

This setting only applies to Aurora PostgreSQL-based global databases.

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

Returns:

The life cycle type for this global database cluster.

By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.

This setting only applies to Aurora PostgreSQL-based global databases.

You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

deletionProtection

public final Boolean deletionProtection()

Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.

Returns:

Specifies whether to enable deletion protection for the new global database cluster. The global database can't be deleted when deletion protection is enabled.

databaseName

public final String databaseName()

The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

Returns:

The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.

storageEncrypted

public final Boolean storageEncrypted()

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

Returns:

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

toBuilder

public CreateGlobalClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGlobalClusterRequest.Builder,CreateGlobalClusterRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static CreateGlobalClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGlobalClusterRequest.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