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.

ReplicationGroup

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

type ReplicationGroup struct { AtRestEncryptionEnabled *bool `type:"boolean"` AuthTokenEnabled *bool `type:"boolean"` AutomaticFailover *string `type:"string" enum:"AutomaticFailoverStatus"` CacheNodeType *string `type:"string"` ClusterEnabled *bool `type:"boolean"` ConfigurationEndpoint *Endpoint `type:"structure"` Description *string `type:"string"` MemberClusters []*string `locationNameList:"ClusterId" type:"list"` NodeGroups []*NodeGroup `locationNameList:"NodeGroup" type:"list"` PendingModifiedValues *ReplicationGroupPendingModifiedValues `type:"structure"` ReplicationGroupId *string `type:"string"` SnapshotRetentionLimit *int64 `type:"integer"` SnapshotWindow *string `type:"string"` SnapshottingClusterId *string `type:"string"` Status *string `type:"string"` TransitEncryptionEnabled *bool `type:"boolean"` }

Contains all of the attributes of a specific Redis replication group.

AtRestEncryptionEnabled

Type: *bool

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

AuthTokenEnabled

Type: *bool

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

AutomaticFailover

Type: *string

Indicates the status of Multi-AZ with automatic failover for this 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.

CacheNodeType

Type: *string

The name of the compute and memory capacity node type for each node in the replication group.

ClusterEnabled

Type: *bool

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

ConfigurationEndpoint

Represents the information required for client programs to connect to a cache node.

Description

Type: *string

The user supplied description of the replication group.

MemberClusters

Type: []*string

The names of all the cache clusters that are part of this replication group.

NodeGroups

Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

PendingModifiedValues

The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.

ReplicationGroupId

Type: *string

The identifier for the replication group.

SnapshotRetentionLimit

Type: *int64

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

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

SnapshotWindow

Type: *string

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

SnapshottingClusterId

Type: *string

The cluster ID that is used as the daily snapshot source for the replication group.

Status

Type: *string

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

TransitEncryptionEnabled

Type: *bool

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x.

Default: false

Method

GoString

func (s ReplicationGroup) GoString() string

GoString returns the string representation

SetAtRestEncryptionEnabled

func (s *ReplicationGroup) SetAtRestEncryptionEnabled(v bool) *ReplicationGroup

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

SetAuthTokenEnabled

func (s *ReplicationGroup) SetAuthTokenEnabled(v bool) *ReplicationGroup

SetAuthTokenEnabled sets the AuthTokenEnabled field's value.

SetAutomaticFailover

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

SetAutomaticFailover sets the AutomaticFailover field's value.

SetCacheNodeType

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

SetCacheNodeType sets the CacheNodeType field's value.

SetClusterEnabled

func (s *ReplicationGroup) SetClusterEnabled(v bool) *ReplicationGroup

SetClusterEnabled sets the ClusterEnabled field's value.

SetConfigurationEndpoint

func (s *ReplicationGroup) SetConfigurationEndpoint(v *Endpoint) *ReplicationGroup

SetConfigurationEndpoint sets the ConfigurationEndpoint field's value.

SetDescription

func (s *ReplicationGroup) SetDescription(v string) *ReplicationGroup

SetDescription sets the Description field's value.

SetMemberClusters

func (s *ReplicationGroup) SetMemberClusters(v []*string) *ReplicationGroup

SetMemberClusters sets the MemberClusters field's value.

SetNodeGroups

func (s *ReplicationGroup) SetNodeGroups(v []*NodeGroup) *ReplicationGroup

SetNodeGroups sets the NodeGroups field's value.

SetPendingModifiedValues

func (s *ReplicationGroup) SetPendingModifiedValues(v *ReplicationGroupPendingModifiedValues) *ReplicationGroup

SetPendingModifiedValues sets the PendingModifiedValues field's value.

SetReplicationGroupId

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

SetSnapshotRetentionLimit

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

SetSnapshotWindow

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

SetSnapshotWindow sets the SnapshotWindow field's value.

SetSnapshottingClusterId

func (s *ReplicationGroup) SetSnapshottingClusterId(v string) *ReplicationGroup

SetSnapshottingClusterId sets the SnapshottingClusterId field's value.

SetStatus

func (s *ReplicationGroup) SetStatus(v string) *ReplicationGroup

SetStatus sets the Status field's value.

SetTransitEncryptionEnabled

func (s *ReplicationGroup) SetTransitEncryptionEnabled(v bool) *ReplicationGroup

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

String

func (s ReplicationGroup) String() string

String returns the string representation

On this page: