AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Snapshot

import "github.com/aws/aws-sdk-go/service/elasticache"

type Snapshot struct { AutoMinorVersionUpgrade *bool `type:"boolean"` AutomaticFailover *string `type:"string" enum:"AutomaticFailoverStatus"` CacheClusterCreateTime *time.Time `type:"timestamp"` CacheClusterId *string `type:"string"` CacheNodeType *string `type:"string"` CacheParameterGroupName *string `type:"string"` CacheSubnetGroupName *string `type:"string"` Engine *string `type:"string"` EngineVersion *string `type:"string"` NodeSnapshots []*NodeSnapshot `locationNameList:"NodeSnapshot" type:"list"` NumCacheNodes *int64 `type:"integer"` NumNodeGroups *int64 `type:"integer"` Port *int64 `type:"integer"` PreferredAvailabilityZone *string `type:"string"` PreferredMaintenanceWindow *string `type:"string"` ReplicationGroupDescription *string `type:"string"` ReplicationGroupId *string `type:"string"` SnapshotName *string `type:"string"` SnapshotRetentionLimit *int64 `type:"integer"` SnapshotSource *string `type:"string"` SnapshotStatus *string `type:"string"` SnapshotWindow *string `type:"string"` TopicArn *string `type:"string"` VpcId *string `type:"string"` }

Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

AutoMinorVersionUpgrade

Type: *bool

This parameter is currently disabled.

AutomaticFailover

Type: *string

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 and T2 cache node types.

  • Redis (cluster mode enabled): T1 node types.

CacheClusterCreateTime

Type: *time.Time

The date and time when the source cluster was created.

CacheClusterId

Type: *string

The user-supplied identifier of the source cluster.

CacheNodeType

Type: *string

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

Current generation:

T2 node types:cache.t2.micro, cache.t2.small, cache.t2.medium

M3 node types:cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

M4 node types:cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge,

cache.m4.10xlarge

Previous generation: (not recommended)

T1 node types:cache.t1.micro

M1 node types:cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized:

Previous generation: (not recommended)

C1 node types:cache.c1.xlarge

  • Memory optimized:

Current generation:

R3 node types:cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge,

cache.r3.8xlarge

R4 node types;cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge,

cache.r4.8xlarge, cache.r4.16xlarge

Previous generation: (not recommended)

M2 node types:cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see:

CacheParameterGroupName

Type: *string

The cache parameter group that is associated with the source cluster.

CacheSubnetGroupName

Type: *string

The name of the cache subnet group associated with the source cluster.

Engine

Type: *string

The name of the cache engine (memcached or redis) used by the source cluster.

EngineVersion

Type: *string

The version of the cache engine version that is used by the source cluster.

NodeSnapshots

Represents an individual cache node in a snapshot of a cluster.

NumCacheNodes

Type: *int64

The number of cache nodes in the source cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

NumNodeGroups

Type: *int64

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

Port

Type: *int64

The port number used by each cache nodes in the source cluster.

PreferredAvailabilityZone

Type: *string

The name of the Availability Zone in which the source cluster is located.

PreferredMaintenanceWindow

Type: *string

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

ReplicationGroupDescription

Type: *string

A description of the source replication group.

ReplicationGroupId

Type: *string

The unique identifier of the source replication group.

SnapshotName

Type: *string

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

SnapshotRetentionLimit

Type: *int64

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

SnapshotSource

Type: *string

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

SnapshotStatus

Type: *string

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

SnapshotWindow

Type: *string

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

TopicArn

Type: *string

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

VpcId

Type: *string

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Method

GoString

func (s Snapshot) GoString() string

GoString returns the string representation

SetAutoMinorVersionUpgrade

func (s *Snapshot) SetAutoMinorVersionUpgrade(v bool) *Snapshot

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

SetAutomaticFailover

func (s *Snapshot) SetAutomaticFailover(v string) *Snapshot

SetAutomaticFailover sets the AutomaticFailover field's value.

SetCacheClusterCreateTime

func (s *Snapshot) SetCacheClusterCreateTime(v time.Time) *Snapshot

SetCacheClusterCreateTime sets the CacheClusterCreateTime field's value.

SetCacheClusterId

func (s *Snapshot) SetCacheClusterId(v string) *Snapshot

SetCacheClusterId sets the CacheClusterId field's value.

SetCacheNodeType

func (s *Snapshot) SetCacheNodeType(v string) *Snapshot

SetCacheNodeType sets the CacheNodeType field's value.

SetCacheParameterGroupName

func (s *Snapshot) SetCacheParameterGroupName(v string) *Snapshot

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

SetCacheSubnetGroupName

func (s *Snapshot) SetCacheSubnetGroupName(v string) *Snapshot

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

SetEngine

func (s *Snapshot) SetEngine(v string) *Snapshot

SetEngine sets the Engine field's value.

SetEngineVersion

func (s *Snapshot) SetEngineVersion(v string) *Snapshot

SetEngineVersion sets the EngineVersion field's value.

SetNodeSnapshots

func (s *Snapshot) SetNodeSnapshots(v []*NodeSnapshot) *Snapshot

SetNodeSnapshots sets the NodeSnapshots field's value.

SetNumCacheNodes

func (s *Snapshot) SetNumCacheNodes(v int64) *Snapshot

SetNumCacheNodes sets the NumCacheNodes field's value.

SetNumNodeGroups

func (s *Snapshot) SetNumNodeGroups(v int64) *Snapshot

SetNumNodeGroups sets the NumNodeGroups field's value.

SetPort

func (s *Snapshot) SetPort(v int64) *Snapshot

SetPort sets the Port field's value.

SetPreferredAvailabilityZone

func (s *Snapshot) SetPreferredAvailabilityZone(v string) *Snapshot

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

SetPreferredMaintenanceWindow

func (s *Snapshot) SetPreferredMaintenanceWindow(v string) *Snapshot

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetReplicationGroupDescription

func (s *Snapshot) SetReplicationGroupDescription(v string) *Snapshot

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

SetReplicationGroupId

func (s *Snapshot) SetReplicationGroupId(v string) *Snapshot

SetReplicationGroupId sets the ReplicationGroupId field's value.

SetSnapshotName

func (s *Snapshot) SetSnapshotName(v string) *Snapshot

SetSnapshotName sets the SnapshotName field's value.

SetSnapshotRetentionLimit

func (s *Snapshot) SetSnapshotRetentionLimit(v int64) *Snapshot

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

SetSnapshotSource

func (s *Snapshot) SetSnapshotSource(v string) *Snapshot

SetSnapshotSource sets the SnapshotSource field's value.

SetSnapshotStatus

func (s *Snapshot) SetSnapshotStatus(v string) *Snapshot

SetSnapshotStatus sets the SnapshotStatus field's value.

SetSnapshotWindow

func (s *Snapshot) SetSnapshotWindow(v string) *Snapshot

SetSnapshotWindow sets the SnapshotWindow field's value.

SetTopicArn

func (s *Snapshot) SetTopicArn(v string) *Snapshot

SetTopicArn sets the TopicArn field's value.

SetVpcId

func (s *Snapshot) SetVpcId(v string) *Snapshot

SetVpcId sets the VpcId field's value.

String

func (s Snapshot) String() string

String returns the string representation

On this page: