Class: Aws::ElastiCache::Types::ModifyGlobalReplicationGroupMessage

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

Overview

Note:

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

{
  global_replication_group_id: "String", # required
  apply_immediately: false, # required
  cache_node_type: "String",
  engine_version: "String",
  global_replication_group_description: "String",
  automatic_failover_enabled: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_immediatelyBoolean

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

Returns:

  • (Boolean)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_failover_enabledBoolean

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Returns:

  • (Boolean)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#cache_node_typeString

A valid cache node type that you want to scale this Global Datastore to.

Returns:

  • (String)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The upgraded version of the cache engine to be run on the clusters in the Global Datastore.

Returns:

  • (String)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_descriptionString

A description of the Global Datastore

Returns:

  • (String)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#global_replication_group_idString

The name of the Global Datastore

Returns:

  • (String)


5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 5963

class ModifyGlobalReplicationGroupMessage < Struct.new(
  :global_replication_group_id,
  :apply_immediately,
  :cache_node_type,
  :engine_version,
  :global_replication_group_description,
  :automatic_failover_enabled)
  SENSITIVE = []
  include Aws::Structure
end