« blib/lib/Paws/FMS/DeleteNotificationChannel.pm
↑ Summary
blib/lib/Paws/FMS/DeleteProtocolsList.pm »
| 1 | |||
| 2 | package Paws::FMS::DeletePolicy; | ||
| 3 | use Moose; | ||
| 4 | has DeleteAllPolicyResources => (is => 'ro', isa => 'Bool'); | ||
| 5 | has PolicyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeletePolicy'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::FMS::DeletePolicy - Arguments for method DeletePolicy on L<Paws::FMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DeletePolicy on the | ||
| 23 | L<Firewall Management Service|Paws::FMS> service. Use the attributes of this class | ||
| 24 | as arguments to method DeletePolicy. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeletePolicy. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $fms = Paws->service('FMS'); | ||
| 31 | $fms->DeletePolicy( | ||
| 32 | PolicyId => 'MyPolicyId', | ||
| 33 | DeleteAllPolicyResources => 1, # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | 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. | ||
| 37 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fms/DeletePolicy> | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 DeleteAllPolicyResources => Bool | ||
| 43 | |||
| 44 | If C<True>, the request performs cleanup according to the policy type. | ||
| 45 | |||
| 46 | For AWS WAF and Shield Advanced policies, the cleanup does the | ||
| 47 | following: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | Deletes rule groups created by AWS Firewall Manager | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Removes web ACLs from in-scope resources | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | Deletes web ACLs that contain no rules or rule groups | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | For security group policies, the cleanup does the following for each | ||
| 66 | security group in the policy: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Disassociates the security group from in-scope resources | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | Deletes the security group if it was created through Firewall Manager | ||
| 77 | and if it's no longer associated with any resources through another | ||
| 78 | policy | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | After the cleanup, in-scope resources are no longer protected by web | ||
| 83 | ACLs in this policy. Protection of out-of-scope resources remains | ||
| 84 | unchanged. Scope is determined by tags that you create and accounts | ||
| 85 | that you associate with the policy. When creating the policy, if you | ||
| 86 | specify that only resources in specific accounts or with specific tags | ||
| 87 | are in scope of the policy, those accounts and resources are handled by | ||
| 88 | the policy. All others are out of scope. If you don't specify tags or | ||
| 89 | accounts, all resources are in scope. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> PolicyId => Str | ||
| 94 | |||
| 95 | The ID of the policy that you want to delete. You can retrieve this ID | ||
| 96 | from C<PutPolicy> and C<ListPolicies>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method DeletePolicy in L<Paws::FMS> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |