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.

CreateCacheClusterInput

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

type CreateCacheClusterInput struct { AZMode *string `type:"string" enum:"AZMode"` AuthToken *string `type:"string"` AutoMinorVersionUpgrade *bool `type:"boolean"` CacheClusterId *string `type:"string" required:"true"` 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"` NotificationTopicArn *string `type:"string"` NumCacheNodes *int64 `type:"integer"` Port *int64 `type:"integer"` PreferredAvailabilityZone *string `type:"string"` PreferredAvailabilityZones []*string `locationNameList:"PreferredAvailabilityZone" type:"list"` PreferredMaintenanceWindow *string `type:"string"` ReplicationGroupId *string `type:"string"` 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"` }

Represents the input of a CreateCacheCluster operation.

AZMode

Type: *string

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

AuthToken

Type: *string

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

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.

CacheClusterId

Type: *string

The node group (shard) 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.

CacheClusterId is a required field

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 cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

CacheSecurityGroupNames

Type: []*string

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

CacheSubnetGroupName

Type: *string

The name of the subnet group to be used for the cluster.

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

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 this cluster.

Valid values for this parameter are: memcached | redis

EngineVersion

Type: *string

The version number of the cache engine to be used for this cluster. 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)), 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.

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.

NumCacheNodes

Type: *int64

The initial number of cache nodes that the cluster has.

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

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at https://aws.amazon.com/contact-us/elasticache-node-limit-request/ (https://aws.amazon.com/contact-us/elasticache-node-limit-request/).

Port

Type: *int64

The port number on which each of the cache nodes accepts connections.

PreferredAvailabilityZone

Type: *string

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

PreferredAvailabilityZones

Type: []*string

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

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

ReplicationGroupId

Type: *string

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

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

SecurityGroupIds

Type: []*string

One or more VPC security groups associated with the cluster.

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

SnapshotArns

Type: []*string

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

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

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

SnapshotName

Type: *string

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

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

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 taken today is retained for 5 days before being deleted.

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

Default: 0 (i.e., automatic backups are disabled for this cache 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.

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

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.

Method

GoString

func (s CreateCacheClusterInput) GoString() string

GoString returns the string representation

SetAZMode

func (s *CreateCacheClusterInput) SetAZMode(v string) *CreateCacheClusterInput

SetAZMode sets the AZMode field's value.

SetAuthToken

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

SetAuthToken sets the AuthToken field's value.

SetAutoMinorVersionUpgrade

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

SetCacheClusterId

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

SetCacheClusterId sets the CacheClusterId field's value.

SetCacheNodeType

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

SetCacheNodeType sets the CacheNodeType field's value.

SetCacheParameterGroupName

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

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

SetCacheSecurityGroupNames

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

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

SetCacheSubnetGroupName

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

SetCacheSubnetGroupName sets the CacheSubnetGroupName field's value.

SetEngine

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

SetEngine sets the Engine field's value.

SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

SetNotificationTopicArn

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

SetNotificationTopicArn sets the NotificationTopicArn field's value.

SetNumCacheNodes

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

SetNumCacheNodes sets the NumCacheNodes field's value.

SetPort

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

SetPort sets the Port field's value.

SetPreferredAvailabilityZone

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

SetPreferredAvailabilityZone sets the PreferredAvailabilityZone field's value.

SetPreferredAvailabilityZones

func (s *CreateCacheClusterInput) SetPreferredAvailabilityZones(v []*string) *CreateCacheClusterInput

SetPreferredAvailabilityZones sets the PreferredAvailabilityZones field's value.

SetPreferredMaintenanceWindow

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetReplicationGroupId

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

SetReplicationGroupId sets the ReplicationGroupId field's value.

SetSecurityGroupIds

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

SetSnapshotArns

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

SetSnapshotArns sets the SnapshotArns field's value.

SetSnapshotName

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

SetSnapshotName sets the SnapshotName field's value.

SetSnapshotRetentionLimit

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

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

SetSnapshotWindow

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

SetSnapshotWindow sets the SnapshotWindow field's value.

SetTags

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

SetTags sets the Tags field's value.

String

func (s CreateCacheClusterInput) String() string

String returns the string representation

Validate

func (s *CreateCacheClusterInput) Validate() error

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

On this page: