elasticache_describe_global_replication_groups: Returns information about a particular global replication...

Description Usage Arguments Value Request syntax

View source: R/elasticache_operations.R

Description

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores.

Usage

1
2
elasticache_describe_global_replication_groups(GlobalReplicationGroupId,
  MaxRecords, Marker, ShowMemberInfo)

Arguments

GlobalReplicationGroupId

The name of the Global Datastore

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Marker

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

ShowMemberInfo

Returns the list of members that comprise the Global Datastore.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
list(
  Marker = "string",
  GlobalReplicationGroups = list(
    list(
      GlobalReplicationGroupId = "string",
      GlobalReplicationGroupDescription = "string",
      Status = "string",
      CacheNodeType = "string",
      Engine = "string",
      EngineVersion = "string",
      Members = list(
        list(
          ReplicationGroupId = "string",
          ReplicationGroupRegion = "string",
          Role = "string",
          AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
          Status = "string"
        )
      ),
      ClusterEnabled = TRUE|FALSE,
      GlobalNodeGroups = list(
        list(
          GlobalNodeGroupId = "string",
          Slots = "string"
        )
      ),
      AuthTokenEnabled = TRUE|FALSE,
      TransitEncryptionEnabled = TRUE|FALSE,
      AtRestEncryptionEnabled = TRUE|FALSE,
      ARN = "string"
    )
  )
)

Request syntax

1
2
3
4
5
6
svc$describe_global_replication_groups(
  GlobalReplicationGroupId = "string",
  MaxRecords = 123,
  Marker = "string",
  ShowMemberInfo = TRUE|FALSE
)

paws.database documentation built on March 9, 2021, 5:11 p.m.