| 1 | |||
| 2 | package Paws::DAX::CreateCluster; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has ClusterEndpointEncryptionType => (is => 'ro', isa => 'Str'); | ||
| 6 | has ClusterName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has IamRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has NodeType => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has NotificationTopicArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has ParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 12 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 13 | has ReplicationFactor => (is => 'ro', isa => 'Int', required => 1); | ||
| 14 | has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | has SSESpecification => (is => 'ro', isa => 'Paws::DAX::SSESpecification'); | ||
| 16 | has SubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 17 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DAX::Tag]'); | ||
| 18 | |||
| 19 | use MooseX::ClassAttribute; | ||
| 20 | |||
| 21 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DAX::CreateClusterResponse'); | ||
| 23 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::DAX::CreateCluster - Arguments for method CreateCluster on L<Paws::DAX> | ||
| 31 | |||
| 32 | =head1 DESCRIPTION | ||
| 33 | |||
| 34 | This class represents the parameters used for calling the method CreateCluster on the | ||
| 35 | L<Amazon DynamoDB Accelerator (DAX)|Paws::DAX> service. Use the attributes of this class | ||
| 36 | as arguments to method CreateCluster. | ||
| 37 | |||
| 38 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster. | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | my $dax = Paws->service('DAX'); | ||
| 43 | my $CreateClusterResponse = $dax->CreateCluster( | ||
| 44 | ClusterName => 'MyString', | ||
| 45 | IamRoleArn => 'MyString', | ||
| 46 | NodeType => 'MyString', | ||
| 47 | ReplicationFactor => 1, | ||
| 48 | AvailabilityZones => [ 'MyString', ... ], # OPTIONAL | ||
| 49 | ClusterEndpointEncryptionType => 'NONE', # OPTIONAL | ||
| 50 | Description => 'MyString', # OPTIONAL | ||
| 51 | NotificationTopicArn => 'MyString', # OPTIONAL | ||
| 52 | ParameterGroupName => 'MyString', # OPTIONAL | ||
| 53 | PreferredMaintenanceWindow => 'MyString', # OPTIONAL | ||
| 54 | SSESpecification => { | ||
| 55 | Enabled => 1, | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | SecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 59 | SubnetGroupName => 'MyString', # OPTIONAL | ||
| 60 | Tags => [ | ||
| 61 | { | ||
| 62 | Key => 'MyString', | ||
| 63 | Value => 'MyString', | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $Cluster = $CreateClusterResponse->Cluster; | ||
| 71 | |||
| 72 | # Returns a L<Paws::DAX::CreateClusterResponse> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dax/CreateCluster> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 81 | |||
| 82 | The Availability Zones (AZs) in which the cluster nodes will reside | ||
| 83 | after the cluster has been created or updated. If provided, the length | ||
| 84 | of this list must equal the C<ReplicationFactor> parameter. If you omit | ||
| 85 | this parameter, DAX will spread the nodes across Availability Zones for | ||
| 86 | the highest availability. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ClusterEndpointEncryptionType => Str | ||
| 91 | |||
| 92 | The type of encryption the cluster's endpoint should support. Values | ||
| 93 | are: | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | C<NONE> for no encryption | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<TLS> for Transport Layer Security | ||
| 104 | |||
| 105 | =back | ||
| 106 | |||
| 107 | |||
| 108 | Valid values are: C<"NONE">, C<"TLS"> | ||
| 109 | |||
| 110 | =head2 B<REQUIRED> ClusterName => Str | ||
| 111 | |||
| 112 | The cluster identifier. This parameter is stored as a lowercase string. | ||
| 113 | |||
| 114 | B<Constraints:> | ||
| 115 | |||
| 116 | =over | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | A name must contain from 1 to 20 alphanumeric characters or hyphens. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | The first character must be a letter. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | A name cannot end with a hyphen or contain two consecutive hyphens. | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 Description => Str | ||
| 136 | |||
| 137 | A description of the cluster. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 B<REQUIRED> IamRoleArn => Str | ||
| 142 | |||
| 143 | A valid Amazon Resource Name (ARN) that identifies an IAM role. At | ||
| 144 | runtime, DAX will assume this role and use the role's permissions to | ||
| 145 | access DynamoDB on your behalf. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 B<REQUIRED> NodeType => Str | ||
| 150 | |||
| 151 | The compute and memory capacity of the nodes in the cluster. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 NotificationTopicArn => Str | ||
| 156 | |||
| 157 | The Amazon Resource Name (ARN) of the Amazon SNS topic to which | ||
| 158 | notifications will be sent. | ||
| 159 | |||
| 160 | The Amazon SNS topic owner must be same as the DAX cluster owner. | ||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head2 ParameterGroupName => Str | ||
| 165 | |||
| 166 | The parameter group to be associated with the DAX cluster. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 PreferredMaintenanceWindow => Str | ||
| 171 | |||
| 172 | Specifies the weekly time range during which maintenance on the DAX | ||
| 173 | cluster is performed. It is specified as a range in the format | ||
| 174 | ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window | ||
| 175 | is a 60 minute period. Valid values for C<ddd> are: | ||
| 176 | |||
| 177 | =over | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | C<sun> | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | C<mon> | ||
| 186 | |||
| 187 | =item * | ||
| 188 | |||
| 189 | C<tue> | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | C<wed> | ||
| 194 | |||
| 195 | =item * | ||
| 196 | |||
| 197 | C<thu> | ||
| 198 | |||
| 199 | =item * | ||
| 200 | |||
| 201 | C<fri> | ||
| 202 | |||
| 203 | =item * | ||
| 204 | |||
| 205 | C<sat> | ||
| 206 | |||
| 207 | =back | ||
| 208 | |||
| 209 | Example: C<sun:05:00-sun:09:00> | ||
| 210 | |||
| 211 | If you don't specify a preferred maintenance window when you create or | ||
| 212 | modify a cache cluster, DAX assigns a 60-minute maintenance window on a | ||
| 213 | randomly selected day of the week. | ||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head2 B<REQUIRED> ReplicationFactor => Int | ||
| 218 | |||
| 219 | The number of nodes in the DAX cluster. A replication factor of 1 will | ||
| 220 | create a single-node cluster, without any read replicas. For additional | ||
| 221 | fault tolerance, you can create a multiple node cluster with one or | ||
| 222 | more read replicas. To do this, set C<ReplicationFactor> to a number | ||
| 223 | between 3 (one primary and two read replicas) and 10 (one primary and | ||
| 224 | nine read replicas). C<If the AvailabilityZones> parameter is provided, | ||
| 225 | its length must equal the C<ReplicationFactor>. | ||
| 226 | |||
| 227 | AWS recommends that you have at least two read replicas per cluster. | ||
| 228 | |||
| 229 | |||
| 230 | |||
| 231 | =head2 SecurityGroupIds => ArrayRef[Str|Undef] | ||
| 232 | |||
| 233 | A list of security group IDs to be assigned to each node in the DAX | ||
| 234 | cluster. (Each of the security group ID is system-generated.) | ||
| 235 | |||
| 236 | If this parameter is not specified, DAX assigns the default VPC | ||
| 237 | security group to each node. | ||
| 238 | |||
| 239 | |||
| 240 | |||
| 241 | =head2 SSESpecification => L<Paws::DAX::SSESpecification> | ||
| 242 | |||
| 243 | Represents the settings used to enable server-side encryption on the | ||
| 244 | cluster. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head2 SubnetGroupName => Str | ||
| 249 | |||
| 250 | The name of the subnet group to be used for the replication group. | ||
| 251 | |||
| 252 | DAX clusters can only run in an Amazon VPC environment. All of the | ||
| 253 | subnets that you specify in a subnet group must exist in the same VPC. | ||
| 254 | |||
| 255 | |||
| 256 | |||
| 257 | =head2 Tags => ArrayRef[L<Paws::DAX::Tag>] | ||
| 258 | |||
| 259 | A set of tags to associate with the DAX cluster. | ||
| 260 | |||
| 261 | |||
| 262 | |||
| 263 | |||
| 264 | =head1 SEE ALSO | ||
| 265 | |||
| 266 | This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::DAX> | ||
| 267 | |||
| 268 | =head1 BUGS and CONTRIBUTIONS | ||
| 269 | |||
| 270 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 271 | |||
| 272 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 273 | |||
| 274 | =cut | ||
| 275 |