« blib/lib/Paws/NetworkFirewall/FirewallPolicyResponse.pm
↑ Summary
blib/lib/Paws/NetworkFirewall/Header.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::NetworkFirewall::FirewallStatus; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSyncStateSummary => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SyncStates => (is => 'ro', isa => 'Paws::NetworkFirewall::SyncStates'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::NetworkFirewall::FirewallStatus | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::NetworkFirewall::FirewallStatus object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ConfigurationSyncStateSummary => $value, ..., SyncStates => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::NetworkFirewall::FirewallStatus object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ConfigurationSyncStateSummary | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Detailed information about the current status of a Firewall. You can | ||
| 39 | retrieve this for a firewall by calling DescribeFirewall and providing | ||
| 40 | the firewall name and ARN. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> ConfigurationSyncStateSummary => Str | ||
| 46 | |||
| 47 | The configuration sync state for the firewall. This summarizes the sync | ||
| 48 | states reported in the C<Config> settings for all of the Availability | ||
| 49 | Zones where you have configured the firewall. | ||
| 50 | |||
| 51 | When you create a firewall or update its configuration, for example by | ||
| 52 | adding a rule group to its firewall policy, Network Firewall | ||
| 53 | distributes the configuration changes to all zones where the firewall | ||
| 54 | is in use. This summary indicates whether the configuration changes | ||
| 55 | have been applied everywhere. | ||
| 56 | |||
| 57 | This status must be C<IN_SYNC> for the firewall to be ready for use, | ||
| 58 | but it doesn't indicate that the firewall is ready. The C<Status> | ||
| 59 | setting indicates firewall readiness. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Status => Str | ||
| 63 | |||
| 64 | The readiness of the configured firewall to handle network traffic | ||
| 65 | across all of the Availability Zones where you've configured it. This | ||
| 66 | setting is C<READY> only when the C<ConfigurationSyncStateSummary> | ||
| 67 | value is C<IN_SYNC> and the C<Attachment> C<Status> values for all of | ||
| 68 | the configured subnets are C<READY>. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 SyncStates => L<Paws::NetworkFirewall::SyncStates> | ||
| 72 | |||
| 73 | The subnets that you've configured for use by the Network Firewall | ||
| 74 | firewall. This contains one array element per Availability Zone where | ||
| 75 | you've configured a subnet. These objects provide details of the | ||
| 76 | information that is summarized in the C<ConfigurationSyncStateSummary> | ||
| 77 | and C<Status>, broken down by zone and configuration object. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, describing an object used in L<Paws::NetworkFirewall> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |