NAME

Paws::DAX::CreateCluster - Arguments for method CreateCluster on Paws::DAX

DESCRIPTION

This class represents the parameters used for calling the method CreateCluster on the Amazon DynamoDB Accelerator (DAX) service. Use the attributes of this class as arguments to method CreateCluster.

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

SYNOPSIS

    my $dax = Paws->service('DAX');
    my $CreateClusterResponse = $dax->CreateCluster(
      ClusterName                   => 'MyString',
      IamRoleArn                    => 'MyString',
      NodeType                      => 'MyString',
      ReplicationFactor             => 1,
      AvailabilityZones             => [ 'MyString', ... ],    # OPTIONAL
      ClusterEndpointEncryptionType => 'NONE',                 # OPTIONAL
      Description                   => 'MyString',             # OPTIONAL
      NotificationTopicArn          => 'MyString',             # OPTIONAL
      ParameterGroupName            => 'MyString',             # OPTIONAL
      PreferredMaintenanceWindow    => 'MyString',             # OPTIONAL
      SSESpecification              => {
        Enabled => 1,
      },                                                       # OPTIONAL
      SecurityGroupIds => [ 'MyString', ... ],                 # OPTIONAL
      SubnetGroupName  => 'MyString',                          # OPTIONAL
      Tags             => [
        {
          Key   => 'MyString',
          Value => 'MyString',
        },
        ...
      ],                                                       # OPTIONAL
    );
    # Results:
    my $Cluster = $CreateClusterResponse->Cluster;
    # Returns a L<Paws::DAX::CreateClusterResponse> 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/dax/CreateCluster>

ATTRIBUTES

AvailabilityZones => ArrayRef[Str|Undef]

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the "ReplicationFactor" parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

ClusterEndpointEncryptionType => Str

The type of encryption the cluster's endpoint should support. Values are:

"NONE" for no encryption
"TLS" for Transport Layer Security

Valid values are: "NONE", "TLS"

REQUIRED ClusterName => Str

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

Description => Str

A description of the cluster.

REQUIRED IamRoleArn => Str

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

REQUIRED NodeType => Str

The compute and memory capacity of the nodes in the cluster.

NotificationTopicArn => Str

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

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

ParameterGroupName => Str

The parameter group to be associated with the DAX cluster.

PreferredMaintenanceWindow => Str

Specifies the weekly time range during which maintenance on the DAX 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:05:00-sun:09:00"

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

REQUIRED ReplicationFactor => Int

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set "ReplicationFactor" to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). "If the AvailabilityZones" parameter is provided, its length must equal the "ReplicationFactor".

AWS recommends that you have at least two read replicas per cluster.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>