File Coverage

blib/lib/Paws/EC2/DescribeSubnets.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	16	16	100.0

line	stmt	sub	time	code
1
2				package Paws::EC2::DescribeSubnets;
3	1	1	298	use Moose;
	1	1	3
	1		6
	1		420
	1		2
	1		6
4				has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5				has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6				has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str\|Undef]', traits => ['NameInRequest'], request_name => 'SubnetId' );
7
8	1	1	5336	use MooseX::ClassAttribute;
	1	1	3
	1		6
	1		5699
	1		2
	1		5
9
10				class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSubnets');
11				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSubnetsResult');
12				class_has _result_key => (isa => 'Str', is => 'ro');
13				1;
14
15				### main pod documentation begin ###
16
17				=head1 NAME
18
19				Paws::EC2::DescribeSubnets - Arguments for method DescribeSubnets on Paws::EC2
20
21				=head1 DESCRIPTION
22
23				This class represents the parameters used for calling the method DescribeSubnets on the
24				Amazon Elastic Compute Cloud service. Use the attributes of this class
25				as arguments to method DescribeSubnets.
26
27				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSubnets.
28
29				As an example:
30
31				$service_obj->DescribeSubnets(Att1 => $value1, Att2 => $value2, ...);
32
33				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.
34
35				=head1 ATTRIBUTES
36
37
38				=head2 DryRun => Bool
39
40				Checks whether you have the required permissions for the action,
41				without actually making the request, and provides an error response. If
42				you have the required permissions, the error response is
43				C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
44
45
46
47				=head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
48
49				One or more filters.
50
51				=over
52
53				=item *
54
55				C<availabilityZone> - The Availability Zone for the subnet. You can
56				also use C<availability-zone> as the filter name.
57
58				=item *
59
60				C<available-ip-address-count> - The number of IPv4 addresses in the
61				subnet that are available.
62
63				=item *
64
65				C<cidrBlock> - The IPv4 CIDR block of the subnet. The CIDR block you
66				specify must exactly match the subnet's CIDR block for information to
67				be returned for the subnet. You can also use C<cidr> or C<cidr-block>
68				as the filter names.
69
70				=item *
71
72				C<defaultForAz> - Indicates whether this is the default subnet for the
73				Availability Zone. You can also use C<default-for-az> as the filter
74				name.
75
76				=item *
77
78				C<ipv6-cidr-block-association.ipv6-cidr-block> - An IPv6 CIDR block
79				associated with the subnet.
80
81				=item *
82
83				C<ipv6-cidr-block-association.association-id> - An association ID for
84				an IPv6 CIDR block associated with the subnet.
85
86				=item *
87
88				C<ipv6-cidr-block-association.state> - The state of an IPv6 CIDR block
89				associated with the subnet.
90
91				=item *
92
93				C<state> - The state of the subnet (C<pending> \| C<available>).
94
95				=item *
96
97				C<subnet-id> - The ID of the subnet.
98
99				=item *
100
101				C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
102				the resource. Specify the key of the tag in the filter name and the
103				value of the tag in the filter value. For example, for the tag
104				Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
105				filter value.
106
107				=item *
108
109				C<tag-key> - The key of a tag assigned to the resource. This filter is
110				independent of the C<tag-value> filter. For example, if you use both
111				the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
112				resources assigned both the tag key Purpose (regardless of what the
113				tag's value is), and the tag value X (regardless of what the tag's key
114				is). If you want to list only resources where Purpose is X, see the
115				C<tag>:I<key>=I<value> filter.
116
117				=item *
118
119				C<tag-value> - The value of a tag assigned to the resource. This filter
120				is independent of the C<tag-key> filter.
121
122				=item *
123
124				C<vpc-id> - The ID of the VPC for the subnet.
125
126				=back
127
128
129
130
131				=head2 SubnetIds => ArrayRef[Str\|Undef]
132
133				One or more subnet IDs.
134
135				Default: Describes all your subnets.
136
137
138
139
140				=head1 SEE ALSO
141
142				This class forms part of L<Paws>, documenting arguments for method DescribeSubnets in L<Paws::EC2>
143
144				=head1 BUGS and CONTRIBUTIONS
145
146				The source code is located here: https://github.com/pplu/aws-sdk-perl
147
148				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
149
150				=cut
151