blib/lib/Paws/ES/ElasticsearchDomainStatus.pm

filter: Statementstmt 100% 28 / 28 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 29 / 29 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/ES/ElasticsearchClusterConfig.pm ↑ Summary blib/lib/Paws/ES/EncryptionAtRestOptions.pm »
1 # Generated by default/object.tt
2 package Paws::ES::ElasticsearchDomainStatus;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AccessPolicies => (is => 'ro', isa => 'Str');
5 1 has AdvancedOptions => (is => 'ro', isa => 'Paws::ES::AdvancedOptions');
6 1 has AdvancedSecurityOptions => (is => 'ro', isa => 'Paws::ES::AdvancedSecurityOptions');
7 1 has ARN => (is => 'ro', isa => 'Str', required => 1);
8 1 has AutoTuneOptions => (is => 'ro', isa => 'Paws::ES::AutoTuneOptionsOutput');
9 1 has CognitoOptions => (is => 'ro', isa => 'Paws::ES::CognitoOptions');
10 1 has Created => (is => 'ro', isa => 'Bool');
11 1 has Deleted => (is => 'ro', isa => 'Bool');
12 1 has DomainEndpointOptions => (is => 'ro', isa => 'Paws::ES::DomainEndpointOptions');
13 1 has DomainId => (is => 'ro', isa => 'Str', required => 1);
14 1 has DomainName => (is => 'ro', isa => 'Str', required => 1);
15 1 has EBSOptions => (is => 'ro', isa => 'Paws::ES::EBSOptions');
16 1 has ElasticsearchClusterConfig => (is => 'ro', isa => 'Paws::ES::ElasticsearchClusterConfig', required => 1);
17 1 has ElasticsearchVersion => (is => 'ro', isa => 'Str');
18 1 has EncryptionAtRestOptions => (is => 'ro', isa => 'Paws::ES::EncryptionAtRestOptions');
19 1 has Endpoint => (is => 'ro', isa => 'Str');
20 1 has Endpoints => (is => 'ro', isa => 'Paws::ES::EndpointsMap');
21 1 has LogPublishingOptions => (is => 'ro', isa => 'Paws::ES::LogPublishingOptions');
22 1 has NodeToNodeEncryptionOptions => (is => 'ro', isa => 'Paws::ES::NodeToNodeEncryptionOptions');
23 1 has Processing => (is => 'ro', isa => 'Bool');
24 1 has ServiceSoftwareOptions => (is => 'ro', isa => 'Paws::ES::ServiceSoftwareOptions');
25 1 has SnapshotOptions => (is => 'ro', isa => 'Paws::ES::SnapshotOptions');
26 1 has UpgradeProcessing => (is => 'ro', isa => 'Bool');
27 1 has VPCOptions => (is => 'ro', isa => 'Paws::ES::VPCDerivedInfo');
28  
29 1 1;
30  
31 ### main pod documentation begin ###
32  
33 =head1 NAME
34  
35 Paws::ES::ElasticsearchDomainStatus
36  
37 =head1 USAGE
38  
39 This class represents one of two things:
40  
41 =head3 Arguments in a call to a service
42  
43 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
44 Each attribute should be used as a named argument in the calls that expect this type of object.
45  
46 As an example, if Att1 is expected to be a Paws::ES::ElasticsearchDomainStatus object:
47  
48 $service_obj->Method(Att1 => { AccessPolicies => $value, ..., VPCOptions => $value });
49  
50 =head3 Results returned from an API call
51  
52 Use accessors for each attribute. If Att1 is expected to be an Paws::ES::ElasticsearchDomainStatus object:
53  
54 $result = $service_obj->Method(...);
55 $result->Att1->AccessPolicies
56  
57 =head1 DESCRIPTION
58  
59 The current status of an Elasticsearch domain.
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 AccessPolicies => Str
65  
66 IAM access policy as a JSON-formatted string.
67  
68  
69 =head2 AdvancedOptions => L<Paws::ES::AdvancedOptions>
70  
71 Specifies the status of the C<AdvancedOptions>
72  
73  
74 =head2 AdvancedSecurityOptions => L<Paws::ES::AdvancedSecurityOptions>
75  
76 The current status of the Elasticsearch domain's advanced security
77 options.
78  
79  
80 =head2 B<REQUIRED> ARN => Str
81  
82 The Amazon resource name (ARN) of an Elasticsearch domain. See
83 Identifiers for IAM Entities
84 (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html)
85 in I<Using AWS Identity and Access Management> for more information.
86  
87  
88 =head2 AutoTuneOptions => L<Paws::ES::AutoTuneOptionsOutput>
89  
90 The current status of the Elasticsearch domain's Auto-Tune options.
91  
92  
93 =head2 CognitoOptions => L<Paws::ES::CognitoOptions>
94  
95 The C<CognitoOptions> for the specified domain. For more information,
96 see Amazon Cognito Authentication for Kibana
97 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html).
98  
99  
100 =head2 Created => Bool
101  
102 The domain creation status. C<True> if the creation of an Elasticsearch
103 domain is complete. C<False> if domain creation is still in progress.
104  
105  
106 =head2 Deleted => Bool
107  
108 The domain deletion status. C<True> if a delete request has been
109 received for the domain but resource cleanup is still in progress.
110 C<False> if the domain has not been deleted. Once domain deletion is
111 complete, the status of the domain is no longer returned.
112  
113  
114 =head2 DomainEndpointOptions => L<Paws::ES::DomainEndpointOptions>
115  
116 The current status of the Elasticsearch domain's endpoint options.
117  
118  
119 =head2 B<REQUIRED> DomainId => Str
120  
121 The unique identifier for the specified Elasticsearch domain.
122  
123  
124 =head2 B<REQUIRED> DomainName => Str
125  
126 The name of an Elasticsearch domain. Domain names are unique across the
127 domains owned by an account within an AWS region. Domain names start
128 with a letter or number and can contain the following characters: a-z
129 (lowercase), 0-9, and - (hyphen).
130  
131  
132 =head2 EBSOptions => L<Paws::ES::EBSOptions>
133  
134 The C<EBSOptions> for the specified domain. See Configuring EBS-based
135 Storage
136 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs)
137 for more information.
138  
139  
140 =head2 B<REQUIRED> ElasticsearchClusterConfig => L<Paws::ES::ElasticsearchClusterConfig>
141  
142 The type and number of instances in the domain cluster.
143  
144  
145 =head2 ElasticsearchVersion => Str
146  
147  
148  
149  
150 =head2 EncryptionAtRestOptions => L<Paws::ES::EncryptionAtRestOptions>
151  
152 Specifies the status of the C<EncryptionAtRestOptions>.
153  
154  
155 =head2 Endpoint => Str
156  
157 The Elasticsearch domain endpoint that you use to submit index and
158 search requests.
159  
160  
161 =head2 Endpoints => L<Paws::ES::EndpointsMap>
162  
163 Map containing the Elasticsearch domain endpoints used to submit index
164 and search requests. Example C<key, value>:
165 C<'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'>.
166  
167  
168 =head2 LogPublishingOptions => L<Paws::ES::LogPublishingOptions>
169  
170 Log publishing options for the given domain.
171  
172  
173 =head2 NodeToNodeEncryptionOptions => L<Paws::ES::NodeToNodeEncryptionOptions>
174  
175 Specifies the status of the C<NodeToNodeEncryptionOptions>.
176  
177  
178 =head2 Processing => Bool
179  
180 The status of the Elasticsearch domain configuration. C<True> if Amazon
181 Elasticsearch Service is processing configuration changes. C<False> if
182 the configuration is active.
183  
184  
185 =head2 ServiceSoftwareOptions => L<Paws::ES::ServiceSoftwareOptions>
186  
187 The current status of the Elasticsearch domain's service software.
188  
189  
190 =head2 SnapshotOptions => L<Paws::ES::SnapshotOptions>
191  
192 Specifies the status of the C<SnapshotOptions>
193  
194  
195 =head2 UpgradeProcessing => Bool
196  
197 The status of an Elasticsearch domain version upgrade. C<True> if
198 Amazon Elasticsearch Service is undergoing a version upgrade. C<False>
199 if the configuration is active.
200  
201  
202 =head2 VPCOptions => L<Paws::ES::VPCDerivedInfo>
203  
204 The C<VPCOptions> for the specified domain. For more information, see
205 VPC Endpoints for Amazon Elasticsearch Service Domains
206 (http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html).
207  
208  
209  
210 =head1 SEE ALSO
211  
212 This class forms part of L<Paws>, describing an object used in L<Paws::ES>
213  
214 =head1 BUGS and CONTRIBUTIONS
215  
216 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
217  
218 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
219  
220 =cut
221  
« blib/lib/Paws/ES/ElasticsearchClusterConfig.pm ↑ Summary blib/lib/Paws/ES/EncryptionAtRestOptions.pm »