AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::DocDB::Types::ModifyGlobalClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass ModifyGlobalClusterMessage data as a hash:

{
  global_cluster_identifier: "GlobalClusterIdentifier", # required
  new_global_cluster_identifier: "GlobalClusterIdentifier",
  deletion_protection: false,
}

Represents the input to ModifyGlobalCluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protectionBoolean

Indicates if the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

Returns:

  • (Boolean)


4936
4937
4938
4939
4940
4941
4942
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4936

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#global_cluster_identifierString

The identifier for the global cluster being modified. This parameter isn't case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster.

^

Returns:

  • (String)


4936
4937
4938
4939
4940
4941
4942
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4936

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#new_global_cluster_identifierString

The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.

  • 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:

  • (String)


4936
4937
4938
4939
4940
4941
4942
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4936

class ModifyGlobalClusterMessage < Struct.new(
  :global_cluster_identifier,
  :new_global_cluster_identifier,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end