File Coverage

blib/lib/Paws/ES/ElasticsearchDomainStatus.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             package Paws::ES::ElasticsearchDomainStatus;
2 1     1   445 use Moose;
  1     1   3  
  1         9  
  1         298  
  1         2  
  1         6  
3             has AccessPolicies => (is => 'ro', isa => 'Str');
4             has AdvancedOptions => (is => 'ro', isa => 'Paws::ES::AdvancedOptions');
5             has ARN => (is => 'ro', isa => 'Str', required => 1);
6             has Created => (is => 'ro', isa => 'Bool');
7             has Deleted => (is => 'ro', isa => 'Bool');
8             has DomainId => (is => 'ro', isa => 'Str', required => 1);
9             has DomainName => (is => 'ro', isa => 'Str', required => 1);
10             has EBSOptions => (is => 'ro', isa => 'Paws::ES::EBSOptions');
11             has ElasticsearchClusterConfig => (is => 'ro', isa => 'Paws::ES::ElasticsearchClusterConfig', required => 1);
12             has ElasticsearchVersion => (is => 'ro', isa => 'Str');
13             has Endpoint => (is => 'ro', isa => 'Str');
14             has Processing => (is => 'ro', isa => 'Bool');
15             has SnapshotOptions => (is => 'ro', isa => 'Paws::ES::SnapshotOptions');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ES::ElasticsearchDomainStatus
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::ES::ElasticsearchDomainStatus object:
34              
35             $service_obj->Method(Att1 => { AccessPolicies => $value, ..., SnapshotOptions => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::ES::ElasticsearchDomainStatus object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->AccessPolicies
43              
44             =head1 DESCRIPTION
45              
46             The current status of an Elasticsearch domain.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 AccessPolicies => Str
52              
53             IAM access policy as a JSON-formatted string.
54              
55              
56             =head2 AdvancedOptions => L<Paws::ES::AdvancedOptions>
57              
58             Specifies the status of the C<AdvancedOptions>
59              
60              
61             =head2 B<REQUIRED> ARN => Str
62              
63             The Amazon resource name (ARN) of an Elasticsearch domain. See
64             Identifiers for IAM Entities in I<Using AWS Identity and Access
65             Management> for more information.
66              
67              
68             =head2 Created => Bool
69              
70             The domain creation status. C<True> if the creation of an Elasticsearch
71             domain is complete. C<False> if domain creation is still in progress.
72              
73              
74             =head2 Deleted => Bool
75              
76             The domain deletion status. C<True> if a delete request has been
77             received for the domain but resource cleanup is still in progress.
78             C<False> if the domain has not been deleted. Once domain deletion is
79             complete, the status of the domain is no longer returned.
80              
81              
82             =head2 B<REQUIRED> DomainId => Str
83              
84             The unique identifier for the specified Elasticsearch domain.
85              
86              
87             =head2 B<REQUIRED> DomainName => Str
88              
89             The name of an Elasticsearch domain. Domain names are unique across the
90             domains owned by an account within an AWS region. Domain names start
91             with a letter or number and can contain the following characters: a-z
92             (lowercase), 0-9, and - (hyphen).
93              
94              
95             =head2 EBSOptions => L<Paws::ES::EBSOptions>
96              
97             The C<EBSOptions> for the specified domain. See Configuring EBS-based
98             Storage for more information.
99              
100              
101             =head2 B<REQUIRED> ElasticsearchClusterConfig => L<Paws::ES::ElasticsearchClusterConfig>
102              
103             The type and number of instances in the domain cluster.
104              
105              
106             =head2 ElasticsearchVersion => Str
107              
108            
109              
110              
111             =head2 Endpoint => Str
112              
113             The Elasticsearch domain endpoint that you use to submit index and
114             search requests.
115              
116              
117             =head2 Processing => Bool
118              
119             The status of the Elasticsearch domain configuration. C<True> if Amazon
120             Elasticsearch Service is processing configuration changes. C<False> if
121             the configuration is active.
122              
123              
124             =head2 SnapshotOptions => L<Paws::ES::SnapshotOptions>
125              
126             Specifies the status of the C<SnapshotOptions>
127              
128              
129              
130             =head1 SEE ALSO
131              
132             This class forms part of L<Paws>, describing an object used in L<Paws::ES>
133              
134             =head1 BUGS and CONTRIBUTIONS
135              
136             The source code is located here: https://github.com/pplu/aws-sdk-perl
137              
138             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
139              
140             =cut
141