You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElastiCache::Types::DeleteReplicationGroupMessage

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 DeleteReplicationGroupMessage data as a hash:

{
  replication_group_id: "String", # required
  retain_primary_cluster: false,
  final_snapshot_identifier: "String",
}

Represents the input of a DeleteReplicationGroup operation.

Instance Attribute Summary collapse

Instance Attribute Details

#final_snapshot_identifierString

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

Returns:

  • (String)


2103
2104
2105
2106
2107
2108
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2103

class DeleteReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :retain_primary_cluster,
  :final_snapshot_identifier)
  include Aws::Structure
end

#replication_group_idString

The identifier for the cluster to be deleted. This parameter is not case sensitive.

Returns:

  • (String)


2103
2104
2105
2106
2107
2108
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2103

class DeleteReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :retain_primary_cluster,
  :final_snapshot_identifier)
  include Aws::Structure
end

#retain_primary_clusterBoolean

If set to true, all of the read replicas are deleted, but the primary node is retained.

Returns:

  • (Boolean)


2103
2104
2105
2106
2107
2108
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 2103

class DeleteReplicationGroupMessage < Struct.new(
  :replication_group_id,
  :retain_primary_cluster,
  :final_snapshot_identifier)
  include Aws::Structure
end