File Coverage

blib/lib/Paws/DAX/Cluster.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DAX::Cluster;
2 1     1   406 use Moose;
  1         3  
  1         6  
3             has ActiveNodes => (is => 'ro', isa => 'Int');
4             has ClusterArn => (is => 'ro', isa => 'Str');
5             has ClusterDiscoveryEndpoint => (is => 'ro', isa => 'Paws::DAX::Endpoint');
6             has ClusterName => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has IamRoleArn => (is => 'ro', isa => 'Str');
9             has NodeIdsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             has Nodes => (is => 'ro', isa => 'ArrayRef[Paws::DAX::Node]');
11             has NodeType => (is => 'ro', isa => 'Str');
12             has NotificationConfiguration => (is => 'ro', isa => 'Paws::DAX::NotificationConfiguration');
13             has ParameterGroup => (is => 'ro', isa => 'Paws::DAX::ParameterGroupStatus');
14             has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
15             has SecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::DAX::SecurityGroupMembership]');
16             has Status => (is => 'ro', isa => 'Str');
17             has SubnetGroup => (is => 'ro', isa => 'Str');
18             has TotalNodes => (is => 'ro', isa => 'Int');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::DAX::Cluster
26              
27             =head1 USAGE
28              
29             This class represents one of two things:
30              
31             =head3 Arguments in a call to a service
32              
33             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
34             Each attribute should be used as a named argument in the calls that expect this type of object.
35              
36             As an example, if Att1 is expected to be a Paws::DAX::Cluster object:
37              
38             $service_obj->Method(Att1 => { ActiveNodes => $value, ..., TotalNodes => $value });
39              
40             =head3 Results returned from an API call
41              
42             Use accessors for each attribute. If Att1 is expected to be an Paws::DAX::Cluster object:
43              
44             $result = $service_obj->Method(...);
45             $result->Att1->ActiveNodes
46              
47             =head1 DESCRIPTION
48              
49             Contains all of the attributes of a specific DAX cluster.
50              
51             =head1 ATTRIBUTES
52              
53              
54             =head2 ActiveNodes => Int
55              
56             The number of nodes in the cluster that are active (i.e., capable of
57             serving requests).
58              
59              
60             =head2 ClusterArn => Str
61              
62             The Amazon Resource Name (ARN) that uniquely identifies the cluster.
63              
64              
65             =head2 ClusterDiscoveryEndpoint => L<Paws::DAX::Endpoint>
66              
67             The configuration endpoint for this DAX cluster, consisting of a DNS
68             name and a port number. Client applications can specify this endpoint,
69             rather than an individual node endpoint, and allow the DAX client
70             software to intelligently route requests and responses to nodes in the
71             DAX cluster.
72              
73              
74             =head2 ClusterName => Str
75              
76             The name of the DAX cluster.
77              
78              
79             =head2 Description => Str
80              
81             The description of the cluster.
82              
83              
84             =head2 IamRoleArn => Str
85              
86             A valid Amazon Resource Name (ARN) that identifies an IAM role. At
87             runtime, DAX will assume this role and use the role's permissions to
88             access DynamoDB on your behalf.
89              
90              
91             =head2 NodeIdsToRemove => ArrayRef[Str|Undef]
92              
93             A list of nodes to be removed from the cluster.
94              
95              
96             =head2 Nodes => ArrayRef[L<Paws::DAX::Node>]
97              
98             A list of nodes that are currently in the cluster.
99              
100              
101             =head2 NodeType => Str
102              
103             The node type for the nodes in the cluster. (All nodes in a DAX cluster
104             are of the same type.)
105              
106              
107             =head2 NotificationConfiguration => L<Paws::DAX::NotificationConfiguration>
108              
109             Describes a notification topic and its status. Notification topics are
110             used for publishing DAX events to subscribers using Amazon Simple
111             Notification Service (SNS).
112              
113              
114             =head2 ParameterGroup => L<Paws::DAX::ParameterGroupStatus>
115              
116             The parameter group being used by nodes in the cluster.
117              
118              
119             =head2 PreferredMaintenanceWindow => Str
120              
121             A range of time when maintenance of DAX cluster software will be
122             performed. For example: C<sun:01:00-sun:09:00>. Cluster maintenance
123             normally takes less than 30 minutes, and is performed automatically
124             within the maintenance window.
125              
126              
127             =head2 SecurityGroups => ArrayRef[L<Paws::DAX::SecurityGroupMembership>]
128              
129             A list of security groups, and the status of each, for the nodes in the
130             cluster.
131              
132              
133             =head2 Status => Str
134              
135             The current status of the cluster.
136              
137              
138             =head2 SubnetGroup => Str
139              
140             The subnet group where the DAX cluster is running.
141              
142              
143             =head2 TotalNodes => Int
144              
145             The total number of nodes in the cluster.
146              
147              
148              
149             =head1 SEE ALSO
150              
151             This class forms part of L<Paws>, describing an object used in L<Paws::DAX>
152              
153             =head1 BUGS and CONTRIBUTIONS
154              
155             The source code is located here: https://github.com/pplu/aws-sdk-perl
156              
157             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
158              
159             =cut
160