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.

CreateReplicationGroupInput

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

type CreateReplicationGroupInput struct { AtRestEncryptionEnabled *bool `type:"boolean"` AuthToken *string `type:"string"` AutoMinorVersionUpgrade *bool `type:"boolean"` AutomaticFailoverEnabled *bool `type:"boolean"` CacheNodeType *string `type:"string"` CacheParameterGroupName *string `type:"string"` CacheSecurityGroupNames []*string `locationNameList:"CacheSecurityGroupName" type:"list"` CacheSubnetGroupName *string `type:"string"` Engine *string `type:"string"` EngineVersion *string `type:"string"` NodeGroupConfiguration []*NodeGroupConfiguration `locationNameList:"NodeGroupConfiguration" type:"list"` NotificationTopicArn *string `type:"string"` NumCacheClusters *int64 `type:"integer"` NumNodeGroups *int64 `type:"integer"` Port *int64 `type:"integer"` PreferredCacheClusterAZs []*string `locationNameList:"AvailabilityZone" type:"list"` PreferredMaintenanceWindow *string `type:"string"` PrimaryClusterId *string `type:"string"` ReplicasPerNodeGroup *int64 `type:"integer"` ReplicationGroupDescription *string `type:"string" required:"true"` ReplicationGroupId *string `type:"string" required:"true"` SecurityGroupIds []*string `locationNameList:"SecurityGroupId" type:"list"` SnapshotArns []*string `locationNameList:"SnapshotArn" type:"list"` SnapshotName *string `type:"string"` SnapshotRetentionLimit *int64 `type:"integer"` SnapshotWindow *string `type:"string"` Tags []*Tag `locationNameList:"Tag" type:"list"` TransitEncryptionEnabled *bool `type:"boolean"` }

Represents the input of a CreateReplicationGroup operation.

AtRestEncryptionEnabled

Type: *bool

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

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

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

Default: false

AuthToken

Type: *string

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • Cannot contain any of the following characters: '/', '"', or '@'.

For more information, see AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.

AutoMinorVersionUpgrade

Type: *bool

This parameter is currently disabled.

AutomaticFailoverEnabled

Type: *bool

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

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 compute and memory capacity of the nodes in the node group (shard).

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 name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

CacheSecurityGroupNames

Type: []*string

A list of cache security group names to associate with this replication group.

CacheSubnetGroupName

Type: *string

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html).

Engine

Type: *string

The name of the cache engine to be used for the clusters in this replication group.

EngineVersion

Type: *string

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

NodeGroupConfiguration

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

NotificationTopicArn

Type: *string

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

NumCacheClusters

Type: *int64

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

NumNodeGroups

Type: *int64

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Port

Type: *int64

The port number on which each member of the replication group accepts connections.

PreferredCacheClusterAZs

Type: []*string

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

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:

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

PrimaryClusterId

Type: *string

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

ReplicasPerNodeGroup

Type: *int64

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

ReplicationGroupDescription

Type: *string

A user-created description for the replication group.

ReplicationGroupDescription is a required field

ReplicationGroupId

Type: *string

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

ReplicationGroupId is a required field

SecurityGroupIds

Type: []*string

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

SnapshotArns

Type: []*string

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

SnapshotName

Type: *string

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

SnapshotRetentionLimit

Type: *int64

The number of days for which ElastiCache retains automatic 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.

Default: 0 (i.e., automatic backups are disabled for this cluster).

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.

Tags

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

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.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6 or 4.x, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

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

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Method

GoString

func (s CreateReplicationGroupInput) GoString() string

GoString returns the string representation

SetAtRestEncryptionEnabled

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

SetAtRestEncryptionEnabled sets the AtRestEncryptionEnabled field's value.

SetAuthToken

func (s *CreateReplicationGroupInput) SetAuthToken(v string) *CreateReplicationGroupInput

SetAuthToken sets the AuthToken field's value.

SetAutoMinorVersionUpgrade

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

SetAutomaticFailoverEnabled

func (s *CreateReplicationGroupInput) SetAutomaticFailoverEnabled(v bool) *CreateReplicationGroupInput

SetAutomaticFailoverEnabled sets the AutomaticFailoverEnabled field's value.

SetCacheNodeType

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

SetCacheNodeType sets the CacheNodeType field's value.

SetCacheParameterGroupName

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

SetCacheSecurityGroupNames

func (s *CreateReplicationGroupInput) SetCacheSecurityGroupNames(v []*string) *CreateReplicationGroupInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

SetCacheSubnetGroupName

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

SetEngine

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

SetEngine sets the Engine field's value.

SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

SetNodeGroupConfiguration

func (s *CreateReplicationGroupInput) SetNodeGroupConfiguration(v []*NodeGroupConfiguration) *CreateReplicationGroupInput

SetNodeGroupConfiguration sets the NodeGroupConfiguration field's value.

SetNotificationTopicArn

func (s *CreateReplicationGroupInput) SetNotificationTopicArn(v string) *CreateReplicationGroupInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

SetNumCacheClusters

func (s *CreateReplicationGroupInput) SetNumCacheClusters(v int64) *CreateReplicationGroupInput

SetNumCacheClusters sets the NumCacheClusters field's value.

SetNumNodeGroups

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

SetNumNodeGroups sets the NumNodeGroups field's value.

SetPort

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

SetPort sets the Port field's value.

SetPreferredCacheClusterAZs

func (s *CreateReplicationGroupInput) SetPreferredCacheClusterAZs(v []*string) *CreateReplicationGroupInput

SetPreferredCacheClusterAZs sets the PreferredCacheClusterAZs field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetPrimaryClusterId

func (s *CreateReplicationGroupInput) SetPrimaryClusterId(v string) *CreateReplicationGroupInput

SetPrimaryClusterId sets the PrimaryClusterId field's value.

SetReplicasPerNodeGroup

func (s *CreateReplicationGroupInput) SetReplicasPerNodeGroup(v int64) *CreateReplicationGroupInput

SetReplicasPerNodeGroup sets the ReplicasPerNodeGroup field's value.

SetReplicationGroupDescription

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

SetReplicationGroupDescription sets the ReplicationGroupDescription field's value.

SetReplicationGroupId

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

SetSecurityGroupIds

func (s *CreateReplicationGroupInput) SetSecurityGroupIds(v []*string) *CreateReplicationGroupInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

SetSnapshotArns

func (s *CreateReplicationGroupInput) SetSnapshotArns(v []*string) *CreateReplicationGroupInput

SetSnapshotArns sets the SnapshotArns field's value.

SetSnapshotName

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

SetSnapshotName sets the SnapshotName field's value.

SetSnapshotRetentionLimit

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

SetSnapshotWindow

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

SetSnapshotWindow sets the SnapshotWindow field's value.

SetTags

func (s *CreateReplicationGroupInput) SetTags(v []*Tag) *CreateReplicationGroupInput

SetTags sets the Tags field's value.

SetTransitEncryptionEnabled

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

SetTransitEncryptionEnabled sets the TransitEncryptionEnabled field's value.

String

func (s CreateReplicationGroupInput) String() string

String returns the string representation

Validate

func (s *CreateReplicationGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: