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

Interface CreateGlobalClusterRequest.Builder

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

  • Method Details

    • globalClusterIdentifier

      CreateGlobalClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

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

      Parameters:
      globalClusterIdentifier - The cluster identifier for this global database cluster. This parameter is stored as a lowercase string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceDBClusterIdentifier

      CreateGlobalClusterRequest.Builder sourceDBClusterIdentifier(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • engine

      CreateGlobalClusterRequest.Builder engine(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      CreateGlobalClusterRequest.Builder engineVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • engineLifecycleSupport

      CreateGlobalClusterRequest.Builder engineLifecycleSupport(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtection

      CreateGlobalClusterRequest.Builder deletionProtection(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      CreateGlobalClusterRequest.Builder databaseName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • storageEncrypted

      CreateGlobalClusterRequest.Builder storageEncrypted(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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