blib/lib/Paws/FMS/Policy.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::FMS::Policy;
3 use Moose;
4 has ExcludeMap => (is => 'ro', isa => 'Paws::FMS::CustomerPolicyScopeMap');
5 has ExcludeResourceTags => (is => 'ro', isa => 'Bool', required => 1);
6 has IncludeMap => (is => 'ro', isa => 'Paws::FMS::CustomerPolicyScopeMap');
7 has PolicyId => (is => 'ro', isa => 'Str');
8 has PolicyName => (is => 'ro', isa => 'Str', required => 1);
9 has PolicyUpdateToken => (is => 'ro', isa => 'Str');
10 has RemediationEnabled => (is => 'ro', isa => 'Bool', required => 1);
11 has ResourceTags => (is => 'ro', isa => 'ArrayRef[Paws::FMS::ResourceTag]');
12 has ResourceType => (is => 'ro', isa => 'Str', required => 1);
13 has ResourceTypeList => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14 has SecurityServicePolicyData => (is => 'ro', isa => 'Paws::FMS::SecurityServicePolicyData', required => 1);
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::FMS::Policy
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::FMS::Policy object:
34  
35 $service_obj->Method(Att1 => { ExcludeMap => $value, ..., SecurityServicePolicyData => $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::FMS::Policy object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->ExcludeMap
43  
44 =head1 DESCRIPTION
45  
46 An AWS Firewall Manager policy.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 ExcludeMap => L<Paws::FMS::CustomerPolicyScopeMap>
52  
53 Specifies the AWS account IDs and AWS Organizations organizational
54 units (OUs) to exclude from the policy. Specifying an OU is the
55 equivalent of specifying all accounts in the OU and in any of its child
56 OUs, including any child OUs and accounts that are added at a later
57 time.
58  
59 You can specify inclusions or exclusions, but not both. If you specify
60 an C<IncludeMap>, AWS Firewall Manager applies the policy to all
61 accounts specified by the C<IncludeMap>, and does not evaluate any
62 C<ExcludeMap> specifications. If you do not specify an C<IncludeMap>,
63 then Firewall Manager applies the policy to all accounts except for
64 those specified by the C<ExcludeMap>.
65  
66 You can specify account IDs, OUs, or a combination:
67  
68 =over
69  
70 =item *
71  
72 Specify account IDs by setting the key to C<ACCOUNT>. For example, the
73 following is a valid map: C<{E<ldquo>ACCOUNTE<rdquo> :
74 [E<ldquo>accountID1E<rdquo>, E<ldquo>accountID2E<rdquo>]}>.
75  
76 =item *
77  
78 Specify OUs by setting the key to C<ORG_UNIT>. For example, the
79 following is a valid map: C<{E<ldquo>ORG_UNITE<rdquo> :
80 [E<ldquo>ouid111E<rdquo>, E<ldquo>ouid112E<rdquo>]}>.
81  
82 =item *
83  
84 Specify accounts and OUs together in a single map, separated with a
85 comma. For example, the following is a valid map:
86 C<{E<ldquo>ACCOUNTE<rdquo> : [E<ldquo>accountID1E<rdquo>,
87 E<ldquo>accountID2E<rdquo>], E<ldquo>ORG_UNITE<rdquo> :
88 [E<ldquo>ouid111E<rdquo>, E<ldquo>ouid112E<rdquo>]}>.
89  
90 =back
91  
92  
93  
94 =head2 B<REQUIRED> ExcludeResourceTags => Bool
95  
96 If set to C<True>, resources with the tags that are specified in the
97 C<ResourceTag> array are not in scope of the policy. If set to
98 C<False>, and the C<ResourceTag> array is not null, only resources with
99 the specified tags are in scope of the policy.
100  
101  
102 =head2 IncludeMap => L<Paws::FMS::CustomerPolicyScopeMap>
103  
104 Specifies the AWS account IDs and AWS Organizations organizational
105 units (OUs) to include in the policy. Specifying an OU is the
106 equivalent of specifying all accounts in the OU and in any of its child
107 OUs, including any child OUs and accounts that are added at a later
108 time.
109  
110 You can specify inclusions or exclusions, but not both. If you specify
111 an C<IncludeMap>, AWS Firewall Manager applies the policy to all
112 accounts specified by the C<IncludeMap>, and does not evaluate any
113 C<ExcludeMap> specifications. If you do not specify an C<IncludeMap>,
114 then Firewall Manager applies the policy to all accounts except for
115 those specified by the C<ExcludeMap>.
116  
117 You can specify account IDs, OUs, or a combination:
118  
119 =over
120  
121 =item *
122  
123 Specify account IDs by setting the key to C<ACCOUNT>. For example, the
124 following is a valid map: C<{E<ldquo>ACCOUNTE<rdquo> :
125 [E<ldquo>accountID1E<rdquo>, E<ldquo>accountID2E<rdquo>]}>.
126  
127 =item *
128  
129 Specify OUs by setting the key to C<ORG_UNIT>. For example, the
130 following is a valid map: C<{E<ldquo>ORG_UNITE<rdquo> :
131 [E<ldquo>ouid111E<rdquo>, E<ldquo>ouid112E<rdquo>]}>.
132  
133 =item *
134  
135 Specify accounts and OUs together in a single map, separated with a
136 comma. For example, the following is a valid map:
137 C<{E<ldquo>ACCOUNTE<rdquo> : [E<ldquo>accountID1E<rdquo>,
138 E<ldquo>accountID2E<rdquo>], E<ldquo>ORG_UNITE<rdquo> :
139 [E<ldquo>ouid111E<rdquo>, E<ldquo>ouid112E<rdquo>]}>.
140  
141 =back
142  
143  
144  
145 =head2 PolicyId => Str
146  
147 The ID of the AWS Firewall Manager policy.
148  
149  
150 =head2 B<REQUIRED> PolicyName => Str
151  
152 The name of the AWS Firewall Manager policy.
153  
154  
155 =head2 PolicyUpdateToken => Str
156  
157 A unique identifier for each update to the policy. When issuing a
158 C<PutPolicy> request, the C<PolicyUpdateToken> in the request must
159 match the C<PolicyUpdateToken> of the current policy version. To get
160 the C<PolicyUpdateToken> of the current policy version, use a
161 C<GetPolicy> request.
162  
163  
164 =head2 B<REQUIRED> RemediationEnabled => Bool
165  
166 Indicates if the policy should be automatically applied to new
167 resources.
168  
169  
170 =head2 ResourceTags => ArrayRef[L<Paws::FMS::ResourceTag>]
171  
172 An array of C<ResourceTag> objects.
173  
174  
175 =head2 B<REQUIRED> ResourceType => Str
176  
177 The type of resource protected by or in scope of the policy. This is in
178 the format shown in the AWS Resource Types Reference
179 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).
180 For AWS WAF and Shield Advanced, examples include
181 C<AWS::ElasticLoadBalancingV2::LoadBalancer> and
182 C<AWS::CloudFront::Distribution>. For a security group common policy,
183 valid values are C<AWS::EC2::NetworkInterface> and
184 C<AWS::EC2::Instance>. For a security group content audit policy, valid
185 values are C<AWS::EC2::SecurityGroup>, C<AWS::EC2::NetworkInterface>,
186 and C<AWS::EC2::Instance>. For a security group usage audit policy, the
187 value is C<AWS::EC2::SecurityGroup>. For an AWS Network Firewall
188 policy, the value is C<AWS::EC2::VPC>.
189  
190  
191 =head2 ResourceTypeList => ArrayRef[Str|Undef]
192  
193 An array of C<ResourceType>.
194  
195  
196 =head2 B<REQUIRED> SecurityServicePolicyData => L<Paws::FMS::SecurityServicePolicyData>
197  
198 Details about the security service that is being used to protect the
199 resources.
200  
201  
202  
203 =head1 SEE ALSO
204  
205 This class forms part of L<Paws>, describing an object used in L<Paws::FMS>
206  
207 =head1 BUGS and CONTRIBUTIONS
208  
209 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
210  
211 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
212  
213 =cut
214