« blib/lib/Paws/NetworkFirewall/DisassociateSubnetsResponse.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/FirewallMetadata.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::NetworkFirewall::Firewall; | ||
| 3 | use Moose; | ||
| 4 | has DeleteProtection => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has FirewallArn => (is => 'ro', isa => 'Str'); | ||
| 7 | has FirewallId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has FirewallName => (is => 'ro', isa => 'Str'); | ||
| 9 | has FirewallPolicyArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has FirewallPolicyChangeProtection => (is => 'ro', isa => 'Bool'); | ||
| 11 | has SubnetChangeProtection => (is => 'ro', isa => 'Bool'); | ||
| 12 | has SubnetMappings => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::SubnetMapping]', required => 1); | ||
| 13 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::NetworkFirewall::Tag]'); | ||
| 14 | has VpcId => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::NetworkFirewall::Firewall | ||
| 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::NetworkFirewall::Firewall object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { DeleteProtection => $value, ..., VpcId => $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::NetworkFirewall::Firewall object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->DeleteProtection | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | The firewall defines the configuration settings for an AWS Network | ||
| 47 | Firewall firewall. These settings include the firewall policy, the | ||
| 48 | subnets in your VPC to use for the firewall endpoints, and any tags | ||
| 49 | that are attached to the firewall AWS resource. | ||
| 50 | |||
| 51 | The status of the firewall, for example whether it's ready to filter | ||
| 52 | network traffic, is provided in the corresponding FirewallStatus. You | ||
| 53 | can retrieve both objects by calling DescribeFirewall. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DeleteProtection => Bool | ||
| 59 | |||
| 60 | A flag indicating whether it is possible to delete the firewall. A | ||
| 61 | setting of C<TRUE> indicates that the firewall is protected against | ||
| 62 | deletion. Use this setting to protect against accidentally deleting a | ||
| 63 | firewall that is in use. When you create a firewall, the operation | ||
| 64 | initializes this flag to C<TRUE>. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 Description => Str | ||
| 68 | |||
| 69 | A description of the firewall. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 FirewallArn => Str | ||
| 73 | |||
| 74 | The Amazon Resource Name (ARN) of the firewall. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> FirewallId => Str | ||
| 78 | |||
| 79 | The unique identifier for the firewall. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 FirewallName => Str | ||
| 83 | |||
| 84 | The descriptive name of the firewall. You can't change the name of a | ||
| 85 | firewall after you create it. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> FirewallPolicyArn => Str | ||
| 89 | |||
| 90 | The Amazon Resource Name (ARN) of the firewall policy. | ||
| 91 | |||
| 92 | The relationship of firewall to firewall policy is many to one. Each | ||
| 93 | firewall requires one firewall policy association, and you can use the | ||
| 94 | same firewall policy for multiple firewalls. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 FirewallPolicyChangeProtection => Bool | ||
| 98 | |||
| 99 | A setting indicating whether the firewall is protected against a change | ||
| 100 | to the firewall policy association. Use this setting to protect against | ||
| 101 | accidentally modifying the firewall policy for a firewall that is in | ||
| 102 | use. When you create a firewall, the operation initializes this setting | ||
| 103 | to C<TRUE>. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 SubnetChangeProtection => Bool | ||
| 107 | |||
| 108 | A setting indicating whether the firewall is protected against changes | ||
| 109 | to the subnet associations. Use this setting to protect against | ||
| 110 | accidentally modifying the subnet associations for a firewall that is | ||
| 111 | in use. When you create a firewall, the operation initializes this | ||
| 112 | setting to C<TRUE>. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> SubnetMappings => ArrayRef[L<Paws::NetworkFirewall::SubnetMapping>] | ||
| 116 | |||
| 117 | The public subnets that Network Firewall is using for the firewall. | ||
| 118 | Each subnet must belong to a different Availability Zone. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 Tags => ArrayRef[L<Paws::NetworkFirewall::Tag>] | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> VpcId => Str | ||
| 127 | |||
| 128 | The unique identifier of the VPC where the firewall is in use. | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, describing an object used in L<Paws::NetworkFirewall> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |