2022/02/24 - Firewall Management Service - 4 updated api methods
Changes AWS Firewall Manager now supports the configuration of AWS Network Firewall policies with either centralized or distributed deployment models. This release also adds support for custom endpoint configuration, where you can choose which Availability Zones to create firewall endpoints in.
{'PolicyComplianceDetail': {'Violators': {'Metadata': {'string': 'string'},
'ViolationReason': {'FIREWALL_SUBNET_IS_OUT_OF_SCOPE',
'ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT'}}}}
Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy.
Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them.
Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.
Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.
See also: AWS API Documentation
Request Syntax
client.get_compliance_detail(
PolicyId='string',
MemberAccount='string'
)
string
[REQUIRED]
The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.
string
[REQUIRED]
The Amazon Web Services account that owns the resources that you want to get the details for.
dict
Response Syntax
{
'PolicyComplianceDetail': {
'PolicyOwner': 'string',
'PolicyId': 'string',
'MemberAccount': 'string',
'Violators': [
{
'ResourceId': 'string',
'ViolationReason': 'WEB_ACL_MISSING_RULE_GROUP'|'RESOURCE_MISSING_WEB_ACL'|'RESOURCE_INCORRECT_WEB_ACL'|'RESOURCE_MISSING_SHIELD_PROTECTION'|'RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION'|'RESOURCE_MISSING_SECURITY_GROUP'|'RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP'|'SECURITY_GROUP_UNUSED'|'SECURITY_GROUP_REDUNDANT'|'FMS_CREATED_SECURITY_GROUP_EDITED'|'MISSING_FIREWALL'|'MISSING_FIREWALL_SUBNET_IN_AZ'|'MISSING_EXPECTED_ROUTE_TABLE'|'NETWORK_FIREWALL_POLICY_MODIFIED'|'INTERNET_GATEWAY_MISSING_EXPECTED_ROUTE'|'FIREWALL_SUBNET_MISSING_EXPECTED_ROUTE'|'UNEXPECTED_FIREWALL_ROUTES'|'UNEXPECTED_TARGET_GATEWAY_ROUTES'|'TRAFFIC_INSPECTION_CROSSES_AZ_BOUNDARY'|'INVALID_ROUTE_CONFIGURATION'|'MISSING_TARGET_GATEWAY'|'INTERNET_TRAFFIC_NOT_INSPECTED'|'BLACK_HOLE_ROUTE_DETECTED'|'BLACK_HOLE_ROUTE_DETECTED_IN_FIREWALL_SUBNET'|'RESOURCE_MISSING_DNS_FIREWALL'|'FIREWALL_SUBNET_IS_OUT_OF_SCOPE'|'ROUTE_HAS_OUT_OF_SCOPE_ENDPOINT',
'ResourceType': 'string',
'Metadata': {
'string': 'string'
}
},
],
'EvaluationLimitExceeded': True|False,
'ExpiredAt': datetime(2015, 1, 1),
'IssueInfoMap': {
'string': 'string'
}
}
}
Response Structure
(dict) --
PolicyComplianceDetail (dict) --
Information about the resources and the policy that you specified in the GetComplianceDetail request.
PolicyOwner (string) --
The Amazon Web Services account that created the Firewall Manager policy.
PolicyId (string) --
The ID of the Firewall Manager policy.
MemberAccount (string) --
The Amazon Web Services account ID.
Violators (list) --
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.
(dict) --
Details of the resource that is not protected by the policy.
ResourceId (string) --
The resource ID.
ViolationReason (string) --
The reason that the resource is not protected by the policy.
ResourceType (string) --
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.
Metadata (dict) --
Metadata about the resource that doesn't comply with the policy scope.
(string) --
(string) --
EvaluationLimitExceeded (boolean) --
Indicates if over 100 resources are noncompliant with the Firewall Manager policy.
ExpiredAt (datetime) --
A timestamp that indicates when the returned information should be considered out of date.
IssueInfoMap (dict) --
Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.
(string) --
(string) --
{'Policy': {'SecurityServicePolicyData': {'PolicyOption': {'NetworkFirewallPolicy': {'FirewallDeploymentModel': 'CENTRALIZED'}}}}}
Returns information about the specified Firewall Manager policy.
See also: AWS API Documentation
Request Syntax
client.get_policy(
PolicyId='string'
)
string
[REQUIRED]
The ID of the Firewall Manager policy that you want the details for.
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL',
'ManagedServiceData': 'string',
'PolicyOption': {
'NetworkFirewallPolicy': {
'FirewallDeploymentModel': 'CENTRALIZED'
}
}
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'DeleteUnusedFMManagedResources': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
(dict) --
Policy (dict) --
Information about the specified Firewall Manager policy.
PolicyId (string) --
The ID of the Firewall Manager policy.
PolicyName (string) --
The name of the Firewall Manager policy.
PolicyUpdateToken (string) --
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 (dict) --
Details about the security service that is being used to protect the resources.
Type (string) --
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.
ManagedServiceData (string) --
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}]}"
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. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. "{ \"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 } }" 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 } }"
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. "{ \"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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":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: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"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\"}]}}" In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and 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\"}}"
Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
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}"
PolicyOption (dict) --
Contains the Network Firewall firewall policy options to configure a centralized deployment model.
NetworkFirewallPolicy (dict) --
Defines the deployment model to use for the firewall policy.
FirewallDeploymentModel (string) --
Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.
ResourceType (string) --
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.
For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC.
ResourceTypeList (list) --
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.
(string) --
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
Key (string) --
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) --
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.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
DeleteUnusedFMManagedResources (boolean) --
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.
IncludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
ExcludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
PolicyArn (string) --
The Amazon Resource Name (ARN) of the specified policy.
{'ViolationDetail': {'ResourceViolations': {'FirewallSubnetIsOutOfScopeViolation': {'FirewallSubnetId': 'string',
'SubnetAvailabilityZone': 'string',
'SubnetAvailabilityZoneId': 'string',
'VpcEndpointId': 'string',
'VpcId': 'string'},
'PossibleRemediationActions': {'Actions': {'OrderedRemediationActions': {'RemediationAction': {'FMSPolicyUpdateFirewallCreationConfigAction': {'Description': 'string',
'FirewallCreationConfig': 'string'}}}}},
'RouteHasOutOfScopeEndpointViolation': {'CurrentFirewallSubnetRouteTable': 'string',
'CurrentInternetGatewayRouteTable': 'string',
'FirewallSubnetId': 'string',
'FirewallSubnetRoutes': [{'Destination': 'string',
'DestinationType': 'IPV4 '
'| '
'IPV6 '
'| '
'PREFIX_LIST',
'Target': 'string',
'TargetType': 'GATEWAY '
'| '
'CARRIER_GATEWAY '
'| '
'INSTANCE '
'| '
'LOCAL_GATEWAY '
'| '
'NAT_GATEWAY '
'| '
'NETWORK_INTERFACE '
'| '
'VPC_ENDPOINT '
'| '
'VPC_PEERING_CONNECTION '
'| '
'EGRESS_ONLY_INTERNET_GATEWAY '
'| '
'TRANSIT_GATEWAY'}],
'InternetGatewayId': 'string',
'InternetGatewayRoutes': [{'Destination': 'string',
'DestinationType': 'IPV4 '
'| '
'IPV6 '
'| '
'PREFIX_LIST',
'Target': 'string',
'TargetType': 'GATEWAY '
'| '
'CARRIER_GATEWAY '
'| '
'INSTANCE '
'| '
'LOCAL_GATEWAY '
'| '
'NAT_GATEWAY '
'| '
'NETWORK_INTERFACE '
'| '
'VPC_ENDPOINT '
'| '
'VPC_PEERING_CONNECTION '
'| '
'EGRESS_ONLY_INTERNET_GATEWAY '
'| '
'TRANSIT_GATEWAY'}],
'RouteTableId': 'string',
'SubnetAvailabilityZone': 'string',
'SubnetAvailabilityZoneId': 'string',
'SubnetId': 'string',
'ViolatingRoutes': [{'Destination': 'string',
'DestinationType': 'IPV4 '
'| '
'IPV6 '
'| '
'PREFIX_LIST',
'Target': 'string',
'TargetType': 'GATEWAY '
'| '
'CARRIER_GATEWAY '
'| '
'INSTANCE '
'| '
'LOCAL_GATEWAY '
'| '
'NAT_GATEWAY '
'| '
'NETWORK_INTERFACE '
'| '
'VPC_ENDPOINT '
'| '
'VPC_PEERING_CONNECTION '
'| '
'EGRESS_ONLY_INTERNET_GATEWAY '
'| '
'TRANSIT_GATEWAY'}],
'VpcId': 'string'}}}}
Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.get_violation_details(
PolicyId='string',
MemberAccount='string',
ResourceId='string',
ResourceType='string'
)
string
[REQUIRED]
The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.
string
[REQUIRED]
The Amazon Web Services account ID that you want the details for.
string
[REQUIRED]
The ID of the resource that has violations.
string
[REQUIRED]
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.
dict
Response Syntax
{
'ViolationDetail': {
'PolicyId': 'string',
'MemberAccount': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'ResourceViolations': [
{
'AwsVPCSecurityGroupViolation': {
'ViolationTarget': 'string',
'ViolationTargetDescription': 'string',
'PartialMatches': [
{
'Reference': 'string',
'TargetViolationReasons': [
'string',
]
},
],
'PossibleSecurityGroupRemediationActions': [
{
'RemediationActionType': 'REMOVE'|'MODIFY',
'Description': 'string',
'RemediationResult': {
'IPV4Range': 'string',
'IPV6Range': 'string',
'PrefixListId': 'string',
'Protocol': 'string',
'FromPort': 123,
'ToPort': 123
},
'IsDefaultAction': True|False
},
]
},
'AwsEc2NetworkInterfaceViolation': {
'ViolationTarget': 'string',
'ViolatingSecurityGroups': [
'string',
]
},
'AwsEc2InstanceViolation': {
'ViolationTarget': 'string',
'AwsEc2NetworkInterfaceViolations': [
{
'ViolationTarget': 'string',
'ViolatingSecurityGroups': [
'string',
]
},
]
},
'NetworkFirewallMissingFirewallViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'TargetViolationReason': 'string'
},
'NetworkFirewallMissingSubnetViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'TargetViolationReason': 'string'
},
'NetworkFirewallMissingExpectedRTViolation': {
'ViolationTarget': 'string',
'VPC': 'string',
'AvailabilityZone': 'string',
'CurrentRouteTable': 'string',
'ExpectedRouteTable': 'string'
},
'NetworkFirewallPolicyModifiedViolation': {
'ViolationTarget': 'string',
'CurrentPolicyDescription': {
'StatelessRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string',
'Priority': 123
},
],
'StatelessDefaultActions': [
'string',
],
'StatelessFragmentDefaultActions': [
'string',
],
'StatelessCustomActions': [
'string',
],
'StatefulRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string'
},
]
},
'ExpectedPolicyDescription': {
'StatelessRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string',
'Priority': 123
},
],
'StatelessDefaultActions': [
'string',
],
'StatelessFragmentDefaultActions': [
'string',
],
'StatelessCustomActions': [
'string',
],
'StatefulRuleGroups': [
{
'RuleGroupName': 'string',
'ResourceId': 'string'
},
]
}
},
'NetworkFirewallInternetTrafficNotInspectedViolation': {
'SubnetId': 'string',
'SubnetAvailabilityZone': 'string',
'RouteTableId': 'string',
'ViolatingRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'IsRouteTableUsedInDifferentAZ': True|False,
'CurrentFirewallSubnetRouteTable': 'string',
'ExpectedFirewallEndpoint': 'string',
'FirewallSubnetId': 'string',
'ExpectedFirewallSubnetRoutes': [
{
'IpV4Cidr': 'string',
'PrefixListId': 'string',
'IpV6Cidr': 'string',
'ContributingSubnets': [
'string',
],
'AllowedTargets': [
'string',
],
'RouteTableId': 'string'
},
],
'ActualFirewallSubnetRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'InternetGatewayId': 'string',
'CurrentInternetGatewayRouteTable': 'string',
'ExpectedInternetGatewayRoutes': [
{
'IpV4Cidr': 'string',
'PrefixListId': 'string',
'IpV6Cidr': 'string',
'ContributingSubnets': [
'string',
],
'AllowedTargets': [
'string',
],
'RouteTableId': 'string'
},
],
'ActualInternetGatewayRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'VpcId': 'string'
},
'NetworkFirewallInvalidRouteConfigurationViolation': {
'AffectedSubnets': [
'string',
],
'RouteTableId': 'string',
'IsRouteTableUsedInDifferentAZ': True|False,
'ViolatingRoute': {
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
'CurrentFirewallSubnetRouteTable': 'string',
'ExpectedFirewallEndpoint': 'string',
'ActualFirewallEndpoint': 'string',
'ExpectedFirewallSubnetId': 'string',
'ActualFirewallSubnetId': 'string',
'ExpectedFirewallSubnetRoutes': [
{
'IpV4Cidr': 'string',
'PrefixListId': 'string',
'IpV6Cidr': 'string',
'ContributingSubnets': [
'string',
],
'AllowedTargets': [
'string',
],
'RouteTableId': 'string'
},
],
'ActualFirewallSubnetRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'InternetGatewayId': 'string',
'CurrentInternetGatewayRouteTable': 'string',
'ExpectedInternetGatewayRoutes': [
{
'IpV4Cidr': 'string',
'PrefixListId': 'string',
'IpV6Cidr': 'string',
'ContributingSubnets': [
'string',
],
'AllowedTargets': [
'string',
],
'RouteTableId': 'string'
},
],
'ActualInternetGatewayRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'VpcId': 'string'
},
'NetworkFirewallBlackHoleRouteDetectedViolation': {
'ViolationTarget': 'string',
'RouteTableId': 'string',
'VpcId': 'string',
'ViolatingRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
]
},
'NetworkFirewallUnexpectedFirewallRoutesViolation': {
'FirewallSubnetId': 'string',
'ViolatingRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'RouteTableId': 'string',
'FirewallEndpoint': 'string',
'VpcId': 'string'
},
'NetworkFirewallUnexpectedGatewayRoutesViolation': {
'GatewayId': 'string',
'ViolatingRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'RouteTableId': 'string',
'VpcId': 'string'
},
'NetworkFirewallMissingExpectedRoutesViolation': {
'ViolationTarget': 'string',
'ExpectedRoutes': [
{
'IpV4Cidr': 'string',
'PrefixListId': 'string',
'IpV6Cidr': 'string',
'ContributingSubnets': [
'string',
],
'AllowedTargets': [
'string',
],
'RouteTableId': 'string'
},
],
'VpcId': 'string'
},
'DnsRuleGroupPriorityConflictViolation': {
'ViolationTarget': 'string',
'ViolationTargetDescription': 'string',
'ConflictingPriority': 123,
'ConflictingPolicyId': 'string',
'UnavailablePriorities': [
123,
]
},
'DnsDuplicateRuleGroupViolation': {
'ViolationTarget': 'string',
'ViolationTargetDescription': 'string'
},
'DnsRuleGroupLimitExceededViolation': {
'ViolationTarget': 'string',
'ViolationTargetDescription': 'string',
'NumberOfRuleGroupsAlreadyAssociated': 123
},
'PossibleRemediationActions': {
'Description': 'string',
'Actions': [
{
'Description': 'string',
'OrderedRemediationActions': [
{
'RemediationAction': {
'Description': 'string',
'EC2CreateRouteAction': {
'Description': 'string',
'DestinationCidrBlock': 'string',
'DestinationPrefixListId': 'string',
'DestinationIpv6CidrBlock': 'string',
'VpcEndpointId': {
'ResourceId': 'string',
'Description': 'string'
},
'GatewayId': {
'ResourceId': 'string',
'Description': 'string'
},
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2ReplaceRouteAction': {
'Description': 'string',
'DestinationCidrBlock': 'string',
'DestinationPrefixListId': 'string',
'DestinationIpv6CidrBlock': 'string',
'GatewayId': {
'ResourceId': 'string',
'Description': 'string'
},
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2DeleteRouteAction': {
'Description': 'string',
'DestinationCidrBlock': 'string',
'DestinationPrefixListId': 'string',
'DestinationIpv6CidrBlock': 'string',
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2CopyRouteTableAction': {
'Description': 'string',
'VpcId': {
'ResourceId': 'string',
'Description': 'string'
},
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2ReplaceRouteTableAssociationAction': {
'Description': 'string',
'AssociationId': {
'ResourceId': 'string',
'Description': 'string'
},
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2AssociateRouteTableAction': {
'Description': 'string',
'RouteTableId': {
'ResourceId': 'string',
'Description': 'string'
},
'SubnetId': {
'ResourceId': 'string',
'Description': 'string'
},
'GatewayId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'EC2CreateRouteTableAction': {
'Description': 'string',
'VpcId': {
'ResourceId': 'string',
'Description': 'string'
}
},
'FMSPolicyUpdateFirewallCreationConfigAction': {
'Description': 'string',
'FirewallCreationConfig': 'string'
}
},
'Order': 123
},
],
'IsDefaultAction': True|False
},
]
},
'FirewallSubnetIsOutOfScopeViolation': {
'FirewallSubnetId': 'string',
'VpcId': 'string',
'SubnetAvailabilityZone': 'string',
'SubnetAvailabilityZoneId': 'string',
'VpcEndpointId': 'string'
},
'RouteHasOutOfScopeEndpointViolation': {
'SubnetId': 'string',
'VpcId': 'string',
'RouteTableId': 'string',
'ViolatingRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'SubnetAvailabilityZone': 'string',
'SubnetAvailabilityZoneId': 'string',
'CurrentFirewallSubnetRouteTable': 'string',
'FirewallSubnetId': 'string',
'FirewallSubnetRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
],
'InternetGatewayId': 'string',
'CurrentInternetGatewayRouteTable': 'string',
'InternetGatewayRoutes': [
{
'DestinationType': 'IPV4'|'IPV6'|'PREFIX_LIST',
'TargetType': 'GATEWAY'|'CARRIER_GATEWAY'|'INSTANCE'|'LOCAL_GATEWAY'|'NAT_GATEWAY'|'NETWORK_INTERFACE'|'VPC_ENDPOINT'|'VPC_PEERING_CONNECTION'|'EGRESS_ONLY_INTERNET_GATEWAY'|'TRANSIT_GATEWAY',
'Destination': 'string',
'Target': 'string'
},
]
}
},
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ResourceDescription': 'string'
}
}
Response Structure
(dict) --
ViolationDetail (dict) --
Violation detail for a resource.
PolicyId (string) --
The ID of the Firewall Manager policy that the violation details were requested for.
MemberAccount (string) --
The Amazon Web Services account that the violation details were requested for.
ResourceId (string) --
The resource ID that the violation details were requested for.
ResourceType (string) --
The resource type that the violation details were requested for.
ResourceViolations (list) --
List of violations for the requested resource.
(dict) --
Violation detail based on resource type.
AwsVPCSecurityGroupViolation (dict) --
Violation detail for security groups.
ViolationTarget (string) --
The security group rule that is being evaluated.
ViolationTargetDescription (string) --
A description of the security group that violates the policy.
PartialMatches (list) --
List of rules specified in the security group of the Firewall Manager policy that partially match the ViolationTarget rule.
(dict) --
The reference rule that partially matches the ViolationTarget rule and violation reason.
Reference (string) --
The reference rule from the primary security group of the Firewall Manager policy.
TargetViolationReasons (list) --
The violation reason.
(string) --
PossibleSecurityGroupRemediationActions (list) --
Remediation options for the rule specified in the ViolationTarget.
(dict) --
Remediation option for the rule specified in the ViolationTarget.
RemediationActionType (string) --
The remediation action that will be performed.
Description (string) --
Brief description of the action that will be performed.
RemediationResult (dict) --
The final state of the rule specified in the ViolationTarget after it is remediated.
IPV4Range (string) --
The IPv4 ranges for the security group rule.
IPV6Range (string) --
The IPv6 ranges for the security group rule.
PrefixListId (string) --
The ID of the prefix list for the security group rule.
Protocol (string) --
The IP protocol name ( tcp, udp, icmp, icmpv6) or number.
FromPort (integer) --
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.
ToPort (integer) --
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.
IsDefaultAction (boolean) --
Indicates if the current action is the default action.
AwsEc2NetworkInterfaceViolation (dict) --
Violation detail for a network interface.
ViolationTarget (string) --
The resource ID of the network interface.
ViolatingSecurityGroups (list) --
List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.
(string) --
AwsEc2InstanceViolation (dict) --
Violation detail for an EC2 instance.
ViolationTarget (string) --
The resource ID of the EC2 instance.
AwsEc2NetworkInterfaceViolations (list) --
Violation detail for network interfaces associated with the EC2 instance.
(dict) --
Violation detail for network interfaces associated with an EC2 instance.
ViolationTarget (string) --
The resource ID of the network interface.
ViolatingSecurityGroups (list) --
List of security groups that violate the rules specified in the primary security group of the Firewall Manager policy.
(string) --
NetworkFirewallMissingFirewallViolation (dict) --
Violation detail for an Network Firewall policy that indicates that a subnet has no Firewall Manager managed firewall in its VPC.
ViolationTarget (string) --
The ID of the Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
TargetViolationReason (string) --
The reason the resource has this violation, if one is available.
NetworkFirewallMissingSubnetViolation (dict) --
Violation detail for an Network Firewall policy that indicates that an Availability Zone is missing the expected Firewall Manager managed subnet.
ViolationTarget (string) --
The ID of the Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
TargetViolationReason (string) --
The reason the resource has this violation, if one is available.
NetworkFirewallMissingExpectedRTViolation (dict) --
Violation detail for an Network Firewall policy that indicates that a subnet is not associated with the expected Firewall Manager managed route table.
ViolationTarget (string) --
The ID of the Network Firewall or VPC resource that's in violation.
VPC (string) --
The resource ID of the VPC associated with a violating subnet.
AvailabilityZone (string) --
The Availability Zone of a violating subnet.
CurrentRouteTable (string) --
The resource ID of the current route table that's associated with the subnet, if one is available.
ExpectedRouteTable (string) --
The resource ID of the route table that should be associated with the subnet.
NetworkFirewallPolicyModifiedViolation (dict) --
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.
ViolationTarget (string) --
The ID of the Network Firewall or VPC resource that's in violation.
CurrentPolicyDescription (dict) --
The policy that's currently in use in the individual account.
StatelessRuleGroups (list) --
The stateless rule groups that are used in the Network Firewall firewall policy.
(dict) --
Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
Priority (integer) --
The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
StatelessDefaultActions (list) --
The actions to take on packets that don't match any of the stateless rule groups.
(string) --
StatelessFragmentDefaultActions (list) --
The actions to take on packet fragments that don't match any of the stateless rule groups.
(string) --
StatelessCustomActions (list) --
Names of custom actions that are available for use in the stateless default actions settings.
(string) --
StatefulRuleGroups (list) --
The stateful rule groups that are used in the Network Firewall firewall policy.
(dict) --
Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
ExpectedPolicyDescription (dict) --
The policy that should be in use in the individual account in order to be compliant.
StatelessRuleGroups (list) --
The stateless rule groups that are used in the Network Firewall firewall policy.
(dict) --
Network Firewall stateless rule group, used in a NetworkFirewallPolicyDescription.
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
Priority (integer) --
The priority of the rule group. Network Firewall evaluates the stateless rule groups in a firewall policy starting from the lowest priority setting.
StatelessDefaultActions (list) --
The actions to take on packets that don't match any of the stateless rule groups.
(string) --
StatelessFragmentDefaultActions (list) --
The actions to take on packet fragments that don't match any of the stateless rule groups.
(string) --
StatelessCustomActions (list) --
Names of custom actions that are available for use in the stateless default actions settings.
(string) --
StatefulRuleGroups (list) --
The stateful rule groups that are used in the Network Firewall firewall policy.
(dict) --
Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.
RuleGroupName (string) --
The name of the rule group.
ResourceId (string) --
The resource ID of the rule group.
NetworkFirewallInternetTrafficNotInspectedViolation (dict) --
Violation detail for the subnet for which internet traffic hasn't been inspected.
SubnetId (string) --
The subnet ID.
SubnetAvailabilityZone (string) --
The subnet Availability Zone.
RouteTableId (string) --
Information about the route table ID.
ViolatingRoutes (list) --
The route or routes that are in violation.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
IsRouteTableUsedInDifferentAZ (boolean) --
Information about whether the route table is used in another Availability Zone.
CurrentFirewallSubnetRouteTable (string) --
Information about the subnet route table for the current firewall.
ExpectedFirewallEndpoint (string) --
The expected endpoint for the current firewall.
FirewallSubnetId (string) --
The firewall subnet ID.
ExpectedFirewallSubnetRoutes (list) --
The firewall subnet routes that are expected.
(dict) --
Information about the expected route in the route table.
IpV4Cidr (string) --
Information about the IPv4 CIDR block.
PrefixListId (string) --
Information about the ID of the prefix list for the route.
IpV6Cidr (string) --
Information about the IPv6 CIDR block.
ContributingSubnets (list) --
Information about the contributing subnets.
(string) --
AllowedTargets (list) --
Information about the allowed targets.
(string) --
RouteTableId (string) --
Information about the route table ID.
ActualFirewallSubnetRoutes (list) --
The actual firewall subnet routes.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
InternetGatewayId (string) --
The internet gateway ID.
CurrentInternetGatewayRouteTable (string) --
The current route table for the internet gateway.
ExpectedInternetGatewayRoutes (list) --
The internet gateway routes that are expected.
(dict) --
Information about the expected route in the route table.
IpV4Cidr (string) --
Information about the IPv4 CIDR block.
PrefixListId (string) --
Information about the ID of the prefix list for the route.
IpV6Cidr (string) --
Information about the IPv6 CIDR block.
ContributingSubnets (list) --
Information about the contributing subnets.
(string) --
AllowedTargets (list) --
Information about the allowed targets.
(string) --
RouteTableId (string) --
Information about the route table ID.
ActualInternetGatewayRoutes (list) --
The actual internet gateway routes.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
VpcId (string) --
Information about the VPC ID.
NetworkFirewallInvalidRouteConfigurationViolation (dict) --
The route configuration is invalid.
AffectedSubnets (list) --
The subnets that are affected.
(string) --
RouteTableId (string) --
The route table ID.
IsRouteTableUsedInDifferentAZ (boolean) --
Information about whether the route table is used in another Availability Zone.
ViolatingRoute (dict) --
The route that's in violation.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
CurrentFirewallSubnetRouteTable (string) --
The subnet route table for the current firewall.
ExpectedFirewallEndpoint (string) --
The firewall endpoint that's expected.
ActualFirewallEndpoint (string) --
The actual firewall endpoint.
ExpectedFirewallSubnetId (string) --
The expected subnet ID for the firewall.
ActualFirewallSubnetId (string) --
The actual subnet ID for the firewall.
ExpectedFirewallSubnetRoutes (list) --
The firewall subnet routes that are expected.
(dict) --
Information about the expected route in the route table.
IpV4Cidr (string) --
Information about the IPv4 CIDR block.
PrefixListId (string) --
Information about the ID of the prefix list for the route.
IpV6Cidr (string) --
Information about the IPv6 CIDR block.
ContributingSubnets (list) --
Information about the contributing subnets.
(string) --
AllowedTargets (list) --
Information about the allowed targets.
(string) --
RouteTableId (string) --
Information about the route table ID.
ActualFirewallSubnetRoutes (list) --
The actual firewall subnet routes that are expected.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
InternetGatewayId (string) --
The internet gateway ID.
CurrentInternetGatewayRouteTable (string) --
The route table for the current internet gateway.
ExpectedInternetGatewayRoutes (list) --
The expected routes for the internet gateway.
(dict) --
Information about the expected route in the route table.
IpV4Cidr (string) --
Information about the IPv4 CIDR block.
PrefixListId (string) --
Information about the ID of the prefix list for the route.
IpV6Cidr (string) --
Information about the IPv6 CIDR block.
ContributingSubnets (list) --
Information about the contributing subnets.
(string) --
AllowedTargets (list) --
Information about the allowed targets.
(string) --
RouteTableId (string) --
Information about the route table ID.
ActualInternetGatewayRoutes (list) --
The actual internet gateway routes.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
VpcId (string) --
Information about the VPC ID.
NetworkFirewallBlackHoleRouteDetectedViolation (dict) --
Violation detail for an internet gateway route with an inactive state in the customer subnet route table or Network Firewall subnet route table.
ViolationTarget (string) --
The subnet that has an inactive state.
RouteTableId (string) --
Information about the route table ID.
VpcId (string) --
Information about the VPC ID.
ViolatingRoutes (list) --
Information about the route or routes that are in violation.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
NetworkFirewallUnexpectedFirewallRoutesViolation (dict) --
There's an unexpected firewall route.
FirewallSubnetId (string) --
The subnet ID for the firewall.
ViolatingRoutes (list) --
The routes that are in violation.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
RouteTableId (string) --
The ID of the route table.
FirewallEndpoint (string) --
The endpoint of the firewall.
VpcId (string) --
Information about the VPC ID.
NetworkFirewallUnexpectedGatewayRoutesViolation (dict) --
There's an unexpected gateway route.
GatewayId (string) --
Information about the gateway ID.
ViolatingRoutes (list) --
The routes that are in violation.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
RouteTableId (string) --
Information about the route table.
VpcId (string) --
Information about the VPC ID.
NetworkFirewallMissingExpectedRoutesViolation (dict) --
Expected routes are missing from Network Firewall.
ViolationTarget (string) --
The target of the violation.
ExpectedRoutes (list) --
The expected routes.
(dict) --
Information about the expected route in the route table.
IpV4Cidr (string) --
Information about the IPv4 CIDR block.
PrefixListId (string) --
Information about the ID of the prefix list for the route.
IpV6Cidr (string) --
Information about the IPv6 CIDR block.
ContributingSubnets (list) --
Information about the contributing subnets.
(string) --
AllowedTargets (list) --
Information about the allowed targets.
(string) --
RouteTableId (string) --
Information about the route table ID.
VpcId (string) --
Information about the VPC ID.
DnsRuleGroupPriorityConflictViolation (dict) --
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.
ViolationTarget (string) --
Information about the VPC ID.
ViolationTargetDescription (string) --
A description of the violation that specifies the VPC and the rule group that's already associated with it.
ConflictingPriority (integer) --
The priority setting of the two conflicting rule groups.
ConflictingPolicyId (string) --
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.
UnavailablePriorities (list) --
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.
(integer) --
DnsDuplicateRuleGroupViolation (dict) --
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.
ViolationTarget (string) --
Information about the VPC ID.
ViolationTargetDescription (string) --
A description of the violation that specifies the rule group and VPC.
DnsRuleGroupLimitExceededViolation (dict) --
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.
ViolationTarget (string) --
Information about the VPC ID.
ViolationTargetDescription (string) --
A description of the violation that specifies the rule group and VPC.
NumberOfRuleGroupsAlreadyAssociated (integer) --
The number of rule groups currently associated with the VPC.
PossibleRemediationActions (dict) --
A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.
Description (string) --
A description of the possible remediation actions list.
Actions (list) --
Information about the actions.
(dict) --
A list of remediation actions.
Description (string) --
A description of the list of remediation actions.
OrderedRemediationActions (list) --
The ordered list of remediation actions.
(dict) --
An ordered list of actions you can take to remediate a violation.
RemediationAction (dict) --
Information about an action you can take to remediate a violation.
Description (string) --
A description of a remediation action.
EC2CreateRouteAction (dict) --
Information about the CreateRoute action in the Amazon EC2 API.
Description (string) --
A description of CreateRoute action in Amazon EC2.
DestinationCidrBlock (string) --
Information about the IPv4 CIDR address block used for the destination match.
DestinationPrefixListId (string) --
Information about the ID of a prefix list used for the destination match.
DestinationIpv6CidrBlock (string) --
Information about the IPv6 CIDR block destination.
VpcEndpointId (dict) --
Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
GatewayId (dict) --
Information about the ID of an internet gateway or virtual private gateway attached to your VPC.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
RouteTableId (dict) --
Information about the ID of the route table for the route.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2ReplaceRouteAction (dict) --
Information about the ReplaceRoute action in the Amazon EC2 API.
Description (string) --
A description of the ReplaceRoute action in Amazon EC2.
DestinationCidrBlock (string) --
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.
DestinationPrefixListId (string) --
Information about the ID of the prefix list for the route.
DestinationIpv6CidrBlock (string) --
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.
GatewayId (dict) --
Information about the ID of an internet gateway or virtual private gateway.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
RouteTableId (dict) --
Information about the ID of the route table.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2DeleteRouteAction (dict) --
Information about the DeleteRoute action in the Amazon EC2 API.
Description (string) --
A description of the DeleteRoute action.
DestinationCidrBlock (string) --
Information about the IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
DestinationPrefixListId (string) --
Information about the ID of the prefix list for the route.
DestinationIpv6CidrBlock (string) --
Information about the IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
RouteTableId (dict) --
Information about the ID of the route table.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2CopyRouteTableAction (dict) --
Information about the CopyRouteTable action in the Amazon EC2 API.
Description (string) --
A description of the copied EC2 route table that is associated with the remediation action.
VpcId (dict) --
The VPC ID of the copied EC2 route table that is associated with the remediation action.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
RouteTableId (dict) --
The ID of the copied EC2 route table that is associated with the remediation action.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2ReplaceRouteTableAssociationAction (dict) --
Information about the ReplaceRouteTableAssociation action in the Amazon EC2 API.
Description (string) --
A description of the ReplaceRouteTableAssociation action in Amazon EC2.
AssociationId (dict) --
Information about the association ID.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
RouteTableId (dict) --
Information about the ID of the new route table to associate with the subnet.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2AssociateRouteTableAction (dict) --
Information about the AssociateRouteTable action in the Amazon EC2 API.
Description (string) --
A description of the EC2 route table that is associated with the remediation action.
RouteTableId (dict) --
The ID of the EC2 route table that is associated with the remediation action.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
SubnetId (dict) --
The ID of the subnet for the EC2 route table that is associated with the remediation action.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
GatewayId (dict) --
The ID of the gateway to be used with the EC2 route table that is associated with the remediation action.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
EC2CreateRouteTableAction (dict) --
Information about the CreateRouteTable action in the Amazon EC2 API.
Description (string) --
A description of the CreateRouteTable action.
VpcId (dict) --
Information about the ID of a VPC.
ResourceId (string) --
The ID of the remediation target.
Description (string) --
A description of the remediation action target.
FMSPolicyUpdateFirewallCreationConfigAction (dict) --
The remedial action to take when updating a firewall configuration.
Description (string) --
Describes the remedial action.
FirewallCreationConfig (string) --
A FirewallCreationConfig that you can copy into your current policy's SecurityServiceData in order to remedy scope violations.
Order (integer) --
The order of the remediation actions in the list.
IsDefaultAction (boolean) --
Information about whether an action is taken by default.
FirewallSubnetIsOutOfScopeViolation (dict) --
Contains details about the firewall subnet that violates the policy scope.
FirewallSubnetId (string) --
The ID of the firewall subnet that violates the policy scope.
VpcId (string) --
The VPC ID of the firewall subnet that violates the policy scope.
SubnetAvailabilityZone (string) --
The Availability Zone of the firewall subnet that violates the policy scope.
SubnetAvailabilityZoneId (string) --
The Availability Zone ID of the firewall subnet that violates the policy scope.
VpcEndpointId (string) --
The VPC endpoint ID of the firewall subnet that violates the policy scope.
RouteHasOutOfScopeEndpointViolation (dict) --
Contains details about the route endpoint that violates the policy scope.
SubnetId (string) --
The ID of the subnet associated with the route that violates the policy scope.
VpcId (string) --
The VPC ID of the route that violates the policy scope.
RouteTableId (string) --
The ID of the route table.
ViolatingRoutes (list) --
The list of routes that violate the route table.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
SubnetAvailabilityZone (string) --
The subnet's Availability Zone.
SubnetAvailabilityZoneId (string) --
The ID of the subnet's Availability Zone.
CurrentFirewallSubnetRouteTable (string) --
The route table associated with the current firewall subnet.
FirewallSubnetId (string) --
The ID of the firewall subnet.
FirewallSubnetRoutes (list) --
The list of firewall subnet routes.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
InternetGatewayId (string) --
The ID of the Internet Gateway.
CurrentInternetGatewayRouteTable (string) --
The current route table associated with the Internet Gateway.
InternetGatewayRoutes (list) --
The routes in the route table associated with the Internet Gateway.
(dict) --
Describes a route in a route table.
DestinationType (string) --
The type of destination for the route.
TargetType (string) --
The type of target for the route.
Destination (string) --
The destination of the route.
Target (string) --
The route's target.
ResourceTags (list) --
The ResourceTag objects associated with the resource.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(dict) --
A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) --
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
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.
ResourceDescription (string) --
Brief description for the requested resource.
{'Policy': {'SecurityServicePolicyData': {'PolicyOption': {'NetworkFirewallPolicy': {'FirewallDeploymentModel': 'CENTRALIZED'}}}}}
Creates an Firewall Manager policy.
Firewall Manager provides the following types of policies:
An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL.
An WAF Classic policy (type WAF), which defines a rule group.
A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources.
A security group policy, which manages VPC security groups across your Amazon Web Services organization.
An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs.
A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs.
Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type.
You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.
See also: AWS API Documentation
Request Syntax
client.put_policy(
Policy={
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL',
'ManagedServiceData': 'string',
'PolicyOption': {
'NetworkFirewallPolicy': {
'FirewallDeploymentModel': 'CENTRALIZED'
}
}
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'DeleteUnusedFMManagedResources': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
[REQUIRED]
The details of the Firewall Manager policy to be created.
PolicyId (string) --
The ID of the Firewall Manager policy.
PolicyName (string) -- [REQUIRED]
The name of the Firewall Manager policy.
PolicyUpdateToken (string) --
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 (dict) -- [REQUIRED]
Details about the security service that is being used to protect the resources.
Type (string) -- [REQUIRED]
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.
ManagedServiceData (string) --
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}]}"
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. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. "{ \"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 } }" 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 } }"
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. "{ \"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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":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: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"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\"}]}}" In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and 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\"}}"
Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
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}"
PolicyOption (dict) --
Contains the Network Firewall firewall policy options to configure a centralized deployment model.
NetworkFirewallPolicy (dict) --
Defines the deployment model to use for the firewall policy.
FirewallDeploymentModel (string) --
Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.
ResourceType (string) -- [REQUIRED]
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.
For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC.
ResourceTypeList (list) --
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.
(string) --
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
Key (string) -- [REQUIRED]
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) -- [REQUIRED]
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.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
RemediationEnabled (boolean) -- [REQUIRED]
Indicates if the policy should be automatically applied to new resources.
DeleteUnusedFMManagedResources (boolean) --
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.
IncludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
ExcludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
list
The tags to add to the Amazon Web Services resource.
(dict) --
A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource.
Key (string) -- [REQUIRED]
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) -- [REQUIRED]
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyName': 'string',
'PolicyUpdateToken': 'string',
'SecurityServicePolicyData': {
'Type': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL',
'ManagedServiceData': 'string',
'PolicyOption': {
'NetworkFirewallPolicy': {
'FirewallDeploymentModel': 'CENTRALIZED'
}
}
},
'ResourceType': 'string',
'ResourceTypeList': [
'string',
],
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ExcludeResourceTags': True|False,
'RemediationEnabled': True|False,
'DeleteUnusedFMManagedResources': True|False,
'IncludeMap': {
'string': [
'string',
]
},
'ExcludeMap': {
'string': [
'string',
]
}
},
'PolicyArn': 'string'
}
Response Structure
(dict) --
Policy (dict) --
The details of the Firewall Manager policy.
PolicyId (string) --
The ID of the Firewall Manager policy.
PolicyName (string) --
The name of the Firewall Manager policy.
PolicyUpdateToken (string) --
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 (dict) --
Details about the security service that is being used to protect the resources.
Type (string) --
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.
ManagedServiceData (string) --
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}]}"
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. With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. "{ \"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 } }" 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 } }"
Example: NETWORK_FIREWALL - Distributed deployment model with custom Availability Zone configuration. With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring firewallCreationConfig. "{ \"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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
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\":[ { \"availabilityZoneId\":null, \"availabilityZoneName\":\"us-east-1a\", \"allowedIPV4CidrList\":[ \"10.0.0.0/28\" ] }, { ¯\"availabilityZoneId\":null, \"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 } }"
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions "{\"type\":\"SHIELD_ADVANCED\",\"automaticResponseConfiguration\": {\"automaticResponseStatus\":\"ENABLED|IGNORED|DISABLED\", \"automaticResponseAction\":\"BLOCK|COUNT\"}, \"overrideCustomerWebaclClassic\":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: WAFV2 "{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"version\":null,\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesAmazonIpReputationList\"},\"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\"}]}}" In the loggingConfiguration, you can specify one logDestinationConfigs, you can optionally provide up to 20 redactedFields, and 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\"}}"
Example: SECURITY_GROUPS_COMMON "{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false, \"applyToAllEC2InstanceENIs\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"
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}"
PolicyOption (dict) --
Contains the Network Firewall firewall policy options to configure a centralized deployment model.
NetworkFirewallPolicy (dict) --
Defines the deployment model to use for the firewall policy.
FirewallDeploymentModel (string) --
Defines the deployment model to use for the firewall policy. To use a distributed model, set PolicyOption to NULL.
ResourceType (string) --
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.
For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC.
ResourceTypeList (list) --
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a single resource type, use ResourceType.
(string) --
ResourceTags (list) --
An array of ResourceTag objects.
(dict) --
The resource tags that Firewall Manager uses to determine if a particular resource should be included or excluded from the Firewall Manager policy. Tags enable you to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with "AND" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.
Key (string) --
The resource tag key.
Value (string) --
The resource tag value.
ExcludeResourceTags (boolean) --
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.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
RemediationEnabled (boolean) --
Indicates if the policy should be automatically applied to new resources.
DeleteUnusedFMManagedResources (boolean) --
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.
IncludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
ExcludeMap (dict) --
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”]}.
This option isn't available for the centralized deployment model when creating policies to configure Network Firewall.
(string) --
(list) --
(string) --
PolicyArn (string) --
The Amazon Resource Name (ARN) of the policy.