NAME

Paws::ElastiCache::CreateCacheCluster - Arguments for method CreateCacheCluster on Paws::ElastiCache

DESCRIPTION

This class represents the parameters used for calling the method CreateCacheCluster on the Amazon ElastiCache service. Use the attributes of this class as arguments to method CreateCacheCluster.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCacheCluster.

SYNOPSIS

    my $elasticache = Paws->service('ElastiCache');
    # CreateCacheCluster
    # Creates a Memcached cluster with 2 nodes.
    my $CreateCacheClusterResult = $elasticache->CreateCacheCluster(
      'AZMode'               => 'cross-az',
      'CacheClusterId'       => 'my-memcached-cluster',
      'CacheNodeType'        => 'cache.r3.large',
      'CacheSubnetGroupName' => 'default',
      'Engine'               => 'memcached',
      'EngineVersion'        => '1.4.24',
      'NumCacheNodes'        => 2,
      'Port'                 => 11211
    );

    # Results:
    my $CacheCluster = $CreateCacheClusterResult->CacheCluster;

    # Returns a L<Paws::ElastiCache::CreateCacheClusterResult> object.
    # CreateCacheCluster
    # Creates a Redis cluster with 1 node.
    my $CreateCacheClusterResult = $elasticache->CreateCacheCluster(
      'AutoMinorVersionUpgrade'   => 1,
      'CacheClusterId'            => 'my-redis',
      'CacheNodeType'             => 'cache.r3.larage',
      'CacheSubnetGroupName'      => 'default',
      'Engine'                    => 'redis',
      'EngineVersion'             => '3.2.4',
      'NumCacheNodes'             => 1,
      'Port'                      => 6379,
      'PreferredAvailabilityZone' => 'us-east-1c',
      'SnapshotRetentionLimit'    => 7
    );

    # Results:
    my $CacheCluster = $CreateCacheClusterResult->CacheCluster;

    # Returns a L<Paws::ElastiCache::CreateCacheClusterResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elasticache/CreateCacheCluster

ATTRIBUTES

AuthToken => Str

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.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

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

AutoMinorVersionUpgrade => Bool

This parameter is currently disabled.

AZMode => Str

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.

Valid values are: "single-az", "cross-az"

REQUIRED CacheClusterId => Str

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.

CacheNodeType => Str

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:
  
  M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  
  cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
  
  For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
  
  M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
  
  M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
  
  T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
  
  T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
- 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
  
  M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
- Previous generation: (not recommended)
  
  C1 node types: cache.c1.xlarge
Memory optimized:
- Current generation:
  
  R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  
  cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
  
  For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)
  
  R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
  
  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
  
  R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

CacheParameterGroupName => Str

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 => ArrayRef[Str|Undef]

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 => Str

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 => Str

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

EngineVersion => Str

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.

LogDeliveryConfigurations => ArrayRef[Paws::ElastiCache::LogDeliveryConfigurationRequest]

Specifies the destination, format and type of the logs.

NotificationTopicArn => Str

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 => Int

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 40.

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

OutpostMode => Str

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Valid values are: "single-outpost", "cross-outpost"

Port => Int

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

PreferredAvailabilityZone => Str

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this 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 => ArrayRef[Str|Undef]

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 => Str

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:

PreferredOutpostArn => Str

The outpost ARN in which the cache cluster is created.

PreferredOutpostArns => ArrayRef[Str|Undef]

The outpost ARNs in which the cache cluster is created.

ReplicationGroupId => Str

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.