Describe Replication Groups

elasticache_describe_replication_groups

R Documentation

Returns information about a particular replication group

Description

Returns information about a particular replication group. If no identifier is specified, describe_replication_groups returns information about all replication groups.

This operation is valid for Redis OSS only.

Usage

elasticache_describe_replication_groups(ReplicationGroupId, MaxRecords,
  Marker)

Arguments

ReplicationGroupId

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

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.

Default: 100

Constraints: minimum 20; maximum 100.

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.

Value

A list with the following syntax:

list(
  Marker = "string",
  ReplicationGroups = list(
    list(
      ReplicationGroupId = "string",
      Description = "string",
      GlobalReplicationGroupInfo = list(
        GlobalReplicationGroupId = "string",
        GlobalReplicationGroupMemberRole = "string"
      ),
      Status = "string",
      PendingModifiedValues = list(
        PrimaryClusterId = "string",
        AutomaticFailoverStatus = "enabled"|"disabled",
        Resharding = list(
          SlotMigration = list(
            ProgressPercentage = 123.0
          )
        ),
        AuthTokenStatus = "SETTING"|"ROTATING",
        UserGroups = list(
          UserGroupIdsToAdd = list(
            "string"
          ),
          UserGroupIdsToRemove = list(
            "string"
          )
        ),
        LogDeliveryConfigurations = list(
          list(
            LogType = "slow-log"|"engine-log",
            DestinationType = "cloudwatch-logs"|"kinesis-firehose",
            DestinationDetails = list(
              CloudWatchLogsDetails = list(
                LogGroup = "string"
              ),
              KinesisFirehoseDetails = list(
                DeliveryStream = "string"
              )
            ),
            LogFormat = "text"|"json"
          )
        ),
        TransitEncryptionEnabled = TRUE|FALSE,
        TransitEncryptionMode = "preferred"|"required",
        ClusterMode = "enabled"|"disabled"|"compatible"
      ),
      MemberClusters = list(
        "string"
      ),
      NodeGroups = list(
        list(
          NodeGroupId = "string",
          Status = "string",
          PrimaryEndpoint = list(
            Address = "string",
            Port = 123
          ),
          ReaderEndpoint = list(
            Address = "string",
            Port = 123
          ),
          Slots = "string",
          NodeGroupMembers = list(
            list(
              CacheClusterId = "string",
              CacheNodeId = "string",
              ReadEndpoint = list(
                Address = "string",
                Port = 123
              ),
              PreferredAvailabilityZone = "string",
              PreferredOutpostArn = "string",
              CurrentRole = "string"
            )
          )
        )
      ),
      SnapshottingClusterId = "string",
      AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
      MultiAZ = "enabled"|"disabled",
      ConfigurationEndpoint = list(
        Address = "string",
        Port = 123
      ),
      SnapshotRetentionLimit = 123,
      SnapshotWindow = "string",
      ClusterEnabled = TRUE|FALSE,
      CacheNodeType = "string",
      AuthTokenEnabled = TRUE|FALSE,
      AuthTokenLastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      TransitEncryptionEnabled = TRUE|FALSE,
      AtRestEncryptionEnabled = TRUE|FALSE,
      MemberClustersOutpostArns = list(
        "string"
      ),
      KmsKeyId = "string",
      ARN = "string",
      UserGroupIds = list(
        "string"
      ),
      LogDeliveryConfigurations = list(
        list(
          LogType = "slow-log"|"engine-log",
          DestinationType = "cloudwatch-logs"|"kinesis-firehose",
          DestinationDetails = list(
            CloudWatchLogsDetails = list(
              LogGroup = "string"
            ),
            KinesisFirehoseDetails = list(
              DeliveryStream = "string"
            )
          ),
          LogFormat = "text"|"json",
          Status = "active"|"enabling"|"modifying"|"disabling"|"error",
          Message = "string"
        )
      ),
      ReplicationGroupCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      DataTiering = "enabled"|"disabled",
      AutoMinorVersionUpgrade = TRUE|FALSE,
      NetworkType = "ipv4"|"ipv6"|"dual_stack",
      IpDiscovery = "ipv4"|"ipv6",
      TransitEncryptionMode = "preferred"|"required",
      ClusterMode = "enabled"|"disabled"|"compatible"
    )
  )
)

Request syntax

svc$describe_replication_groups(
  ReplicationGroupId = "string",
  MaxRecords = 123,
  Marker = "string"
)