List<E> accounts
The list of accounts within the organization that the specified Firewall Manager administrator either can or
cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If
ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can
apply policies to all members of the organization except for the accounts in this list. If
ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can
only apply policies to the accounts in this list.
Boolean allAccountsEnabled
A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If
true, the administrator can apply policies to all accounts within the organization. You can either enable
management of all accounts through this operation, or you can specify a list of accounts to manage in
AccountScope$Accounts. You cannot specify both.
Boolean excludeSpecifiedAccounts
A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope.
If true, the Firewall Manager administrator can apply policies to all members of the organization except for the
accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by
AccountScope$Accounts, or you can enable management of all accounts by
AccountScope$AllAccountsEnabled. You cannot specify both.
String adminAccount
The Amazon Web Services account ID of the Firewall Manager administrator's account.
Boolean defaultAdmin
A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.
String status
The current status of the request to onboard a member account as an Firewall Manager administrator.
ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
administrator, and can perform actions on the resources defined in their AdminScope.
OFFBOARDING - The account is being removed as an Firewall Manager administrator.
OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
AccountScope accountScope
Defines the accounts that the specified Firewall Manager administrator can apply policies to.
OrganizationalUnitScope organizationalUnitScope
Defines the Organizations organizational units that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.
RegionScope regionScope
Defines the Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.
PolicyTypeScope policyTypeScope
Defines the Firewall Manager policy types that the specified Firewall Manager administrator can create and manage.
String appName
The application's name.
String protocol
The IP protocol name or number. The name can be one of tcp, udp, or icmp.
For information on possible numbers, see Protocol Numbers.
Long port
The application's port number, for example 80.
String listId
The ID of the Firewall Manager applications list.
String listName
The name of the Firewall Manager applications list.
String listUpdateToken
A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
Date createTime
The time that the Firewall Manager applications list was created.
Date lastUpdateTime
The time that the Firewall Manager applications list was last updated.
List<E> appsList
An array of applications in the Firewall Manager applications list.
Map<K,V> previousAppsList
A map of previous version numbers to their corresponding App object arrays.
String adminAccount
The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager default administrator account. This account must be a member account of the organization in Organizations whose resources you want to protect. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
String thirdPartyFirewall
The name of the third-party firewall vendor.
String thirdPartyFirewallStatus
The current status for setting a Firewall Manager policy administrator's account as an administrator of the third-party firewall tenant.
ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant
administrator.
ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant
administrator.
OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.
OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant
administrator.
NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.
String violationTarget
The security group rule that is being evaluated.
String violationTargetDescription
A description of the security group that violates the policy.
List<E> partialMatches
List of rules specified in the security group of the Firewall Manager policy that partially match the
ViolationTarget rule.
List<E> possibleSecurityGroupRemediationActions
Remediation options for the rule specified in the ViolationTarget.
String resourceSetIdentifier
A unique identifier for the resource set, used in a request to refer to the resource set.
List<E> items
The uniform resource identifiers (URIs) of resources that should be associated to the resource set. The URIs must be Amazon Resource Names (ARNs).
String resourceSetIdentifier
A unique identifier for the resource set, used in a request to refer to the resource set.
List<E> items
The uniform resource identifiers (URI) of resources that should be disassociated from the resource set. The URIs must be Amazon Resource Names (ARNs).
String resourceId
The resource ID.
String violationReason
The reason that the resource is not protected by the policy.
String resourceType
The resource type. This is in the format shown in the Amazon
Web Services Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer,
AWS::CloudFront::Distribution, or AWS::NetworkFirewall::FirewallPolicy.
Map<K,V> metadata
Metadata about the resource that doesn't comply with the policy scope.
String description
Brief description of this remediation action.
ActionTarget vpc
The VPC that's associated with the remediation action.
Boolean fMSCanRemediate
Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
String description
Brief description of this remediation action.
ActionTarget networkAclId
The network ACL that's associated with the remediation action.
List<E> networkAclEntriesToBeCreated
Lists the entries that the remediation action would create.
Boolean fMSCanRemediate
Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
String listId
The ID of the applications list that you want to delete. You can retrieve this ID from PutAppsList,
ListAppsLists, and GetAppsList.
String description
Brief description of this remediation action.
ActionTarget networkAclId
The network ACL that's associated with the remediation action.
List<E> networkAclEntriesToBeDeleted
Lists the entries that the remediation action would delete.
Boolean fMSCanRemediate
Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
String policyId
The ID of the policy that you want to delete. You can retrieve this ID from PutPolicy and
ListPolicies.
Boolean deleteAllPolicyResources
If True, the request performs cleanup according to the policy type.
For WAF and Shield Advanced policies, the cleanup does the following:
Deletes rule groups created by Firewall Manager
Removes web ACLs from in-scope resources
Deletes web ACLs that contain no rules or rule groups
For security group policies, the cleanup does the following for each security group in the policy:
Disassociates the security group from in-scope resources
Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy
For security group common policies, even if set to False, Firewall Manager deletes all security
groups created by Firewall Manager that aren't associated with any other resources through another policy.
After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.
String listId
The ID of the protocols list that you want to delete. You can retrieve this ID from PutProtocolsList, ListProtocolsLists, and GetProtocolsLost.
String identifier
A unique identifier for the resource set, used in a request to refer to the resource set.
String thirdPartyFirewall
The name of the third-party firewall vendor.
String thirdPartyFirewallStatus
The current status for the disassociation of a Firewall Manager administrators account with a third-party firewall.
String violationTarget
Information about the VPC ID.
String violationTargetDescription
A description of the violation that specifies the rule group and VPC.
Integer numberOfRuleGroupsAlreadyAssociated
The number of rule groups currently associated with the VPC.
String violationTarget
Information about the VPC ID.
String violationTargetDescription
A description of the violation that specifies the VPC and the rule group that's already associated with it.
Integer conflictingPriority
The priority setting of the two conflicting rule groups.
String conflictingPolicyId
The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy contains the rule group that's already associated with the VPC.
List<E> unavailablePriorities
The priorities of rule groups that are already associated with the VPC. To retry your operation, choose priority settings that aren't in this list for the rule groups in your new DNS Firewall policy.
String description
A description of the EC2 route table that is associated with the remediation action.
ActionTarget routeTableId
The ID of the EC2 route table that is associated with the remediation action.
ActionTarget subnetId
The ID of the subnet for the EC2 route table that is associated with the remediation action.
ActionTarget gatewayId
The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.
String description
A description of the copied EC2 route table that is associated with the remediation action.
ActionTarget vpcId
The VPC ID of the copied EC2 route table that is associated with the remediation action.
ActionTarget routeTableId
The ID of the copied EC2 route table that is associated with the remediation action.
String description
A description of CreateRoute action in Amazon EC2.
String destinationCidrBlock
Information about the IPv4 CIDR address block used for the destination match.
String destinationPrefixListId
Information about the ID of a prefix list used for the destination match.
String destinationIpv6CidrBlock
Information about the IPv6 CIDR block destination.
ActionTarget vpcEndpointId
Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
ActionTarget gatewayId
Information about the ID of an internet gateway or virtual private gateway attached to your VPC.
ActionTarget routeTableId
Information about the ID of the route table for the route.
String description
A description of the CreateRouteTable action.
ActionTarget vpcId
Information about the ID of a VPC.
String description
A description of the DeleteRoute action.
String destinationCidrBlock
Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
String destinationPrefixListId
Information about the ID of the prefix list for the route.
String destinationIpv6CidrBlock
Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
ActionTarget routeTableId
Information about the ID of the route table.
String description
A description of the ReplaceRoute action in Amazon EC2.
String destinationCidrBlock
Information about the IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
String destinationPrefixListId
Information about the ID of the prefix list for the route.
String destinationIpv6CidrBlock
Information about the IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
ActionTarget gatewayId
Information about the ID of an internet gateway or virtual private gateway.
ActionTarget routeTableId
Information about the ID of the route table.
String description
A description of the ReplaceRouteTableAssociation action in Amazon EC2.
ActionTarget associationId
Information about the association ID.
ActionTarget routeTableId
Information about the ID of the new route table to associate with the subnet.
NetworkAclEntry entryDetail
Describes a rule in a network ACL.
Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, Amazon Web Services processes the entries in the network ACL according to the rule numbers, in ascending order.
When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.
Integer entryRuleNumber
The rule number for the entry. ACL entries are processed in ascending order by rule number. In a Firewall Manager network ACL policy, Firewall Manager assigns rule numbers.
String entryType
Specifies whether the entry is managed by Firewall Manager or by a user, and, for Firewall Manager-managed entries, specifies whether the entry is among those that run first in the network ACL or those that run last.
EntryDescription expectedEntry
The Firewall Manager-managed network ACL entry that is involved in the entry violation.
String expectedEvaluationOrder
The evaluation location within the ordered list of entries where the ExpectedEntry should be,
according to the network ACL policy specifications.
String actualEvaluationOrder
The evaluation location within the ordered list of entries where the ExpectedEntry is currently
located.
EntryDescription entryAtExpectedEvaluationOrder
The entry that's currently in the ExpectedEvaluationOrder location, in place of the expected entry.
List<E> entriesWithConflicts
The list of entries that are in conflict with ExpectedEntry.
List<E> entryViolationReasons
Descriptions of the violations that Firewall Manager found for these entries.
String complianceStatus
Describes an Amazon Web Services account's compliance with the Firewall Manager policy.
Long violatorCount
The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.
Boolean evaluationLimitExceeded
Indicates that over 100 resources are noncompliant with the Firewall Manager policy.
String ipV4Cidr
Information about the IPv4 CIDR block.
String prefixListId
Information about the ID of the prefix list for the route.
String ipV6Cidr
Information about the IPv6 CIDR block.
List<E> contributingSubnets
Information about the contributing subnets.
List<E> allowedTargets
Information about the allowed targets.
String routeTableId
Information about the route table ID.
String firewallSubnetId
The ID of the firewall subnet that violates the policy scope.
String vpcId
The VPC ID of the firewall subnet that violates the policy scope.
String subnetAvailabilityZone
The Availability Zone of the firewall subnet that violates the policy scope.
String subnetAvailabilityZoneId
The Availability Zone ID of the firewall subnet that violates the policy scope.
String vpcEndpointId
The VPC endpoint ID of the firewall subnet that violates the policy scope.
String firewallSubnetId
The ID of the firewall that this VPC endpoint is associated with.
String vpcId
The resource ID of the VPC associated with the deleted VPC subnet.
String subnetAvailabilityZone
The name of the Availability Zone of the deleted VPC subnet.
String subnetAvailabilityZoneId
The ID of the Availability Zone of the deleted VPC subnet.
String description
Describes the remedial action.
String firewallCreationConfig
A FirewallCreationConfig that you can copy into your current policy's SecurityServiceData in order to remedy scope violations.
String adminAccount
The administrator account that you want to get the details for.
AdminScope adminScope
Contains details about the administrative scope of the requested account.
String status
The current status of the request to onboard a member account as an Firewall Manager administrator.
ONBOARDING - The account is onboarding to Firewall Manager as an administrator.
ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an
administrator, and can perform actions on the resources defined in their AdminScope.
OFFBOARDING - The account is being removed as an Firewall Manager administrator.
OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.
AppsListData appsList
Information about the specified Firewall Manager applications list.
String appsListArn
The Amazon Resource Name (ARN) of the applications list.
PolicyComplianceDetail policyComplianceDetail
Information about the resources and the policy that you specified in the GetComplianceDetail
request.
String policyId
The ID of the Firewall Manager policy that you want the details for.
String policyId
The ID of the policy for which you want to get the attack information.
String memberAccountId
The Amazon Web Services account that is in scope of the policy that you want to get the details for.
Date startTime
The start of the time period to query for the attacks. This is a timestamp type. The request syntax
listing indicates a number type because the default used by Firewall Manager is Unix time in
seconds. However, any valid timestamp format is allowed.
Date endTime
The end of the time period to query for the attacks. This is a timestamp type. The request syntax
listing indicates a number type because the default used by Firewall Manager is Unix time in
seconds. However, any valid timestamp format is allowed.
String nextToken
If you specify a value for MaxResults and you have more objects than the number that you specify for
MaxResults, Firewall Manager returns a NextToken value in the response, which you can
use to retrieve another group of objects. For the second and subsequent GetProtectionStatus
requests, specify the value of NextToken from the previous response to get information about another
batch of objects.
Integer maxResults
Specifies the number of objects that you want Firewall Manager to return for this request. If you have more
objects than the number that you specify for MaxResults, the response includes a
NextToken value that you can use to get another batch of objects.
String adminAccountId
The ID of the Firewall Manager administrator account for this policy.
String serviceType
The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.
String data
Details about the attack, including the following:
Attack type
Account ID
ARN of the resource attacked
Start time of the attack
End time of the attack (ongoing attacks will not have an end time)
The details are in JSON format.
String nextToken
If you have more objects than the number that you specified for MaxResults in the request, the
response includes a NextToken value. To list more objects, submit another
GetProtectionStatus request, and specify the NextToken value from the response in the
NextToken value in the next request.
Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make
subsequent request calls automatically on your behalf. However, this feature is not supported by
GetProtectionStatus. You must submit subsequent requests with NextToken using your own
processes.
ProtocolsListData protocolsList
Information about the specified Firewall Manager protocols list.
String protocolsListArn
The Amazon Resource Name (ARN) of the specified protocols list.
String identifier
A unique identifier for the resource set, used in a request to refer to the resource set.
ResourceSet resourceSet
Information about the specified resource set.
String resourceSetArn
The Amazon Resource Name (ARN) of the resource set.
String thirdPartyFirewall
The name of the third-party firewall vendor.
String thirdPartyFirewallStatus
The current status for setting a Firewall Manager policy administrators account as an administrator of the third-party firewall tenant.
ONBOARDING - The Firewall Manager policy administrator is being designated as a tenant
administrator.
ONBOARD_COMPLETE - The Firewall Manager policy administrator is designated as a tenant
administrator.
OFFBOARDING - The Firewall Manager policy administrator is being removed as a tenant administrator.
OFFBOARD_COMPLETE - The Firewall Manager policy administrator has been removed as a tenant
administrator.
NOT_EXIST - The Firewall Manager policy administrator doesn't exist as a tenant administrator.
String marketplaceOnboardingStatus
The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.
NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed to the third-party
firewall service in the Amazon Web Services Marketplace.
NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the
third-party firewall service in the Amazon Web Services Marketplace, but doesn't yet have an active subscription.
COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party
firewall service in the Amazon Web Services Marketplace.
String policyId
The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:
DNS Firewall
Imported Network Firewall
Network Firewall
Security group content audit
Network ACL
Third-party firewall
String memberAccount
The Amazon Web Services account ID that you want the details for.
String resourceId
The ID of the resource that has violations.
String resourceType
The resource type. This is in the format shown in the Amazon
Web Services Resource Types Reference. Supported resource types are: AWS::EC2::Instance,
AWS::EC2::NetworkInterface, AWS::EC2::SecurityGroup,
AWS::NetworkFirewall::FirewallPolicy, and AWS::EC2::Subnet.
ViolationDetail violationDetail
Violation detail for a resource.
String vpc
The VPC where the violation was found.
String subnet
The subnet that's associated with the network ACL.
String subnetAvailabilityZone
The Availability Zone where the network ACL is in use.
String currentAssociatedNetworkAcl
The network ACL containing the entry violations.
List<E> entryViolations
Detailed information about the entry violations in the network ACL.
String nextToken
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, Firewall Manager 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 maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
List<E> adminAccounts
A list of Firewall Manager administrator accounts within the organization that were onboarded as administrators by AssociateAdminAccount or PutAdminAccount.
String nextToken
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, Firewall Manager 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.
String nextToken
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, Firewall Manager 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 maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
List<E> adminAccounts
The list of accounts who manage member accounts within their AdminScope.
String nextToken
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, Firewall Manager 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.
Boolean defaultLists
Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
String nextToken
If you specify a value for MaxResults in your list request, and you have more objects than the
maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the
token returned by the prior request in the request parameters, to retrieve the next batch of objects.
Integer maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
If you don't specify this, Firewall Manager returns all available objects.
List<E> appsLists
An array of AppsListDataSummary objects.
String nextToken
If you specify a value for MaxResults in your list request, and you have more objects than the
maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to
retrieve the next batch of objects.
String policyId
The ID of the Firewall Manager policy that you want the details for.
String nextToken
If you specify a value for MaxResults and you have more PolicyComplianceStatus objects
than the number that you specify for MaxResults, Firewall Manager returns a NextToken
value in the response that allows you to list another group of PolicyComplianceStatus objects. For
the second and subsequent ListComplianceStatus requests, specify the value of NextToken
from the previous response to get information about another batch of PolicyComplianceStatus objects.
Integer maxResults
Specifies the number of PolicyComplianceStatus objects that you want Firewall Manager to return for
this request. If you have more PolicyComplianceStatus objects than the number that you specify for
MaxResults, the response includes a NextToken value that you can use to get another
batch of PolicyComplianceStatus objects.
List<E> policyComplianceStatusList
An array of PolicyComplianceStatus objects.
String nextToken
If you have more PolicyComplianceStatus objects than the number that you specified for
MaxResults in the request, the response includes a NextToken value. To list more
PolicyComplianceStatus objects, submit another ListComplianceStatus request, and
specify the NextToken value from the response in the NextToken value in the next
request.
List<E> memberAccountIds
The Amazon Web Services account IDs to discover resources in. Only one account is supported per request. The account must be a member of your organization.
String resourceType
The type of resources to discover.
Integer maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
String nextToken
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, Firewall Manager 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.
List<E> items
Details of the resources that were discovered.
String nextToken
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, Firewall Manager 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.
String nextToken
If you specify a value for MaxResults and you have more account IDs than the number that you specify
for MaxResults, Firewall Manager returns a NextToken value in the response that allows
you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests,
specify the value of NextToken from the previous response to get information about another batch of
member account IDs.
Integer maxResults
Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have
more IDs than the number that you specify for MaxResults, the response includes a
NextToken value that you can use to get another batch of member account IDs.
List<E> memberAccounts
An array of account IDs.
String nextToken
If you have more member account IDs than the number that you specified for MaxResults in the
request, the response includes a NextToken value. To list more IDs, submit another
ListMemberAccounts request, and specify the NextToken value from the response in the
NextToken value in the next request.
String nextToken
If you specify a value for MaxResults and you have more PolicySummary objects than the
number that you specify for MaxResults, Firewall Manager returns a NextToken value in
the response that allows you to list another group of PolicySummary objects. For the second and
subsequent ListPolicies requests, specify the value of NextToken from the previous
response to get information about another batch of PolicySummary objects.
Integer maxResults
Specifies the number of PolicySummary objects that you want Firewall Manager to return for this
request. If you have more PolicySummary objects than the number that you specify for
MaxResults, the response includes a NextToken value that you can use to get another
batch of PolicySummary objects.
List<E> policyList
An array of PolicySummary objects.
String nextToken
If you have more PolicySummary objects than the number that you specified for
MaxResults in the request, the response includes a NextToken value. To list more
PolicySummary objects, submit another ListPolicies request, and specify the
NextToken value from the response in the NextToken value in the next request.
Boolean defaultLists
Specifies whether the lists to retrieve are default lists owned by Firewall Manager.
String nextToken
If you specify a value for MaxResults in your list request, and you have more objects than the
maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the
token returned by the prior request in the request parameters, to retrieve the next batch of objects.
Integer maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
If you don't specify this, Firewall Manager returns all available objects.
List<E> protocolsLists
An array of ProtocolsListDataSummary objects.
String nextToken
If you specify a value for MaxResults in your list request, and you have more objects than the
maximum, Firewall Manager returns this token in the response. You can use this token in subsequent requests to
retrieve the next batch of objects.
String identifier
A unique identifier for the resource set, used in a request to refer to the resource set.
Integer maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
String nextToken
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, Firewall Manager 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.
List<E> items
An array of the associated resources' uniform resource identifiers (URI).
String nextToken
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, Firewall Manager 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.
String nextToken
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, Firewall Manager 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 maxResults
The maximum number of objects that you want Firewall Manager to return for this request. If more objects are
available, in the response, Firewall Manager provides a NextToken value that you can use in a
subsequent call to get the next batch of objects.
List<E> resourceSets
An array of ResourceSetSummary objects.
String nextToken
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, Firewall Manager 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.
String resourceArn
The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists.
String thirdPartyFirewall
The name of the third-party firewall vendor.
String nextToken
If the previous response included a NextToken element, the specified third-party firewall vendor is
associated with more third-party firewall policies. To get more third-party firewall policies, submit another
ListThirdPartyFirewallFirewallPoliciesRequest request.
For the value of NextToken, specify the value of NextToken from the previous response.
If the previous response didn't include a NextToken element, there are no more third-party firewall
policies to get.
Integer maxResults
The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified
third-party firewall vendor is associated with more than MaxResults firewall policies, the response
includes a NextToken element. NextToken contains an encrypted token that identifies the
first third-party firewall policies that Firewall Manager will return if you submit another request.
List<E> thirdPartyFirewallFirewallPolicies
A list that contains one ThirdPartyFirewallFirewallPolicies element for each third-party firewall
policies that the specified third-party firewall vendor is associated with. Each
ThirdPartyFirewallFirewallPolicies element contains the firewall policy name and ID.
String nextToken
The value that you will use for NextToken in the next
ListThirdPartyFirewallFirewallPolicies request.
NetworkAclEntrySet networkAclEntrySet
The definition of the first and last rules for the network ACL policy.
NetworkAclIcmpTypeCode icmpTypeCode
ICMP protocol: The ICMP type and code.
String protocol
The protocol number. A value of "-1" means all protocols.
NetworkAclPortRange portRange
TCP or UDP protocols: The range of ports the rule applies to.
String cidrBlock
The IPv4 network range to allow or deny, in CIDR notation.
String ipv6CidrBlock
The IPv6 network range to allow or deny, in CIDR notation.
String ruleAction
Indicates whether to allow or deny the traffic that matches the rule.
Boolean egress
Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it's not an egress rule, then it's an ingress, or inbound, rule.
List<E> firstEntries
The rules that you want to run first in the Firewall Manager managed network ACLs.
Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.
You must specify at least one first entry or one last entry in any network ACL policy.
Boolean forceRemediateForFirstEntries
Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
List<E> lastEntries
The rules that you want to run last in the Firewall Manager managed network ACLs.
Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.
You must specify at least one first entry or one last entry in any network ACL policy.
Boolean forceRemediateForLastEntries
Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the Firewall Manager Developer Guide.
String subnetId
The subnet ID.
String subnetAvailabilityZone
The subnet Availability Zone.
String routeTableId
Information about the route table ID.
List<E> violatingRoutes
The route or routes that are in violation.
Boolean isRouteTableUsedInDifferentAZ
Information about whether the route table is used in another Availability Zone.
String currentFirewallSubnetRouteTable
Information about the subnet route table for the current firewall.
String expectedFirewallEndpoint
The expected endpoint for the current firewall.
String firewallSubnetId
The firewall subnet ID.
List<E> expectedFirewallSubnetRoutes
The firewall subnet routes that are expected.
List<E> actualFirewallSubnetRoutes
The actual firewall subnet routes.
String internetGatewayId
The internet gateway ID.
String currentInternetGatewayRouteTable
The current route table for the internet gateway.
List<E> expectedInternetGatewayRoutes
The internet gateway routes that are expected.
List<E> actualInternetGatewayRoutes
The actual internet gateway routes.
String vpcId
Information about the VPC ID.
List<E> affectedSubnets
The subnets that are affected.
String routeTableId
The route table ID.
Boolean isRouteTableUsedInDifferentAZ
Information about whether the route table is used in another Availability Zone.
Route violatingRoute
The route that's in violation.
String currentFirewallSubnetRouteTable
The subnet route table for the current firewall.
String expectedFirewallEndpoint
The firewall endpoint that's expected.
String actualFirewallEndpoint
The actual firewall endpoint.
String expectedFirewallSubnetId
The expected subnet ID for the firewall.
String actualFirewallSubnetId
The actual subnet ID for the firewall.
List<E> expectedFirewallSubnetRoutes
The firewall subnet routes that are expected.
List<E> actualFirewallSubnetRoutes
The actual firewall subnet routes that are expected.
String internetGatewayId
The internet gateway ID.
String currentInternetGatewayRouteTable
The route table for the current internet gateway.
List<E> expectedInternetGatewayRoutes
The expected routes for the internet gateway.
List<E> actualInternetGatewayRoutes
The actual internet gateway routes.
String vpcId
Information about the VPC ID.
String violationTarget
The ID of the Network Firewall or VPC resource that's in violation.
String vPC
The resource ID of the VPC associated with a violating subnet.
String availabilityZone
The Availability Zone of a violating subnet.
String currentRouteTable
The resource ID of the current route table that's associated with the subnet, if one is available.
String expectedRouteTable
The resource ID of the route table that should be associated with the subnet.
String violationTarget
The ID of the Network Firewall or VPC resource that's in violation.
String vPC
The resource ID of the VPC associated with a violating subnet.
String availabilityZone
The Availability Zone of a violating subnet.
String targetViolationReason
The reason the resource has this violation, if one is available.
String violationTarget
The ID of the Network Firewall or VPC resource that's in violation.
String vPC
The resource ID of the VPC associated with a violating subnet.
String availabilityZone
The Availability Zone of a violating subnet.
String targetViolationReason
The reason the resource has this violation, if one is available.
String firewallDeploymentModel
Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to
NULL.
List<E> statelessRuleGroups
The stateless rule groups that are used in the Network Firewall firewall policy.
List<E> statelessDefaultActions
The actions to take on packets that don't match any of the stateless rule groups.
List<E> statelessFragmentDefaultActions
The actions to take on packet fragments that don't match any of the stateless rule groups.
List<E> statelessCustomActions
Names of custom actions that are available for use in the stateless default actions settings.
List<E> statefulRuleGroups
The stateful rule groups that are used in the Network Firewall firewall policy.
List<E> statefulDefaultActions
The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established
StatefulEngineOptions statefulEngineOptions
Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
String violationTarget
The ID of the Network Firewall or VPC resource that's in violation.
NetworkFirewallPolicyDescription currentPolicyDescription
The policy that's currently in use in the individual account.
NetworkFirewallPolicyDescription expectedPolicyDescription
The policy that should be in use in the individual account in order to be compliant.
String action
The action that changes the rule group from DROP to ALERT. This only applies to managed
rule groups.
String firewallSubnetId
The subnet ID for the firewall.
List<E> violatingRoutes
The routes that are in violation.
String routeTableId
The ID of the route table.
String firewallEndpoint
The endpoint of the firewall.
String vpcId
Information about the VPC ID.
List<E> organizationalUnits
The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot
apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then
the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this
list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false,
then the Firewall Manager administrator can only apply policies to the OUs in this list.
Boolean allOrganizationalUnitsEnabled
A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If
true, the administrator can manage all OUs within the organization. You can either enable management of all OUs
through this operation, or you can specify OUs to manage in
OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.
Boolean excludeSpecifiedOrganizationalUnits
A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the
administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the
organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can
either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can
enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot
specify both.
String policyId
The ID of the Firewall Manager policy.
String policyName
The name of the Firewall Manager policy.
String policyUpdateToken
A unique identifier for each update to the policy. When issuing a PutPolicy request, the
PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy
version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy
request.
SecurityServicePolicyData securityServicePolicyData
Details about the security service that is being used to protect the resources.
String resourceType
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon
Web Services Resource Types Reference. To apply this policy to multiple resource types, specify a resource
type of ResourceTypeList and then specify the resource types in a ResourceTypeList.
The following are valid resource types for each Firewall Manager policy type:
Amazon Web Services WAF Classic - AWS::ApiGateway::Stage, AWS::CloudFront::Distribution
, and AWS::ElasticLoadBalancingV2::LoadBalancer.
WAF - AWS::ApiGateway::Stage, AWS::ElasticLoadBalancingV2::LoadBalancer, and
AWS::CloudFront::Distribution.
Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer,
AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and
AWS::CloudFront::Distribution.
Network ACL - AWS::EC2::Subnet.
Security group usage audit - AWS::EC2::SecurityGroup.
Security group content audit - AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and
AWS::EC2::Instance.
DNS Firewall, Network Firewall, and third-party firewall - AWS::EC2::VPC.
List<E> resourceTypeList
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a
single resource type, use ResourceType.
List<E> resourceTags
An array of ResourceTag objects.
Boolean excludeResourceTags
If set to True, resources with the tags that are specified in the ResourceTag array are
not in scope of the policy. If set to False, and the ResourceTag array is not null,
only resources with the specified tags are in scope of the policy.
Boolean remediationEnabled
Indicates if the policy should be automatically applied to new resources.
Boolean deleteUnusedFMManagedResources
Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.
By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
Map<K,V> includeMap
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any
ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager
applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Map<K,V> excludeMap
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate any
ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall Manager
applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
List<E> resourceSetIds
The unique identifiers of the resource sets used by the policy.
String policyDescription
Your description of the Firewall Manager policy.
String policyStatus
Indicates whether the policy is in or out of an admin's policy or Region scope.
ACTIVE - The administrator can manage and delete the policy.
OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the
policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be
protected.
String policyOwner
The Amazon Web Services account that created the Firewall Manager policy.
String policyId
The ID of the Firewall Manager policy.
String memberAccount
The Amazon Web Services account ID.
List<E> violators
An array of resources that aren't protected by the WAF or Shield Advanced policy or that aren't in compliance with the security group policy.
Boolean evaluationLimitExceeded
Indicates if over 100 resources are noncompliant with the Firewall Manager policy.
Date expiredAt
A timestamp that indicates when the returned information should be considered out of date.
Map<K,V> issueInfoMap
Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.
String policyOwner
The Amazon Web Services account that created the Firewall Manager policy.
String policyId
The ID of the Firewall Manager policy.
String policyName
The name of the Firewall Manager policy.
String memberAccount
The member account ID.
List<E> evaluationResults
An array of EvaluationResult objects.
Date lastUpdated
Timestamp of the last update to the EvaluationResult objects.
Map<K,V> issueInfoMap
Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.
NetworkFirewallPolicy networkFirewallPolicy
Defines the deployment model to use for the firewall policy.
ThirdPartyFirewallPolicy thirdPartyFirewallPolicy
Defines the policy options for a third-party firewall policy.
NetworkAclCommonPolicy networkAclCommonPolicy
Defines a Firewall Manager network ACL policy.
String policyArn
The Amazon Resource Name (ARN) of the specified policy.
String policyId
The ID of the specified policy.
String policyName
The name of the specified policy.
String resourceType
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference.
String securityServiceType
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
Boolean remediationEnabled
Indicates if the policy should be automatically applied to new resources.
Boolean deleteUnusedFMManagedResources
Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.
By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
String policyStatus
Indicates whether the policy is in or out of an admin's policy or Region scope.
ACTIVE - The administrator can manage and delete the policy.
OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can't edit or delete the
policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be
protected.
List<E> policyTypes
The list of policy types that the specified Firewall Manager administrator can manage.
Boolean allPolicyTypesEnabled
Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.
String listId
The ID of the Firewall Manager protocols list.
String listName
The name of the Firewall Manager protocols list.
String listUpdateToken
A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list.
Date createTime
The time that the Firewall Manager protocols list was created.
Date lastUpdateTime
The time that the Firewall Manager protocols list was last updated.
List<E> protocolsList
An array of protocols in the Firewall Manager protocols list.
Map<K,V> previousProtocolsList
A map of previous version numbers to their corresponding protocol arrays.
String listArn
The Amazon Resource Name (ARN) of the specified protocols list.
String listId
The ID of the specified protocols list.
String listName
The name of the specified protocols list.
List<E> protocolsList
An array of protocols in the Firewall Manager protocols list.
String adminAccount
The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
AdminScope adminScope
Configures the resources that the specified Firewall Manager administrator can manage. As a best practice, set the administrative scope according to the principles of least privilege. Only grant the administrator the specific resources or permissions that they need to perform the duties of their role.
AppsListData appsList
The details of the Firewall Manager applications list to be created.
List<E> tagList
The tags associated with the resource.
AppsListData appsList
The details of the Firewall Manager applications list.
String appsListArn
The Amazon Resource Name (ARN) of the applications list.
ProtocolsListData protocolsList
The details of the Firewall Manager protocols list to be created.
List<E> tagList
The tags associated with the resource.
ProtocolsListData protocolsList
The details of the Firewall Manager protocols list.
String protocolsListArn
The Amazon Resource Name (ARN) of the protocols list.
ResourceSet resourceSet
Details about the resource set to be created or updated.>
List<E> tagList
Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
ResourceSet resourceSet
Details about the resource set.
String resourceSetArn
The Amazon Resource Name (ARN) of the resource set.
String description
A description of a remediation action.
EC2CreateRouteAction eC2CreateRouteAction
Information about the CreateRoute action in the Amazon EC2 API.
EC2ReplaceRouteAction eC2ReplaceRouteAction
Information about the ReplaceRoute action in the Amazon EC2 API.
EC2DeleteRouteAction eC2DeleteRouteAction
Information about the DeleteRoute action in the Amazon EC2 API.
EC2CopyRouteTableAction eC2CopyRouteTableAction
Information about the CopyRouteTable action in the Amazon EC2 API.
EC2ReplaceRouteTableAssociationAction eC2ReplaceRouteTableAssociationAction
Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.
EC2AssociateRouteTableAction eC2AssociateRouteTableAction
Information about the AssociateRouteTable action in the Amazon EC2 API.
EC2CreateRouteTableAction eC2CreateRouteTableAction
Information about the CreateRouteTable action in the Amazon EC2 API.
FMSPolicyUpdateFirewallCreationConfigAction fMSPolicyUpdateFirewallCreationConfigAction
The remedial action to take when updating a firewall configuration.
CreateNetworkAclAction createNetworkAclAction
Information about the CreateNetworkAcl action in Amazon EC2.
ReplaceNetworkAclAssociationAction replaceNetworkAclAssociationAction
Information about the ReplaceNetworkAclAssociation action in Amazon EC2.
CreateNetworkAclEntriesAction createNetworkAclEntriesAction
Information about the CreateNetworkAclEntries action in Amazon EC2.
DeleteNetworkAclEntriesAction deleteNetworkAclEntriesAction
Information about the DeleteNetworkAclEntries action in Amazon EC2.
RemediationAction remediationAction
Information about an action you can take to remediate a violation.
Integer order
The order of the remediation actions in the list.
String description
Brief description of this remediation action.
ActionTarget associationId
ActionTarget networkAclId
The network ACL that's associated with the remediation action.
Boolean fMSCanRemediate
Indicates whether it is possible for Firewall Manager to perform this remediation action. A false value indicates that auto remediation is disabled or Firewall Manager is unable to perform the action due to a conflict of some kind.
String id
A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String name
The descriptive name of the resource set. You can't change the name of a resource set after you create it.
String description
A description of the resource set.
String updateToken
An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.
To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses
the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the
operation fails with an InvalidTokenException. If this happens, retrieve the resource set 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.
List<E> resourceTypeList
Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
Date lastUpdateTime
The last time that the resource set was changed.
String resourceSetStatus
Indicates whether the resource set is in or out of an admin's Region scope.
ACTIVE - The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the
resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
be protected.
String id
A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String name
The descriptive name of the resource set. You can't change the name of a resource set after you create it.
String description
A description of the resource set.
Date lastUpdateTime
The last time that the resource set was changed.
String resourceSetStatus
Indicates whether the resource set is in or out of an admin's Region scope.
ACTIVE - The administrator can manage and delete the resource set.
OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can't edit or delete the
resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
be protected.
AwsVPCSecurityGroupViolation awsVPCSecurityGroupViolation
Violation detail for security groups.
AwsEc2NetworkInterfaceViolation awsEc2NetworkInterfaceViolation
Violation detail for a network interface.
AwsEc2InstanceViolation awsEc2InstanceViolation
Violation detail for an EC2 instance.
NetworkFirewallMissingFirewallViolation networkFirewallMissingFirewallViolation
Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.
NetworkFirewallMissingSubnetViolation networkFirewallMissingSubnetViolation
Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.
NetworkFirewallMissingExpectedRTViolation networkFirewallMissingExpectedRTViolation
Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.
NetworkFirewallPolicyModifiedViolation networkFirewallPolicyModifiedViolation
Violation detail for an Network Firewall policy that indicates that a firewall policy in an individual account has been modified in a way that makes it noncompliant. For example, the individual account owner might have deleted a rule group, changed the priority of a stateless rule group, or changed a policy default action.
NetworkFirewallInternetTrafficNotInspectedViolation networkFirewallInternetTrafficNotInspectedViolation
Violation detail for the subnet for which internet traffic hasn't been inspected.
NetworkFirewallInvalidRouteConfigurationViolation networkFirewallInvalidRouteConfigurationViolation
The route configuration is invalid.
NetworkFirewallBlackHoleRouteDetectedViolation networkFirewallBlackHoleRouteDetectedViolation
NetworkFirewallUnexpectedFirewallRoutesViolation networkFirewallUnexpectedFirewallRoutesViolation
There's an unexpected firewall route.
NetworkFirewallUnexpectedGatewayRoutesViolation networkFirewallUnexpectedGatewayRoutesViolation
There's an unexpected gateway route.
NetworkFirewallMissingExpectedRoutesViolation networkFirewallMissingExpectedRoutesViolation
Expected routes are missing from Network Firewall.
DnsRuleGroupPriorityConflictViolation dnsRuleGroupPriorityConflictViolation
Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule group that's already associated.
DnsDuplicateRuleGroupViolation dnsDuplicateRuleGroupViolation
Violation detail for a DNS Firewall policy that indicates that a rule group that Firewall Manager tried to associate with a VPC is already associated with the VPC and can't be associated again.
DnsRuleGroupLimitExceededViolation dnsRuleGroupLimitExceededViolation
Violation detail for a DNS Firewall policy that indicates that the VPC reached the limit for associated DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and failed.
FirewallSubnetIsOutOfScopeViolation firewallSubnetIsOutOfScopeViolation
Contains details about the firewall subnet that violates the policy scope.
RouteHasOutOfScopeEndpointViolation routeHasOutOfScopeEndpointViolation
Contains details about the route endpoint that violates the policy scope.
ThirdPartyFirewallMissingFirewallViolation thirdPartyFirewallMissingFirewallViolation
The violation details for a third-party firewall that's been deleted.
ThirdPartyFirewallMissingSubnetViolation thirdPartyFirewallMissingSubnetViolation
The violation details for a third-party firewall's subnet that's been deleted.
ThirdPartyFirewallMissingExpectedRouteTableViolation thirdPartyFirewallMissingExpectedRouteTableViolation
The violation details for a third-party firewall that has the Firewall Manager managed route table that was associated with the third-party firewall has been deleted.
FirewallSubnetMissingVPCEndpointViolation firewallSubnetMissingVPCEndpointViolation
The violation details for a third-party firewall's VPC endpoint subnet that was deleted.
InvalidNetworkAclEntriesViolation invalidNetworkAclEntriesViolation
Violation detail for the entries in a network ACL resource.
PossibleRemediationActions possibleRemediationActions
A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.
String subnetId
The ID of the subnet associated with the route that violates the policy scope.
String vpcId
The VPC ID of the route that violates the policy scope.
String routeTableId
The ID of the route table.
List<E> violatingRoutes
The list of routes that violate the route table.
String subnetAvailabilityZone
The subnet's Availability Zone.
String subnetAvailabilityZoneId
The ID of the subnet's Availability Zone.
String currentFirewallSubnetRouteTable
The route table associated with the current firewall subnet.
String firewallSubnetId
The ID of the firewall subnet.
List<E> firewallSubnetRoutes
The list of firewall subnet routes.
String internetGatewayId
The ID of the Internet Gateway.
String currentInternetGatewayRouteTable
The current route table associated with the Internet Gateway.
List<E> internetGatewayRoutes
The routes in the route table associated with the Internet Gateway.
String remediationActionType
The remediation action that will be performed.
String description
Brief description of the action that will be performed.
SecurityGroupRuleDescription remediationResult
The final state of the rule specified in the ViolationTarget after it is remediated.
Boolean isDefaultAction
Indicates if the current action is the default action.
String iPV4Range
The IPv4 ranges for the security group rule.
String iPV6Range
The IPv6 ranges for the security group rule.
String prefixListId
The ID of the prefix list for the security group rule.
String protocol
The IP protocol name (tcp, udp, icmp, icmpv6) or number.
Long fromPort
The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of
-1 indicates all ICMP/ICMPv6 types.
Long toPort
The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1
indicates all ICMP/ICMPv6 codes.
String type
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting Amazon Web Services Support.
String managedServiceData
Details about the service that are specific to the service type, in JSON format.
Example: DNS_FIREWALL
"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"
Valid values for preProcessRuleGroups are between 1 and 99. Valid values for
postProcessRuleGroups are between 9901 and 10000.
Example: IMPORT_NETWORK_FIREWALL
"{\"type\":\"IMPORT_NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\/rg1\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:drop\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:pass\"],\"networkFirewallStatelessCustomActions\":[],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\/ThreatSignaturesEmergingEventsStrictOrder\",\"priority\":8}],\"networkFirewallStatefulEngineOptions\":{\"ruleOrder\":\"STRICT_ORDER\"},\"networkFirewallStatefulDefaultActions\":[\"aws:drop_strict\"]}}"
"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"
Valid values for preProcessRuleGroups are between 1 and 99. Valid values for
postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Centralized deployment model
"{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"
To use the centralized deployment model, you must set PolicyOption to
CENTRALIZED.
Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone
configuration
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"
With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the
endpoints in. To use the distributed deployment model, you must set PolicyOption to
NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with automatic Availability Zone
configuration and route management
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"
To use the distributed deployment model, you must set PolicyOption to
NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ \"10.0.0.0/28\"]}]} },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"
With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in
by configuring firewallCreationConfig. To configure the Availability Zones in
firewallCreationConfig, specify either the availabilityZoneName or
availabilityZoneId parameter, not both parameters.
To use the distributed deployment model, you must set PolicyOption to
NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration
and route management
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"
To use the distributed deployment model, you must set PolicyOption to
NULL.
Example: SECURITY_GROUPS_COMMON
"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
Example: SECURITY_GROUPS_COMMON - Security group tag distribution
""{\"type\":\"SECURITY_GROUPS_COMMON\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"revertManualSecurityGroupChanges\":true,\"exclusiveResourceSecurityGroupManagement\":false,\"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":false,\"enableTagDistribution\":true}""
Firewall Manager automatically distributes tags from the primary group to the security groups created by this
policy. To use security group tag distribution, you must also set revertManualSecurityGroupChanges
to true, otherwise Firewall Manager won't be able to create the policy. When you enable
revertManualSecurityGroupChanges, Firewall Manager identifies and reports when the security groups
created by this policy become non-compliant.
Firewall Manager won't distribute system tags added by Amazon Web Services services into the replica security
groups. System tags begin with the aws: prefix.
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as well as to those in VPCs that the account owns
"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"includeSharedVPC\":true,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
Example: SECURITY_GROUPS_CONTENT_AUDIT
"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\"sg-000e55995d61a06bd\"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"
The security group action for content audit can be ALLOW or DENY. For
ALLOW, all in-scope security group rules must be within the allowed range of the policy's security
group rules. For DENY, all in-scope security group rules must not contain a value or a range that
matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT
"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"
Example: SHIELD_ADVANCED with web ACL management
"{\"type\":\"SHIELD_ADVANCED\",\"optimizeUnassociatedWebACL\":true}"
If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in
accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates
web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at
any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if
at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.
If you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically
creates an empty web ACL in each account that's within policy scope.
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
"{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":true|false, \"optimizeUnassociatedWebACL\":true|false}"
For example:
"{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED\", \"automaticResponseAction\":\"COUNT\"}}"
The default value for automaticResponseStatus is IGNORED. The value for
automaticResponseAction is only required when automaticResponseStatus is set to
ENABLED. The default value for overrideCustomerWebaclClassic is false.
For other resource types that you can protect with a Shield Advanced policy, this ManagedServiceData
configuration is an empty string.
Example: THIRD_PARTY_FIREWALL
Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.
"{ "type":"THIRD_PARTY_FIREWALL", "thirdPartyFirewall":"THIRD_PARTY_FIREWALL_NAME", "thirdPartyFirewallConfig":{ "thirdPartyFirewallPolicyList":["global-1"] }, "firewallDeploymentModel":{ "distributedFirewallDeploymentModel":{ "distributedFirewallOrchestrationConfig":{ "firewallCreationConfig":{ "endpointLocation":{ "availabilityZoneConfigList":[ { "availabilityZoneName":"${AvailabilityZone}" } ] } }, "allowedIPV4CidrList":[ ] } } } }"
Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated
web ACL, and rule action override
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesATPRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesATPRuleSet\":{\"loginPath\":\"/loginpath\",\"requestInspection\":{\"payloadType\":\"FORM_ENCODED|JSON\",\"usernameField\":{\"identifier\":\"/form/username\"},\"passwordField\":{\"identifier\":\"/form/password\"}}}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true},{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesBotControlRuleSet\",\"managedRuleGroupConfigs\":[{\"awsmanagedRulesBotControlRuleSet\":{\"inspectionLevel\":\"TARGETED|COMMON\"}}]},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true,\"ruleActionOverrides\":[{\"name\":\"Rule1\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}},{\"name\":\"Rule2\",\"actionToUse\":{\"allow|block|count|captcha|challenge\":{}}}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"optimizeUnassociatedWebACL\":true}"
Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see
AWSManagedRulesBotControlRuleSet in the WAF API Reference.
Fraud Control account takeover prevention (ATP) - For information about the properties available for
AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.
Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall
Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one
resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used
by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically
creates a web ACL in the account if at least one resource will use the web ACL.
Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.
If you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused
web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.
Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To
configure a RuleActionOverrides add the Name of the rule to override, and
ActionToUse, which is the new action to use for the rule. For information about using rule action
override, see RuleActionOverride in
the WAF API Reference.
Example: WAFV2 - CAPTCHA and Challenge configs
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[],\"sampledRequestsEnabled\":true}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\":null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":null,\"sampledRequestsEnabledForDefaultActions\":true,\"captchaConfig\":{\"immunityTimeProperty\":{\"immunityTime\":500}},\"challengeConfig\":{\"immunityTimeProperty\":{\"immunityTime\":800}},\"tokenDomains\":[\"google.com\",\"amazon.com\"],\"associationConfig\":{\"requestBody\":{\"CLOUDFRONT\":{\"defaultSizeInspectionLimit\":\"KB_16\"}}}}"
CAPTCHA and Challenge configs - If you update the policy's values for
associationConfig, captchaConfig, challengeConfig, or
tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s).
However, if you don't update the policy's associationConfig, captchaConfig,
challengeConfig, or tokenDomains values, the values in your local web ACLs will remain
unchanged. For information about association configs, see AssociationConfig. For
information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the
WAF API Reference.
defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an
associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"
To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set
versionEnabled to true, and set version to the version you'd like to use.
If you don't set versionEnabled to true, or if you omit versionEnabled,
then Firewall Manager uses the default version of the WAF managed rule group.
Example: WAFV2 - Logging configurations
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null, \"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\": {\"versionEnabled\":null,\"version\":null,\"vendorName\":\"AWS\", \"managedRuleGroupName\":\"AWSManagedRulesAdminProtectionRuleSet\"} ,\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[], \"sampledRequestsEnabled\":true}],\"postProcessRuleGroups\":[], \"defaultAction\":{\"type\":\"ALLOW\"},\"customRequestHandling\" :null,\"customResponse\":null,\"overrideCustomerWebACLAssociation\" :false,\"loggingConfiguration\":{\"logDestinationConfigs\": [\"arn:aws:s3:::aws-waf-logs-example-bucket\"] ,\"redactedFields\":[],\"loggingFilterConfigs\":{\"defaultBehavior\":\"KEEP\", \"filters\":[{\"behavior\":\"KEEP\",\"requirement\":\"MEETS_ALL\", \"conditions\":[{\"actionCondition\":\"CAPTCHA\"},{\"actionCondition\": \"CHALLENGE\"}, {\"actionCondition\":\"EXCLUDED_AS_COUNT\"}]}]}},\"sampledRequestsEnabledForDefaultActions\":true}"
Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in
your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration
in the WAF API Reference
In the loggingConfiguration, you can specify one logDestinationConfigs. Optionally
provide as many as 20 redactedFields. The RedactedFieldType must be one of
URI, QUERY_STRING, HEADER, or METHOD.
Example: WAF Classic
"{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"
PolicyOption policyOption
Contains the settings to configure a network ACL policy, a Network Firewall firewall policy deployment model, or a third-party firewall policy.
String ruleOrder
Indicates how to manage the order of stateful rule evaluation for the policy. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Default: DEFAULT_ACTION_ORDER
String streamExceptionPolicy
Indicates how Network Firewall should handle traffic when a network connection breaks midstream.
DROP - Fail closed and drop all subsequent traffic going to the firewall.
CONTINUE - Continue to apply rules to subsequent traffic without context from traffic before the
break. This impacts the behavior of rules that depend on context. For example, with a stateful rule that drops
HTTP traffic, Network Firewall won't match subsequent traffic because the it won't have the context from session
initialization, which defines the application layer protocol as HTTP. However, a TCP-layer rule using a
flow:stateless rule would still match, and so would the aws:drop_strict default action.
REJECT - Fail closed and drop all subsequent traffic going to the firewall. With this option,
Network Firewall also sends a TCP reject packet back to the client so the client can immediately establish a new
session. With the new session, Network Firewall will have context and will apply rules appropriately.
For applications that are reliant on long-lived TCP connections that trigger Gateway Load Balancer idle timeouts, this is the recommended setting.
FMS_IGNORE - Firewall Manager doesn't monitor or modify the Network Firewall stream exception policy
settings.
For more information, see Stream exception policy in your firewall policy in the Network Firewall Developer Guide.
Default: FMS_IGNORE
String ruleGroupName
The name of the rule group.
String resourceId
The resource ID of the rule group.
Integer priority
An integer setting that indicates the order in which to run the stateful rule groups in a single Network Firewall
firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER rule
order in the stateful engine options settings.
Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. For information about
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
NetworkFirewallStatefulRuleGroupOverride override
The action that allows the policy owner to override the behavior of the rule group within a policy.
String ruleGroupName
The name of the rule group.
String resourceId
The resource ID of the rule group.
Integer priority
The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
String key
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.
String value
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.
String violationTarget
The ID of the third-party firewall or VPC resource that's causing the violation.
String vPC
The resource ID of the VPC associated with a fireawll subnet that's causing the violation.
String availabilityZone
The Availability Zone of the firewall subnet that's causing the violation.
String currentRouteTable
The resource ID of the current route table that's associated with the subnet, if one is available.
String expectedRouteTable
The resource ID of the route table that should be associated with the subnet.
String violationTarget
The ID of the third-party firewall that's causing the violation.
String vPC
The resource ID of the VPC associated with a third-party firewall.
String availabilityZone
The Availability Zone of the third-party firewall that's causing the violation.
String targetViolationReason
The reason the resource is causing this violation, if a reason is available.
String violationTarget
The ID of the third-party firewall or VPC resource that's causing the violation.
String vPC
The resource ID of the VPC associated with a subnet that's causing the violation.
String availabilityZone
The Availability Zone of a subnet that's causing the violation.
String targetViolationReason
The reason the resource is causing the violation, if a reason is available.
String firewallDeploymentModel
Defines the deployment model to use for the third-party firewall policy.
String policyId
The ID of the Firewall Manager policy that the violation details were requested for.
String memberAccount
The Amazon Web Services account that the violation details were requested for.
String resourceId
The resource ID that the violation details were requested for.
String resourceType
The resource type that the violation details were requested for.
List<E> resourceViolations
List of violations for the requested resource.
List<E> resourceTags
The ResourceTag objects associated with the resource.
String resourceDescription
Brief description for the requested resource.
Copyright © 2025. All rights reserved.