2025/05/28 - AWS Network Firewall - 5 new8 updated api methods
Changes You can now use VPC endpoint associations to create multiple firewall endpoints for a single firewall.
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
See also: AWS API Documentation
Request Syntax
client.describe_firewall_metadata(
FirewallArn='string'
)
string
The Amazon Resource Name (ARN) of the firewall.
dict
Response Syntax
{
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'Description': 'string',
'Status': 'PROVISIONING'|'DELETING'|'READY',
'SupportedAvailabilityZones': {
'string': {
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
}
}
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
Description (string) --
A description of the firewall.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
SupportedAvailabilityZones (dict) --
The Availability Zones that the firewall currently supports. This includes all Availability Zones for which the firewall has a subnet defined.
(string) --
(dict) --
High-level information about an Availability Zone where the firewall has an endpoint defined.
IPAddressType (string) --
The IP address type of the Firewall subnet in the Availability Zone. You can't change the IP address type after you create the subnet.
Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall.
Depending on your setting for max results and the number of associations, a single call might not return the full list.
See also: AWS API Documentation
Request Syntax
client.list_vpc_endpoint_associations(
NextToken='string',
MaxResults=123,
FirewallArn='string'
)
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
string
The Amazon Resource Name (ARN) of the firewall.
If you don't specify this, Network Firewall retrieves all VPC endpoint associations that you have defined.
dict
Response Syntax
{
'NextToken': 'string',
'VpcEndpointAssociations': [
{
'VpcEndpointAssociationArn': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
VpcEndpointAssociations (list) --
The VPC endpoint assocation metadata objects for the firewall that you specified. If you didn't specify a firewall, this is all VPC endpoint associations that you have defined.
Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.
(dict) --
High-level information about a VPC endpoint association, returned by ListVpcEndpointAssociations. You can use the information provided in the metadata to retrieve and manage a VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
Returns the data object for the specified VPC endpoint association.
See also: AWS API Documentation
Request Syntax
client.describe_vpc_endpoint_association(
VpcEndpointAssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of a VPC endpoint association.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.
This data type is used for any firewall endpoint type:
For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.
For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Creates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.
See also: AWS API Documentation
Request Syntax
client.create_vpc_endpoint_association(
FirewallArn='string',
VpcId='string',
SubnetMapping={
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
[REQUIRED]
The unique identifier of the VPC where you want to create a firewall endpoint.
dict
[REQUIRED]
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) -- [REQUIRED]
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
string
A description of the VPC endpoint association.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.
This data type is used for any firewall endpoint type:
For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.
For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Deletes the specified VpcEndpointAssociation.
You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewall endpoint, you can remove the endpoint association safely.
See also: AWS API Documentation
Request Syntax
client.delete_vpc_endpoint_association(
VpcEndpointAssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of a VPC endpoint association.
dict
Response Syntax
{
'VpcEndpointAssociation': {
'VpcEndpointAssociationId': 'string',
'VpcEndpointAssociationArn': 'string',
'FirewallArn': 'string',
'VpcId': 'string',
'SubnetMapping': {
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
'Description': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'VpcEndpointAssociationStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'AssociationSyncState': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
}
}
}
}
}
Response Structure
(dict) --
VpcEndpointAssociation (dict) --
The configuration settings for the VPC endpoint association. These settings include the firewall and the VPC and subnet to use for the firewall endpoint.
VpcEndpointAssociationId (string) --
The unique identifier of the VPC endpoint association.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
VpcId (string) --
The unique identifier of the VPC for the endpoint association.
SubnetMapping (dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
Description (string) --
A description of the VPC endpoint association.
Tags (list) --
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
VpcEndpointAssociationStatus (dict) --
Detailed information about the current status of a VpcEndpointAssociation. You can retrieve this by calling DescribeVpcEndpointAssociation and providing the VPC endpoint association ARN.
Status (string) --
The readiness of the configured firewall endpoint to handle network traffic.
AssociationSyncState (dict) --
The list of the Availability Zone sync states for all subnets that are defined by the firewall.
(string) --
(dict) --
The status of the firewall endpoint defined by a VpcEndpointAssociation.
Attachment (dict) --
The definition and status of the firewall endpoint for a single subnet. In each configured subnet, Network Firewall instantiates a firewall endpoint to handle network traffic.
This data type is used for any firewall endpoint type:
For Firewall.SubnetMappings, this Attachment is part of the FirewallStatus sync states information. You define firewall subnets using CreateFirewall and AssociateSubnets.
For VpcEndpointAssociation, this Attachment is part of the VpcEndpointAssociationStatus sync states information. You define these subnets using CreateVpcEndpointAssociation.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
{'Firewall': {'NumberOfAssociations': 'integer'}}
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.
To generate a report on the last 30 days of traffic monitored by a firewall, use StartAnalysisReport.
See also: AWS API Documentation
Request Syntax
client.create_firewall(
FirewallName='string',
FirewallPolicyArn='string',
VpcId='string',
SubnetMappings=[
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
DeleteProtection=True|False,
SubnetChangeProtection=True|False,
FirewallPolicyChangeProtection=True|False,
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
EncryptionConfiguration={
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
EnabledAnalysisTypes=[
'TLS_SNI'|'HTTP_HOST',
]
)
string
[REQUIRED]
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
string
The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
list
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) -- [REQUIRED]
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
boolean
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
boolean
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
boolean
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
string
A description of the firewall.
list
The key:value pairs to associate with the resource.
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
A complex type that contains settings for encryption of your firewall resources.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) -- [REQUIRED]
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
list
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
dict
Response Syntax
{
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
]
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'UpdateToken': 'string'
}
}
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
}
}
}
Response Structure
(dict) --
Firewall (dict) --
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
FirewallStatus (dict) --
Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
{'Firewall': {'NumberOfAssociations': 'integer'}}
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.
See also: AWS API Documentation
Request Syntax
client.delete_firewall(
FirewallName='string',
FirewallArn='string'
)
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
]
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'UpdateToken': 'string'
}
}
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
}
}
}
Response Structure
(dict) --
Firewall (dict) --
A firewall defines the behavior of a firewall, the main VPC where the firewall is used, the Availability Zones where the firewall can be used, and one subnet to use for a firewall endpoint within each of the Availability Zones. The Availability Zones are defined implicitly in the subnet specifications.
In addition to the firewall endpoints that you define in this Firewall specification, you can create firewall endpoints in VpcEndpointAssociation resources for any VPC, in any Availability Zone where the firewall is already in use.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both the firewall and firewall status by calling DescribeFirewall.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
FirewallStatus (dict) --
Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
{'Firewall': {'NumberOfAssociations': 'integer'}}
Returns the data objects for the specified firewall.
See also: AWS API Documentation
Request Syntax
client.describe_firewall(
FirewallName='string',
FirewallArn='string'
)
string
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
string
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
dict
Response Syntax
{
'UpdateToken': 'string',
'Firewall': {
'FirewallName': 'string',
'FirewallArn': 'string',
'FirewallPolicyArn': 'string',
'VpcId': 'string',
'SubnetMappings': [
{
'SubnetId': 'string',
'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
},
],
'DeleteProtection': True|False,
'SubnetChangeProtection': True|False,
'FirewallPolicyChangeProtection': True|False,
'Description': 'string',
'FirewallId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'EncryptionConfiguration': {
'KeyId': 'string',
'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
},
'NumberOfAssociations': 123,
'EnabledAnalysisTypes': [
'TLS_SNI'|'HTTP_HOST',
]
},
'FirewallStatus': {
'Status': 'PROVISIONING'|'DELETING'|'READY',
'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'SyncStates': {
'string': {
'Attachment': {
'SubnetId': 'string',
'EndpointId': 'string',
'Status': 'CREATING'|'DELETING'|'FAILED'|'ERROR'|'SCALING'|'READY',
'StatusMessage': 'string'
},
'Config': {
'string': {
'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
'UpdateToken': 'string'
}
}
}
},
'CapacityUsageSummary': {
'CIDRs': {
'AvailableCIDRCount': 123,
'UtilizedCIDRCount': 123,
'IPSetReferences': {
'string': {
'ResolvedCIDRCount': 123
}
}
}
}
}
}
Response Structure
(dict) --
UpdateToken (string) --
An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
Firewall (dict) --
The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
FirewallName (string) --
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FirewallPolicyArn (string) --
The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
VpcId (string) --
The unique identifier of the VPC where the firewall is in use.
SubnetMappings (list) --
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
(dict) --
The ID for a subnet that's used in an association with a firewall. This is used in CreateFirewall, AssociateSubnets, and CreateVpcEndpointAssociation. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
SubnetId (string) --
The unique identifier for the subnet.
IPAddressType (string) --
The subnet's IP address type. You can't change the IP address type after you create the subnet.
DeleteProtection (boolean) --
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
SubnetChangeProtection (boolean) --
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection (boolean) --
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
Description (string) --
A description of the firewall.
FirewallId (string) --
The unique identifier for the firewall.
Tags (list) --
(dict) --
A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
EncryptionConfiguration (dict) --
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
KeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) --
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
NumberOfAssociations (integer) --
The number of VpcEndpointAssociation resources that use this firewall.
EnabledAnalysisTypes (list) --
An optional setting indicating the specific traffic analysis types to enable on the firewall.
(string) --
FirewallStatus (dict) --
Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
The firewall status indicates a combined status. It indicates whether all subnets are up-to-date with the latest firewall configurations, which is based on the sync states config values, and also whether all subnets have their endpoints fully enabled, based on their sync states attachment values.
Status (string) --
The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you have it configured. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY.
ConfigurationSyncStateSummary (string) --
The configuration sync state for the firewall. This summarizes the Config settings in the SyncStates for this firewall status object.
When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all Availability Zones that have subnets defined for the firewall. This summary indicates whether the configuration changes have been applied everywhere.
This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness. It's based on this setting and the readiness of the firewall endpoints to take traffic.
SyncStates (dict) --
Status for the subnets that you've configured in the firewall. This contains one array element per Availability Zone where you've configured a subnet in the firewall.
These objects provide detailed information for the settings ConfigurationSyncStateSummary and Status.
(string) --
(dict) --
The status of the firewall endpoint and firewall policy configuration for a single VPC subnet. This is part of the FirewallStatus.
For each VPC subnet that you associate with a firewall, Network Firewall does the following:
Instantiates a firewall endpoint in the subnet, ready to take traffic.
Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.
When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.
Attachment (dict) --
The configuration and status for a single firewall subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic.
SubnetId (string) --
The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
EndpointId (string) --
The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
Status (string) --
The current status of the firewall endpoint instantiation in the subnet.
When this value is READY, the endpoint is available to handle network traffic. Otherwise, this value reflects its state, for example CREATING or DELETING.
StatusMessage (string) --
If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
Config (dict) --
The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic.
(string) --
(dict) --
Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
SyncStatus (string) --
Indicates whether this object is in sync with the version indicated in the update token.
UpdateToken (string) --
The current version of the object that is either in sync or pending synchronization.
CapacityUsageSummary (dict) --
Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calculates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CIDRs (dict) --
Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
AvailableCIDRCount (integer) --
The number of CIDR blocks available for use by the IP set references in a firewall.
UtilizedCIDRCount (integer) --
The number of CIDR blocks used by the IP set references in a firewall.
IPSetReferences (dict) --
The list of the IP set references used by a firewall.
(string) --
(dict) --
General information about the IP set.
ResolvedCIDRCount (integer) --
Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
{'VpcEndpointAssociationArn': 'string', 'VpcEndpointId': 'string'}
Returns key information about a specific flow operation.
See also: AWS API Documentation
Request Syntax
client.describe_flow_operation(
FirewallArn='string',
AvailabilityZone='string',
VpcEndpointAssociationArn='string',
VpcEndpointId='string',
FlowOperationId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
string
The Amazon Resource Name (ARN) of a VPC endpoint association.
string
A unique identifier for the primary endpoint associated with a firewall.
string
[REQUIRED]
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
dict
Response Syntax
{
'FirewallArn': 'string',
'AvailabilityZone': 'string',
'VpcEndpointAssociationArn': 'string',
'VpcEndpointId': 'string',
'FlowOperationId': 'string',
'FlowOperationType': 'FLOW_FLUSH'|'FLOW_CAPTURE',
'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS',
'StatusMessage': 'string',
'FlowRequestTimestamp': datetime(2015, 1, 1),
'FlowOperation': {
'MinimumFlowAgeInSeconds': 123,
'FlowFilters': [
{
'SourceAddress': {
'AddressDefinition': 'string'
},
'DestinationAddress': {
'AddressDefinition': 'string'
},
'SourcePort': 'string',
'DestinationPort': 'string',
'Protocols': [
'string',
]
},
]
}
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
VpcEndpointAssociationArn (string) --
The Amazon Resource Name (ARN) of a VPC endpoint association.
VpcEndpointId (string) --
A unique identifier for the primary endpoint associated with a firewall.
FlowOperationId (string) --
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
FlowOperationType (string) --
Defines the type of FlowOperation.
FlowOperationStatus (string) --
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
StatusMessage (string) --
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.
FlowRequestTimestamp (datetime) --
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
FlowOperation (dict) --
Returns key information about a flow operation, such as related statuses, unique identifiers, and all filters defined in the operation.
MinimumFlowAgeInSeconds (integer) --
The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
FlowFilters (list) --
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
(dict) --
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
SourceAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) --
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
DestinationAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) --
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
SourcePort (string) --
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
DestinationPort (string) --
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
Protocols (list) --
The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
(string) --
{'VpcEndpointAssociationArn': 'string', 'VpcEndpointId': 'string'}
Returns the results of a specific flow operation.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
See also: AWS API Documentation
Request Syntax
client.list_flow_operation_results(
FirewallArn='string',
FlowOperationId='string',
NextToken='string',
MaxResults=123,
AvailabilityZone='string',
VpcEndpointId='string',
VpcEndpointAssociationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
[REQUIRED]
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
string
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
string
A unique identifier for the primary endpoint associated with a firewall.
string
The Amazon Resource Name (ARN) of a VPC endpoint association.
dict
Response Syntax
{
'FirewallArn': 'string',
'AvailabilityZone': 'string',
'VpcEndpointAssociationArn': 'string',
'VpcEndpointId': 'string',
'FlowOperationId': 'string',
'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS',
'StatusMessage': 'string',
'FlowRequestTimestamp': datetime(2015, 1, 1),
'Flows': [
{
'SourceAddress': {
'AddressDefinition': 'string'
},
'DestinationAddress': {
'AddressDefinition': 'string'
},
'SourcePort': 'string',
'DestinationPort': 'string',
'Protocol': 'string',
'Age': 123,
'PacketCount': 123,
'ByteCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
AvailabilityZone (string) --
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
VpcEndpointAssociationArn (string) --
VpcEndpointId (string) --
FlowOperationId (string) --
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
FlowOperationStatus (string) --
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
StatusMessage (string) --
If the asynchronous operation fails, Network Firewall populates this with the reason for the error or failure. Options include Flow operation error and Flow timeout.
FlowRequestTimestamp (datetime) --
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
Flows (list) --
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.
(dict) --
Any number of arrays, where each array is a single flow identified in the scope of the operation. If multiple flows were in the scope of the operation, multiple Flows arrays are returned.
SourceAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) --
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
DestinationAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) --
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
SourcePort (string) --
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
DestinationPort (string) --
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
Protocol (string) --
The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
Age (integer) --
Returned as info about age of the flows identified by the flow operation.
PacketCount (integer) --
Returns the total number of data packets received or transmitted in a flow.
ByteCount (integer) --
Returns the number of bytes received or transmitted in a specific flow.
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
{'VpcEndpointAssociationArn': 'string', 'VpcEndpointId': 'string'}
Returns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations.
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
See also: AWS API Documentation
Request Syntax
client.list_flow_operations(
FirewallArn='string',
AvailabilityZone='string',
VpcEndpointAssociationArn='string',
VpcEndpointId='string',
FlowOperationType='FLOW_FLUSH'|'FLOW_CAPTURE',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
string
The Amazon Resource Name (ARN) of a VPC endpoint association.
string
A unique identifier for the primary endpoint associated with a firewall.
string
An optional string that defines whether any or all operation types are returned.
string
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
integer
The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
dict
Response Syntax
{
'FlowOperations': [
{
'FlowOperationId': 'string',
'FlowOperationType': 'FLOW_FLUSH'|'FLOW_CAPTURE',
'FlowRequestTimestamp': datetime(2015, 1, 1),
'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FlowOperations (list) --
Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
(dict) --
An array of objects with metadata about the requested FlowOperation.
FlowOperationId (string) --
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
FlowOperationType (string) --
Defines the type of FlowOperation.
FlowRequestTimestamp (datetime) --
A timestamp indicating when the Suricata engine identified flows impacted by an operation.
FlowOperationStatus (string) --
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
NextToken (string) --
When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
{'VpcEndpointAssociationArn': 'string', 'VpcEndpointId': 'string'}
Begins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view.
A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.
See also: AWS API Documentation
Request Syntax
client.start_flow_capture(
FirewallArn='string',
AvailabilityZone='string',
VpcEndpointAssociationArn='string',
VpcEndpointId='string',
MinimumFlowAgeInSeconds=123,
FlowFilters=[
{
'SourceAddress': {
'AddressDefinition': 'string'
},
'DestinationAddress': {
'AddressDefinition': 'string'
},
'SourcePort': 'string',
'DestinationPort': 'string',
'Protocols': [
'string',
]
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
string
The Amazon Resource Name (ARN) of a VPC endpoint association.
string
A unique identifier for the primary endpoint associated with a firewall.
integer
The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
list
[REQUIRED]
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
(dict) --
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
SourceAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) -- [REQUIRED]
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
DestinationAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) -- [REQUIRED]
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
SourcePort (string) --
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
DestinationPort (string) --
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
Protocols (list) --
The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
(string) --
dict
Response Syntax
{
'FirewallArn': 'string',
'FlowOperationId': 'string',
'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FlowOperationId (string) --
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
FlowOperationStatus (string) --
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.
{'VpcEndpointAssociationArn': 'string', 'VpcEndpointId': 'string'}
Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.
See also: AWS API Documentation
Request Syntax
client.start_flow_flush(
FirewallArn='string',
AvailabilityZone='string',
VpcEndpointAssociationArn='string',
VpcEndpointId='string',
MinimumFlowAgeInSeconds=123,
FlowFilters=[
{
'SourceAddress': {
'AddressDefinition': 'string'
},
'DestinationAddress': {
'AddressDefinition': 'string'
},
'SourcePort': 'string',
'DestinationPort': 'string',
'Protocols': [
'string',
]
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the firewall.
string
The ID of the Availability Zone where the firewall is located. For example, us-east-2a.
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
string
The Amazon Resource Name (ARN) of a VPC endpoint association.
string
A unique identifier for the primary endpoint associated with a firewall.
integer
The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.
list
[REQUIRED]
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
(dict) --
Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.
SourceAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) -- [REQUIRED]
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
DestinationAddress (dict) --
A single IP address specification. This is used in the MatchAttributes source and destination specifications.
AddressDefinition (string) -- [REQUIRED]
Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
Examples:
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
SourcePort (string) --
The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
DestinationPort (string) --
The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.
Protocols (list) --
The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.
(string) --
dict
Response Syntax
{
'FirewallArn': 'string',
'FlowOperationId': 'string',
'FlowOperationStatus': 'COMPLETED'|'IN_PROGRESS'|'FAILED'|'COMPLETED_WITH_ERRORS'
}
Response Structure
(dict) --
FirewallArn (string) --
The Amazon Resource Name (ARN) of the firewall.
FlowOperationId (string) --
A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.
FlowOperationStatus (string) --
Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.
If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.