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

Interface ModifyGlobalClusterRequest.Builder

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

  • Method Details

    • globalClusterIdentifier

      ModifyGlobalClusterRequest.Builder globalClusterIdentifier(String globalClusterIdentifier)

      The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing global database cluster.

      Parameters:
      globalClusterIdentifier - The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing global database cluster.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newGlobalClusterIdentifier

      ModifyGlobalClusterRequest.Builder newGlobalClusterIdentifier(String newGlobalClusterIdentifier)

      The new cluster identifier for the global database cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster2

      Parameters:
      newGlobalClusterIdentifier - The new cluster identifier for the global database cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster2

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtection

      ModifyGlobalClusterRequest.Builder deletionProtection(Boolean deletionProtection)

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

      Parameters:
      deletionProtection - Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engineVersion

      ModifyGlobalClusterRequest.Builder engineVersion(String engineVersion)

      The version number of the database engine to which you want to upgrade.

      To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

      To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

      Parameters:
      engineVersion - The version number of the database engine to which you want to upgrade.

      To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global databases), use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

      To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora global databases), use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowMajorVersionUpgrade

      ModifyGlobalClusterRequest.Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)

      Specifies whether to allow major version upgrades.

      Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a different major version than the global cluster's current version.

      If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

      Parameters:
      allowMajorVersionUpgrade - Specifies whether to allow major version upgrades.

      Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a different major version than the global cluster's current version.

      If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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