File Coverage

blib/lib/Paws/DAX/CreateCluster.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::DAX::CreateCluster;
3 1     1   720 use Moose;
  1         4  
  1         10  
4             has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has ClusterName => (is => 'ro', isa => 'Str', required => 1);
6             has Description => (is => 'ro', isa => 'Str');
7             has IamRoleArn => (is => 'ro', isa => 'Str', required => 1);
8             has NodeType => (is => 'ro', isa => 'Str', required => 1);
9             has NotificationTopicArn => (is => 'ro', isa => 'Str');
10             has ParameterGroupName => (is => 'ro', isa => 'Str');
11             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
12             has ReplicationFactor => (is => 'ro', isa => 'Int', required => 1);
13             has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14             has SubnetGroupName => (is => 'ro', isa => 'Str');
15             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DAX::Tag]');
16              
17 1     1   7750 use MooseX::ClassAttribute;
  1         4  
  1         8  
18              
19             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCluster');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DAX::CreateClusterResponse');
21             class_has _result_key => (isa => 'Str', is => 'ro');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::DAX::CreateCluster - Arguments for method CreateCluster on Paws::DAX
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method CreateCluster on the
33             Amazon DynamoDB Accelerator (DAX) service. Use the attributes of this class
34             as arguments to method CreateCluster.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCluster.
37              
38             As an example:
39              
40             $service_obj->CreateCluster(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 AvailabilityZones => ArrayRef[Str|Undef]
48              
49             The Availability Zones (AZs) in which the cluster nodes will be
50             created. All nodes belonging to the cluster are placed in these
51             Availability Zones. Use this parameter if you want to distribute the
52             nodes across multiple AZs.
53              
54              
55              
56             =head2 B<REQUIRED> ClusterName => Str
57              
58             The cluster identifier. This parameter is stored as a lowercase string.
59              
60             B<Constraints:>
61              
62             =over
63              
64             =item *
65              
66             A name must contain from 1 to 20 alphanumeric characters or hyphens.
67              
68             =item *
69              
70             The first character must be a letter.
71              
72             =item *
73              
74             A name cannot end with a hyphen or contain two consecutive hyphens.
75              
76             =back
77              
78              
79              
80              
81             =head2 Description => Str
82              
83             A description of the cluster.
84              
85              
86              
87             =head2 B<REQUIRED> IamRoleArn => Str
88              
89             A valid Amazon Resource Name (ARN) that identifies an IAM role. At
90             runtime, DAX will assume this role and use the role's permissions to
91             access DynamoDB on your behalf.
92              
93              
94              
95             =head2 B<REQUIRED> NodeType => Str
96              
97             The compute and memory capacity of the nodes in the cluster.
98              
99              
100              
101             =head2 NotificationTopicArn => Str
102              
103             The Amazon Resource Name (ARN) of the Amazon SNS topic to which
104             notifications will be sent.
105              
106             The Amazon SNS topic owner must be same as the DAX cluster owner.
107              
108              
109              
110             =head2 ParameterGroupName => Str
111              
112             The parameter group to be associated with the DAX cluster.
113              
114              
115              
116             =head2 PreferredMaintenanceWindow => Str
117              
118             Specifies the weekly time range during which maintenance on the DAX
119             cluster is performed. It is specified as a range in the format
120             ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
121             is a 60 minute period. Valid values for C<ddd> are:
122              
123             =over
124              
125             =item *
126              
127             C<sun>
128              
129             =item *
130              
131             C<mon>
132              
133             =item *
134              
135             C<tue>
136              
137             =item *
138              
139             C<wed>
140              
141             =item *
142              
143             C<thu>
144              
145             =item *
146              
147             C<fri>
148              
149             =item *
150              
151             C<sat>
152              
153             =back
154              
155             Example: C<sun:05:00-sun:09:00>
156              
157             If you don't specify a preferred maintenance window when you create or
158             modify a cache cluster, DAX assigns a 60-minute maintenance window on a
159             randomly selected day of the week.
160              
161              
162              
163             =head2 B<REQUIRED> ReplicationFactor => Int
164              
165             The number of nodes in the DAX cluster. A replication factor of 1 will
166             create a single-node cluster, without any read replicas. For additional
167             fault tolerance, you can create a multiple node cluster with one or
168             more read replicas. To do this, set I<ReplicationFactor> to 2 or more.
169              
170             AWS recommends that you have at least two read replicas per cluster.
171              
172              
173              
174             =head2 SecurityGroupIds => ArrayRef[Str|Undef]
175              
176             A list of security group IDs to be assigned to each node in the DAX
177             cluster. (Each of the security group ID is system-generated.)
178              
179             If this parameter is not specified, DAX assigns the default VPC
180             security group to each node.
181              
182              
183              
184             =head2 SubnetGroupName => Str
185              
186             The name of the subnet group to be used for the replication group.
187              
188             DAX clusters can only run in an Amazon VPC environment. All of the
189             subnets that you specify in a subnet group must exist in the same VPC.
190              
191              
192              
193             =head2 Tags => ArrayRef[L<Paws::DAX::Tag>]
194              
195             A set of tags to associate with the DAX cluster.
196              
197              
198              
199              
200             =head1 SEE ALSO
201              
202             This class forms part of L<Paws>, documenting arguments for method CreateCluster in L<Paws::DAX>
203              
204             =head1 BUGS and CONTRIBUTIONS
205              
206             The source code is located here: https://github.com/pplu/aws-sdk-perl
207              
208             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
209              
210             =cut
211