AssociateFirewallPolicy

$result = $client->associateFirewallPolicy([/* ... */]);
$promise = $client->associateFirewallPolicyAsync([/* ... */]);

Associates a FirewallPolicy to a Firewall.

A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

Parameter Syntax

$result = $client->associateFirewallPolicy([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyArn' => '<string>', // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyArn' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

AssociateSubnets

$result = $client->associateSubnets([/* ... */]);
$promise = $client->associateSubnetsAsync([/* ... */]);

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.

This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.

Parameter Syntax

$result = $client->associateSubnets([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [ // REQUIRED
        [
            'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [
        [
            'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

InsufficientCapacityException:

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

CreateFirewall

$result = $client->createFirewall([/* ... */]);
$promise = $client->createFirewallAsync([/* ... */]);

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

Parameter Syntax

$result = $client->createFirewall([
    'DeleteProtection' => true || false,
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallName' => '<string>', // REQUIRED
    'FirewallPolicyArn' => '<string>', // REQUIRED
    'FirewallPolicyChangeProtection' => true || false,
    'SubnetChangeProtection' => true || false,
    'SubnetMappings' => [ // REQUIRED
        [
            'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'CapacityUsageSummary' => [
            'CIDRs' => [
                'AvailableCIDRCount' => <integer>,
                'IPSetReferences' => [
                    '<IPSetArn>' => [
                        'ResolvedCIDRCount' => <integer>,
                    ],
                    // ...
                ],
                'UtilizedCIDRCount' => <integer>,
            ],
        ],
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|FAILED|ERROR|SCALING|READY',
                    'StatusMessage' => '<string>',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

LimitExceededException:

Unable to perform the operation because doing so would violate a limit setting.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InsufficientCapacityException:

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

CreateFirewallPolicy

$result = $client->createFirewallPolicy([/* ... */]);
$promise = $client->createFirewallPolicyAsync([/* ... */]);

Creates the firewall policy for the firewall according to the specifications.

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

Parameter Syntax

$result = $client->createFirewallPolicy([
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallPolicy' => [ // REQUIRED
        'PolicyVariables' => [
            'RuleVariables' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'FlowTimeouts' => [
                'TcpIdleTimeoutSeconds' => <integer>,
            ],
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
            'StreamExceptionPolicy' => 'DROP|CONTINUE|REJECT',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [ // REQUIRED
                    'PublishMetricAction' => [
                        'Dimensions' => [ // REQUIRED
                            [
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>, // REQUIRED
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TLSInspectionConfigurationArn' => '<string>',
    ],
    'FirewallPolicyName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING|ERROR',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

Unable to perform the operation because doing so would violate a limit setting.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InsufficientCapacityException:

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

CreateRuleGroup

$result = $client->createRuleGroup([/* ... */]);
$promise = $client->createRuleGroupAsync([/* ... */]);

Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.

You provide your rule group specification in your request using either RuleGroup or Rules.

Parameter Syntax

$result = $client->createRuleGroup([
    'AnalyzeRuleGroup' => true || false,
    'Capacity' => <integer>, // REQUIRED
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'RuleGroup' => [
        'ReferenceSets' => [
            'IPSetReferences' => [
                '<IPSetReferenceName>' => [
                    'ReferenceArn' => '<string>',
                ],
                // ...
            ],
        ],
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [ // REQUIRED
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED
                'TargetTypes' => ['<string>', ...], // REQUIRED
                'Targets' => ['<string>', ...], // REQUIRED
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT|REJECT', // REQUIRED
                    'Header' => [ // REQUIRED
                        'Destination' => '<string>', // REQUIRED
                        'DestinationPort' => '<string>', // REQUIRED
                        'Direction' => 'FORWARD|ANY', // REQUIRED
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED
                        'Source' => '<string>', // REQUIRED
                        'SourcePort' => '<string>', // REQUIRED
                    ],
                    'RuleOptions' => [ // REQUIRED
                        [
                            'Keyword' => '<string>', // REQUIRED
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [ // REQUIRED
                            'PublishMetricAction' => [
                                'Dimensions' => [ // REQUIRED
                                    [
                                        'Value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'StatelessRules' => [ // REQUIRED
                    [
                        'Priority' => <integer>, // REQUIRED
                        'RuleDefinition' => [ // REQUIRED
                            'Actions' => ['<string>', ...], // REQUIRED
                            'MatchAttributes' => [ // REQUIRED
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...], // REQUIRED
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupName' => '<string>', // REQUIRED
    'Rules' => '<string>',
    'SourceMetadata' => [
        'SourceArn' => '<string>',
        'SourceUpdateToken' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'STATELESS|STATEFUL', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'AnalysisResults' => [
            [
                'AnalysisDetail' => '<string>',
                'IdentifiedRuleIds' => ['<string>', ...],
                'IdentifiedType' => 'STATELESS_RULE_FORWARDING_ASYMMETRICALLY|STATELESS_RULE_CONTAINS_TCP_FLAGS',
            ],
            // ...
        ],
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING|ERROR',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

Unable to perform the operation because doing so would violate a limit setting.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InsufficientCapacityException:

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

CreateTLSInspectionConfiguration

$result = $client->createTLSInspectionConfiguration([/* ... */]);
$promise = $client->createTLSInspectionConfigurationAsync([/* ... */]);

Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall.

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

For more information about TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

Parameter Syntax

$result = $client->createTLSInspectionConfiguration([
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'TLSInspectionConfiguration' => [ // REQUIRED
        'ServerCertificateConfigurations' => [
            [
                'CertificateAuthorityArn' => '<string>',
                'CheckCertificateRevocationStatus' => [
                    'RevokedStatusAction' => 'PASS|DROP|REJECT',
                    'UnknownStatusAction' => 'PASS|DROP|REJECT',
                ],
                'Scopes' => [
                    [
                        'DestinationPorts' => [
                            [
                                'FromPort' => <integer>, // REQUIRED
                                'ToPort' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                        'Destinations' => [
                            [
                                'AddressDefinition' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Protocols' => [<integer>, ...],
                        'SourcePorts' => [
                            [
                                'FromPort' => <integer>, // REQUIRED
                                'ToPort' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                        'Sources' => [
                            [
                                'AddressDefinition' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'ServerCertificates' => [
                    [
                        'ResourceArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'TLSInspectionConfigurationName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'TLSInspectionConfigurationResponse' => [
        'CertificateAuthority' => [
            'CertificateArn' => '<string>',
            'CertificateSerial' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        'Certificates' => [
            [
                'CertificateArn' => '<string>',
                'CertificateSerial' => '<string>',
                'Status' => '<string>',
                'StatusMessage' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'TLSInspectionConfigurationArn' => '<string>',
        'TLSInspectionConfigurationId' => '<string>',
        'TLSInspectionConfigurationName' => '<string>',
        'TLSInspectionConfigurationStatus' => 'ACTIVE|DELETING|ERROR',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

LimitExceededException:

Unable to perform the operation because doing so would violate a limit setting.

InsufficientCapacityException:

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

DeleteFirewall

$result = $client->deleteFirewall([/* ... */]);
$promise = $client->deleteFirewallAsync([/* ... */]);

Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE. You can't revert this operation.

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.

Parameter Syntax

$result = $client->deleteFirewall([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'CapacityUsageSummary' => [
            'CIDRs' => [
                'AvailableCIDRCount' => <integer>,
                'IPSetReferences' => [
                    '<IPSetArn>' => [
                        'ResolvedCIDRCount' => <integer>,
                    ],
                    // ...
                ],
                'UtilizedCIDRCount' => <integer>,
            ],
        ],
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|FAILED|ERROR|SCALING|READY',
                    'StatusMessage' => '<string>',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

UnsupportedOperationException:

The operation you requested isn't supported by Network Firewall.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

DeleteFirewallPolicy

$result = $client->deleteFirewallPolicy([/* ... */]);
$promise = $client->deleteFirewallPolicyAsync([/* ... */]);

Deletes the specified FirewallPolicy.

Parameter Syntax

$result = $client->deleteFirewallPolicy([
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING|ERROR',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

UnsupportedOperationException:

The operation you requested isn't supported by Network Firewall.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes a resource policy that you created in a PutResourcePolicy request.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidResourcePolicyException:

The policy statement failed validation.

DeleteRuleGroup

$result = $client->deleteRuleGroup([/* ... */]);
$promise = $client->deleteRuleGroupAsync([/* ... */]);

Deletes the specified RuleGroup.

Parameter Syntax

$result = $client->deleteRuleGroup([
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'AnalysisResults' => [
            [
                'AnalysisDetail' => '<string>',
                'IdentifiedRuleIds' => ['<string>', ...],
                'IdentifiedType' => 'STATELESS_RULE_FORWARDING_ASYMMETRICALLY|STATELESS_RULE_CONTAINS_TCP_FLAGS',
            ],
            // ...
        ],
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING|ERROR',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

UnsupportedOperationException:

The operation you requested isn't supported by Network Firewall.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

DeleteTLSInspectionConfiguration

$result = $client->deleteTLSInspectionConfiguration([/* ... */]);
$promise = $client->deleteTLSInspectionConfigurationAsync([/* ... */]);

Deletes the specified TLSInspectionConfiguration.

Parameter Syntax

$result = $client->deleteTLSInspectionConfiguration([
    'TLSInspectionConfigurationArn' => '<string>',
    'TLSInspectionConfigurationName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'TLSInspectionConfigurationResponse' => [
        'CertificateAuthority' => [
            'CertificateArn' => '<string>',
            'CertificateSerial' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        'Certificates' => [
            [
                'CertificateArn' => '<string>',
                'CertificateSerial' => '<string>',
                'Status' => '<string>',
                'StatusMessage' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'TLSInspectionConfigurationArn' => '<string>',
        'TLSInspectionConfigurationId' => '<string>',
        'TLSInspectionConfigurationName' => '<string>',
        'TLSInspectionConfigurationStatus' => 'ACTIVE|DELETING|ERROR',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

DescribeFirewall

$result = $client->describeFirewall([/* ... */]);
$promise = $client->describeFirewallAsync([/* ... */]);

Returns the data objects for the specified firewall.

Parameter Syntax

$result = $client->describeFirewall([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Firewall' => [
        'DeleteProtection' => true || false,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallArn' => '<string>',
        'FirewallId' => '<string>',
        'FirewallName' => '<string>',
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyChangeProtection' => true || false,
        'SubnetChangeProtection' => true || false,
        'SubnetMappings' => [
            [
                'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
                'SubnetId' => '<string>',
            ],
            // ...
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcId' => '<string>',
    ],
    'FirewallStatus' => [
        'CapacityUsageSummary' => [
            'CIDRs' => [
                'AvailableCIDRCount' => <integer>,
                'IPSetReferences' => [
                    '<IPSetArn>' => [
                        'ResolvedCIDRCount' => <integer>,
                    ],
                    // ...
                ],
                'UtilizedCIDRCount' => <integer>,
            ],
        ],
        'ConfigurationSyncStateSummary' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
        'Status' => 'PROVISIONING|DELETING|READY',
        'SyncStates' => [
            '<AvailabilityZone>' => [
                'Attachment' => [
                    'EndpointId' => '<string>',
                    'Status' => 'CREATING|DELETING|FAILED|ERROR|SCALING|READY',
                    'StatusMessage' => '<string>',
                    'SubnetId' => '<string>',
                ],
                'Config' => [
                    '<ResourceName>' => [
                        'SyncStatus' => 'PENDING|IN_SYNC|CAPACITY_CONSTRAINED',
                        'UpdateToken' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

DescribeFirewallPolicy

$result = $client->describeFirewallPolicy([/* ... */]);
$promise = $client->describeFirewallPolicyAsync([/* ... */]);

Returns the data objects for the specified firewall policy.

Parameter Syntax

$result = $client->describeFirewallPolicy([
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicy' => [
        'PolicyVariables' => [
            'RuleVariables' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'FlowTimeouts' => [
                'TcpIdleTimeoutSeconds' => <integer>,
            ],
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
            'StreamExceptionPolicy' => 'DROP|CONTINUE|REJECT',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [
                    'PublishMetricAction' => [
                        'Dimensions' => [
                            [
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>',
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...],
        'StatelessFragmentDefaultActions' => ['<string>', ...],
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>,
                'ResourceArn' => '<string>',
            ],
            // ...
        ],
        'TLSInspectionConfigurationArn' => '<string>',
    ],
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING|ERROR',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

DescribeLoggingConfiguration

$result = $client->describeLoggingConfiguration([/* ... */]);
$promise = $client->describeLoggingConfigurationAsync([/* ... */]);

Returns the logging configuration for the specified firewall.

Parameter Syntax

$result = $client->describeLoggingConfiguration([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [
            [
                'LogDestination' => ['<string>', ...],
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose',
                'LogType' => 'ALERT|FLOW|TLS',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

Retrieves a resource policy that you created in a PutResourcePolicy request.

Parameter Syntax

$result = $client->describeResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

DescribeRuleGroup

$result = $client->describeRuleGroup([/* ... */]);
$promise = $client->describeRuleGroupAsync([/* ... */]);

Returns the data objects for the specified rule group.

Parameter Syntax

$result = $client->describeRuleGroup([
    'AnalyzeRuleGroup' => true || false,
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'RuleGroup' => [
        'ReferenceSets' => [
            'IPSetReferences' => [
                '<IPSetReferenceName>' => [
                    'ReferenceArn' => '<string>',
                ],
                // ...
            ],
        ],
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST',
                'TargetTypes' => ['<string>', ...],
                'Targets' => ['<string>', ...],
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT|REJECT',
                    'Header' => [
                        'Destination' => '<string>',
                        'DestinationPort' => '<string>',
                        'Direction' => 'FORWARD|ANY',
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP',
                        'Source' => '<string>',
                        'SourcePort' => '<string>',
                    ],
                    'RuleOptions' => [
                        [
                            'Keyword' => '<string>',
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [
                            'PublishMetricAction' => [
                                'Dimensions' => [
                                    [
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>',
                    ],
                    // ...
                ],
                'StatelessRules' => [
                    [
                        'Priority' => <integer>,
                        'RuleDefinition' => [
                            'Actions' => ['<string>', ...],
                            'MatchAttributes' => [
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>,
                                        'ToPort' => <integer>,
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>',
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>,
                                        'ToPort' => <integer>,
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>',
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...],
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupResponse' => [
        'AnalysisResults' => [
            [
                'AnalysisDetail' => '<string>',
                'IdentifiedRuleIds' => ['<string>', ...],
                'IdentifiedType' => 'STATELESS_RULE_FORWARDING_ASYMMETRICALLY|STATELESS_RULE_CONTAINS_TCP_FLAGS',
            ],
            // ...
        ],
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING|ERROR',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

DescribeRuleGroupMetadata

$result = $client->describeRuleGroupMetadata([/* ... */]);
$promise = $client->describeRuleGroupMetadataAsync([/* ... */]);

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

Parameter Syntax

$result = $client->describeRuleGroupMetadata([
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'Capacity' => <integer>,
    'Description' => '<string>',
    'LastModifiedTime' => <DateTime>,
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'StatefulRuleOptions' => [
        'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
    ],
    'Type' => 'STATELESS|STATEFUL',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

DescribeTLSInspectionConfiguration

$result = $client->describeTLSInspectionConfiguration([/* ... */]);
$promise = $client->describeTLSInspectionConfigurationAsync([/* ... */]);

Returns the data objects for the specified TLS inspection configuration.

Parameter Syntax

$result = $client->describeTLSInspectionConfiguration([
    'TLSInspectionConfigurationArn' => '<string>',
    'TLSInspectionConfigurationName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'TLSInspectionConfiguration' => [
        'ServerCertificateConfigurations' => [
            [
                'CertificateAuthorityArn' => '<string>',
                'CheckCertificateRevocationStatus' => [
                    'RevokedStatusAction' => 'PASS|DROP|REJECT',
                    'UnknownStatusAction' => 'PASS|DROP|REJECT',
                ],
                'Scopes' => [
                    [
                        'DestinationPorts' => [
                            [
                                'FromPort' => <integer>,
                                'ToPort' => <integer>,
                            ],
                            // ...
                        ],
                        'Destinations' => [
                            [
                                'AddressDefinition' => '<string>',
                            ],
                            // ...
                        ],
                        'Protocols' => [<integer>, ...],
                        'SourcePorts' => [
                            [
                                'FromPort' => <integer>,
                                'ToPort' => <integer>,
                            ],
                            // ...
                        ],
                        'Sources' => [
                            [
                                'AddressDefinition' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'ServerCertificates' => [
                    [
                        'ResourceArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'TLSInspectionConfigurationResponse' => [
        'CertificateAuthority' => [
            'CertificateArn' => '<string>',
            'CertificateSerial' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        'Certificates' => [
            [
                'CertificateArn' => '<string>',
                'CertificateSerial' => '<string>',
                'Status' => '<string>',
                'StatusMessage' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'TLSInspectionConfigurationArn' => '<string>',
        'TLSInspectionConfigurationId' => '<string>',
        'TLSInspectionConfigurationName' => '<string>',
        'TLSInspectionConfigurationStatus' => 'ACTIVE|DELETING|ERROR',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

DisassociateSubnets

$result = $client->disassociateSubnets([/* ... */]);
$promise = $client->disassociateSubnetsAsync([/* ... */]);

Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.

Parameter Syntax

$result = $client->disassociateSubnets([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetIds' => ['<string>', ...], // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetMappings' => [
        [
            'IPAddressType' => 'DUALSTACK|IPV4|IPV6',
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

InvalidOperationException:

The operation failed because it's not valid. For example, you might have tried to delete a rule group or firewall policy that's in use.

ListFirewallPolicies

$result = $client->listFirewallPolicies([/* ... */]);
$promise = $client->listFirewallPoliciesAsync([/* ... */]);

Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.

Parameter Syntax

$result = $client->listFirewallPolicies([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallPolicies' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ListFirewalls

$result = $client->listFirewalls([/* ... */]);
$promise = $client->listFirewallsAsync([/* ... */]);

Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.

Depending on your setting for max results and the number of firewalls, a single call might not return the full list.

Parameter Syntax

$result = $client->listFirewalls([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'VpcIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Firewalls' => [
        [
            'FirewallArn' => '<string>',
            'FirewallName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ThrottlingException:

Unable to process the request due to throttling limitations.

ListRuleGroups

$result = $client->listRuleGroups([/* ... */]);
$promise = $client->listRuleGroupsAsync([/* ... */]);

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

Parameter Syntax

$result = $client->listRuleGroups([
    'ManagedType' => 'AWS_MANAGED_THREAT_SIGNATURES|AWS_MANAGED_DOMAIN_LISTS',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Scope' => 'MANAGED|ACCOUNT',
    'Type' => 'STATELESS|STATEFUL',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RuleGroups' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ListTLSInspectionConfigurations

$result = $client->listTLSInspectionConfigurations([/* ... */]);
$promise = $client->listTLSInspectionConfigurationsAsync([/* ... */]);

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

Parameter Syntax

$result = $client->listTLSInspectionConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TLSInspectionConfigurations' => [
        [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ThrottlingException:

Unable to process the request due to throttling limitations.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.

Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.

• GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.

• AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

Parameter Syntax

$result = $client->putResourcePolicy([
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidResourcePolicyException:

The policy statement failed validation.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

UpdateFirewallDeleteProtection

$result = $client->updateFirewallDeleteProtection([/* ... */]);
$promise = $client->updateFirewallDeleteProtectionAsync([/* ... */]);

Modifies the flag, DeleteProtection, which indicates whether it is possible to delete the firewall. If the flag is set to TRUE, the firewall is protected against deletion. This setting helps protect against accidentally deleting a firewall that's in use.

Parameter Syntax

$result = $client->updateFirewallDeleteProtection([
    'DeleteProtection' => true || false, // REQUIRED
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DeleteProtection' => true || false,
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

ResourceOwnerCheckException:

Unable to change the resource because your account doesn't own it.

UpdateFirewallDescription

$result = $client->updateFirewallDescription([/* ... */]);
$promise = $client->updateFirewallDescriptionAsync([/* ... */]);

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

Parameter Syntax

$result = $client->updateFirewallDescription([
    'Description' => '<string>',
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

UpdateFirewallEncryptionConfiguration

$result = $client->updateFirewallEncryptionConfiguration([/* ... */]);
$promise = $client->updateFirewallEncryptionConfigurationAsync([/* ... */]);

A complex type that contains settings for encryption of your firewall resources.

Parameter Syntax

$result = $client->updateFirewallEncryptionConfiguration([
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
    ],
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

ResourceOwnerCheckException:

Unable to change the resource because your account doesn't own it.

UpdateFirewallPolicy

$result = $client->updateFirewallPolicy([/* ... */]);
$promise = $client->updateFirewallPolicyAsync([/* ... */]);

Updates the properties of the specified firewall policy.

Parameter Syntax

$result = $client->updateFirewallPolicy([
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'FirewallPolicy' => [ // REQUIRED
        'PolicyVariables' => [
            'RuleVariables' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        'StatefulDefaultActions' => ['<string>', ...],
        'StatefulEngineOptions' => [
            'FlowTimeouts' => [
                'TcpIdleTimeoutSeconds' => <integer>,
            ],
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
            'StreamExceptionPolicy' => 'DROP|CONTINUE|REJECT',
        ],
        'StatefulRuleGroupReferences' => [
            [
                'Override' => [
                    'Action' => 'DROP_TO_ALERT',
                ],
                'Priority' => <integer>,
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessCustomActions' => [
            [
                'ActionDefinition' => [ // REQUIRED
                    'PublishMetricAction' => [
                        'Dimensions' => [ // REQUIRED
                            [
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                ],
                'ActionName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'StatelessDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessFragmentDefaultActions' => ['<string>', ...], // REQUIRED
        'StatelessRuleGroupReferences' => [
            [
                'Priority' => <integer>, // REQUIRED
                'ResourceArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TLSInspectionConfigurationArn' => '<string>',
    ],
    'FirewallPolicyArn' => '<string>',
    'FirewallPolicyName' => '<string>',
    'UpdateToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FirewallPolicyResponse' => [
        'ConsumedStatefulRuleCapacity' => <integer>,
        'ConsumedStatelessRuleCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'FirewallPolicyArn' => '<string>',
        'FirewallPolicyId' => '<string>',
        'FirewallPolicyName' => '<string>',
        'FirewallPolicyStatus' => 'ACTIVE|DELETING|ERROR',
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

UpdateFirewallPolicyChangeProtection

$result = $client->updateFirewallPolicyChangeProtection([/* ... */]);
$promise = $client->updateFirewallPolicyChangeProtectionAsync([/* ... */]);

Modifies the flag, ChangeProtection, which indicates whether it is possible to change the firewall. If the flag is set to TRUE, the firewall is protected from changes. This setting helps protect against accidentally changing a firewall that's in use.

Parameter Syntax

$result = $client->updateFirewallPolicyChangeProtection([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyChangeProtection' => true || false, // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'FirewallPolicyChangeProtection' => true || false,
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

ResourceOwnerCheckException:

Unable to change the resource because your account doesn't own it.

UpdateLoggingConfiguration

$result = $client->updateLoggingConfiguration([/* ... */]);
$promise = $client->updateLoggingConfigurationAsync([/* ... */]);

Sets the logging configuration for the specified firewall.

To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.

You can perform only one of the following actions in any call to UpdateLoggingConfiguration:

• Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs.

• Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs.

• Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig. To change these settings, delete the existing LogDestinationConfig object and create a new one, using two separate calls to this update operation.

Parameter Syntax

$result = $client->updateLoggingConfiguration([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [ // REQUIRED
            [
                'LogDestination' => ['<string>', ...], // REQUIRED
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose', // REQUIRED
                'LogType' => 'ALERT|FLOW|TLS', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'LoggingConfiguration' => [
        'LogDestinationConfigs' => [
            [
                'LogDestination' => ['<string>', ...],
                'LogDestinationType' => 'S3|CloudWatchLogs|KinesisDataFirehose',
                'LogType' => 'ALERT|FLOW|TLS',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

LogDestinationPermissionException:

Unable to send logs to a configured logging destination.

UpdateRuleGroup

$result = $client->updateRuleGroup([/* ... */]);
$promise = $client->updateRuleGroupAsync([/* ... */]);

Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.

To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.

Parameter Syntax

$result = $client->updateRuleGroup([
    'AnalyzeRuleGroup' => true || false,
    'Description' => '<string>',
    'DryRun' => true || false,
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'RuleGroup' => [
        'ReferenceSets' => [
            'IPSetReferences' => [
                '<IPSetReferenceName>' => [
                    'ReferenceArn' => '<string>',
                ],
                // ...
            ],
        ],
        'RuleVariables' => [
            'IPSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'PortSets' => [
                '<RuleVariableName>' => [
                    'Definition' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'RulesSource' => [ // REQUIRED
            'RulesSourceList' => [
                'GeneratedRulesType' => 'ALLOWLIST|DENYLIST', // REQUIRED
                'TargetTypes' => ['<string>', ...], // REQUIRED
                'Targets' => ['<string>', ...], // REQUIRED
            ],
            'RulesString' => '<string>',
            'StatefulRules' => [
                [
                    'Action' => 'PASS|DROP|ALERT|REJECT', // REQUIRED
                    'Header' => [ // REQUIRED
                        'Destination' => '<string>', // REQUIRED
                        'DestinationPort' => '<string>', // REQUIRED
                        'Direction' => 'FORWARD|ANY', // REQUIRED
                        'Protocol' => 'IP|TCP|UDP|ICMP|HTTP|FTP|TLS|SMB|DNS|DCERPC|SSH|SMTP|IMAP|MSN|KRB5|IKEV2|TFTP|NTP|DHCP', // REQUIRED
                        'Source' => '<string>', // REQUIRED
                        'SourcePort' => '<string>', // REQUIRED
                    ],
                    'RuleOptions' => [ // REQUIRED
                        [
                            'Keyword' => '<string>', // REQUIRED
                            'Settings' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'StatelessRulesAndCustomActions' => [
                'CustomActions' => [
                    [
                        'ActionDefinition' => [ // REQUIRED
                            'PublishMetricAction' => [
                                'Dimensions' => [ // REQUIRED
                                    [
                                        'Value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        'ActionName' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'StatelessRules' => [ // REQUIRED
                    [
                        'Priority' => <integer>, // REQUIRED
                        'RuleDefinition' => [ // REQUIRED
                            'Actions' => ['<string>', ...], // REQUIRED
                            'MatchAttributes' => [ // REQUIRED
                                'DestinationPorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Destinations' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Protocols' => [<integer>, ...],
                                'SourcePorts' => [
                                    [
                                        'FromPort' => <integer>, // REQUIRED
                                        'ToPort' => <integer>, // REQUIRED
                                    ],
                                    // ...
                                ],
                                'Sources' => [
                                    [
                                        'AddressDefinition' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'TCPFlags' => [
                                    [
                                        'Flags' => ['<string>', ...], // REQUIRED
                                        'Masks' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'StatefulRuleOptions' => [
            'RuleOrder' => 'DEFAULT_ACTION_ORDER|STRICT_ORDER',
        ],
    ],
    'RuleGroupArn' => '<string>',
    'RuleGroupName' => '<string>',
    'Rules' => '<string>',
    'SourceMetadata' => [
        'SourceArn' => '<string>',
        'SourceUpdateToken' => '<string>',
    ],
    'Type' => 'STATELESS|STATEFUL',
    'UpdateToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RuleGroupResponse' => [
        'AnalysisResults' => [
            [
                'AnalysisDetail' => '<string>',
                'IdentifiedRuleIds' => ['<string>', ...],
                'IdentifiedType' => 'STATELESS_RULE_FORWARDING_ASYMMETRICALLY|STATELESS_RULE_CONTAINS_TCP_FLAGS',
            ],
            // ...
        ],
        'Capacity' => <integer>,
        'ConsumedCapacity' => <integer>,
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'RuleGroupArn' => '<string>',
        'RuleGroupId' => '<string>',
        'RuleGroupName' => '<string>',
        'RuleGroupStatus' => 'ACTIVE|DELETING|ERROR',
        'SnsTopic' => '<string>',
        'SourceMetadata' => [
            'SourceArn' => '<string>',
            'SourceUpdateToken' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => 'STATELESS|STATEFUL',
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

UpdateSubnetChangeProtection

$result = $client->updateSubnetChangeProtection([/* ... */]);
$promise = $client->updateSubnetChangeProtectionAsync([/* ... */]);

Parameter Syntax

$result = $client->updateSubnetChangeProtection([
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetChangeProtection' => true || false, // REQUIRED
    'UpdateToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'FirewallArn' => '<string>',
    'FirewallName' => '<string>',
    'SubnetChangeProtection' => true || false,
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.

ResourceOwnerCheckException:

Unable to change the resource because your account doesn't own it.

UpdateTLSInspectionConfiguration

$result = $client->updateTLSInspectionConfiguration([/* ... */]);
$promise = $client->updateTLSInspectionConfigurationAsync([/* ... */]);

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

Parameter Syntax

$result = $client->updateTLSInspectionConfiguration([
    'Description' => '<string>',
    'EncryptionConfiguration' => [
        'KeyId' => '<string>',
        'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY', // REQUIRED
    ],
    'TLSInspectionConfiguration' => [ // REQUIRED
        'ServerCertificateConfigurations' => [
            [
                'CertificateAuthorityArn' => '<string>',
                'CheckCertificateRevocationStatus' => [
                    'RevokedStatusAction' => 'PASS|DROP|REJECT',
                    'UnknownStatusAction' => 'PASS|DROP|REJECT',
                ],
                'Scopes' => [
                    [
                        'DestinationPorts' => [
                            [
                                'FromPort' => <integer>, // REQUIRED
                                'ToPort' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                        'Destinations' => [
                            [
                                'AddressDefinition' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Protocols' => [<integer>, ...],
                        'SourcePorts' => [
                            [
                                'FromPort' => <integer>, // REQUIRED
                                'ToPort' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                        'Sources' => [
                            [
                                'AddressDefinition' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'ServerCertificates' => [
                    [
                        'ResourceArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'TLSInspectionConfigurationArn' => '<string>',
    'TLSInspectionConfigurationName' => '<string>',
    'UpdateToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TLSInspectionConfigurationResponse' => [
        'CertificateAuthority' => [
            'CertificateArn' => '<string>',
            'CertificateSerial' => '<string>',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        'Certificates' => [
            [
                'CertificateArn' => '<string>',
                'CertificateSerial' => '<string>',
                'Status' => '<string>',
                'StatusMessage' => '<string>',
            ],
            // ...
        ],
        'Description' => '<string>',
        'EncryptionConfiguration' => [
            'KeyId' => '<string>',
            'Type' => 'CUSTOMER_KMS|AWS_OWNED_KMS_KEY',
        ],
        'LastModifiedTime' => <DateTime>,
        'NumberOfAssociations' => <integer>,
        'TLSInspectionConfigurationArn' => '<string>',
        'TLSInspectionConfigurationId' => '<string>',
        'TLSInspectionConfigurationName' => '<string>',
        'TLSInspectionConfigurationStatus' => 'ACTIVE|DELETING|ERROR',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'UpdateToken' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The operation failed because of a problem with your request. Examples include:

• You specified an unsupported parameter name or value.

• You tried to update a property with a value that isn't among the available types.

• Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException:

Unable to locate a resource using the parameters that you provided.

ThrottlingException:

Unable to process the request due to throttling limitations.

InternalServerError:

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidTokenException:

The token you provided is stale or isn't valid for the operation.