Learn R Programming

paws.database (version 0.1.12)

elasticache_create_snapshot: Creates a copy of an entire cluster or replication group at a specific moment in time

Description

Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

Usage

elasticache_create_snapshot(ReplicationGroupId, CacheClusterId,
  SnapshotName, KmsKeyId)

Value

A list with the following syntax:

list(
  Snapshot = list(
    SnapshotName = "string",
    ReplicationGroupId = "string",
    ReplicationGroupDescription = "string",
    CacheClusterId = "string",
    SnapshotStatus = "string",
    SnapshotSource = "string",
    CacheNodeType = "string",
    Engine = "string",
    EngineVersion = "string",
    NumCacheNodes = 123,
    PreferredAvailabilityZone = "string",
    PreferredOutpostArn = "string",
    CacheClusterCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    PreferredMaintenanceWindow = "string",
    TopicArn = "string",
    Port = 123,
    CacheParameterGroupName = "string",
    CacheSubnetGroupName = "string",
    VpcId = "string",
    AutoMinorVersionUpgrade = TRUE|FALSE,
    SnapshotRetentionLimit = 123,
    SnapshotWindow = "string",
    NumNodeGroups = 123,
    AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
    NodeSnapshots = list(
      list(
        CacheClusterId = "string",
        NodeGroupId = "string",
        CacheNodeId = "string",
        NodeGroupConfiguration = list(
          NodeGroupId = "string",
          Slots = "string",
          ReplicaCount = 123,
          PrimaryAvailabilityZone = "string",
          ReplicaAvailabilityZones = list(
            "string"
          ),
          PrimaryOutpostArn = "string",
          ReplicaOutpostArns = list(
            "string"
          )
        ),
        CacheSize = "string",
        CacheNodeCreateTime = as.POSIXct(
          "2015-01-01"
        ),
        SnapshotCreateTime = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    KmsKeyId = "string",
    ARN = "string"
  )
)

Arguments

ReplicationGroupId

The identifier of an existing replication group. The snapshot is created from this replication group.

CacheClusterId

The identifier of an existing cluster. The snapshot is created from this cluster.

SnapshotName

[required] A name for the snapshot being created.

KmsKeyId

The ID of the KMS key used to encrypt the snapshot.

Request syntax

svc$create_snapshot(
  ReplicationGroupId = "string",
  CacheClusterId = "string",
  SnapshotName = "string",
  KmsKeyId = "string"
)