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