CfnPolicyPropsMixin
- class aws_cdk.mixins_preview.aws_fms.mixins.CfnPolicyPropsMixin(props, *, strategy=None)
Bases:
MixinAn AWS Firewall Manager policy.
A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.
If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.
Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .
Firewall Manager provides the following types of policies:
AWS WAF policy - This policy applies AWS WAF web ACL protections to specified accounts and resources.
Shield Advanced policy - This policy applies Shield Advanced protection to specified accounts and resources.
Security Groups policy - This type of policy gives you control over security groups that are in use throughout your organization in AWS Organizations and lets you enforce a baseline set of rules across your organization.
Network ACL policy - This type of policy gives you control over the network ACLs that are in use throughout your organization in AWS Organizations and lets you enforce a baseline set of first and last network ACL rules across your organization.
Network Firewall policy - This policy applies Network Firewall protection to your organization’s VPCs.
DNS Firewall policy - This policy applies Amazon Route 53 Resolver DNS Firewall protections to your organization’s VPCs.
Third-party firewall policy - This policy applies third-party firewall protections. Third-party firewalls are available by subscription through the AWS Marketplace console at AWS Marketplace .
Palo Alto Networks Cloud NGFW policy - This policy applies Palo Alto Networks Cloud Next Generation Firewall (NGFW) protections and Palo Alto Networks Cloud NGFW rulestacks to your organization’s VPCs.
Fortigate CNF policy - This policy applies Fortigate Cloud Native Firewall (CNF) protections. Fortigate CNF is a cloud-centered solution that blocks Zero-Day threats and secures cloud infrastructures with industry-leading advanced threat prevention, smart web application firewalls (WAF), and API protection.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html
- CloudformationResource:
AWS::FMS::Policy
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins cfn_policy_props_mixin = fms_mixins.CfnPolicyPropsMixin(fms_mixins.CfnPolicyMixinProps( delete_all_policy_resources=False, exclude_map={ "account": ["account"], "orgunit": ["orgunit"] }, exclude_resource_tags=False, include_map={ "account": ["account"], "orgunit": ["orgunit"] }, policy_description="policyDescription", policy_name="policyName", remediation_enabled=False, resources_clean_up=False, resource_set_ids=["resourceSetIds"], resource_tag_logical_operator="resourceTagLogicalOperator", resource_tags=[fms_mixins.CfnPolicyPropsMixin.ResourceTagProperty( key="key", value="value" )], resource_type="resourceType", resource_type_list=["resourceTypeList"], security_service_policy_data=fms_mixins.CfnPolicyPropsMixin.SecurityServicePolicyDataProperty( managed_service_data="managedServiceData", policy_option=fms_mixins.CfnPolicyPropsMixin.PolicyOptionProperty( network_acl_common_policy=fms_mixins.CfnPolicyPropsMixin.NetworkAclCommonPolicyProperty( network_acl_entry_set=fms_mixins.CfnPolicyPropsMixin.NetworkAclEntrySetProperty( first_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )], force_remediate_for_first_entries=False, force_remediate_for_last_entries=False, last_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )] ) ), network_firewall_policy=fms_mixins.CfnPolicyPropsMixin.NetworkFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ), third_party_firewall_policy=fms_mixins.CfnPolicyPropsMixin.ThirdPartyFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ) ), type="type" ), tags=[fms_mixins.CfnPolicyPropsMixin.PolicyTagProperty( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::FMS::Policy.- Parameters:
props (
Union[CfnPolicyMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['deleteAllPolicyResources', 'excludeMap', 'excludeResourceTags', 'includeMap', 'policyDescription', 'policyName', 'remediationEnabled', 'resourcesCleanUp', 'resourceSetIds', 'resourceTagLogicalOperator', 'resourceTags', 'resourceType', 'resourceTypeList', 'securityServicePolicyData', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
IEMapProperty
- class CfnPolicyPropsMixin.IEMapProperty(*, account=None, orgunit=None)
Bases:
objectSpecifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in or 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.
This is used for the policy’s
IncludeMapandExcludeMap.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
ORGUNIT. For example, the following is a valid map:{“ORGUNIT” : [“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”], “ORGUNIT” : [“ouid111”, “ouid112”]}.
- Parameters:
account (
Optional[Sequence[str]]) – The account list for the map.orgunit (
Optional[Sequence[str]]) – The organizational unit list for the map.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins i_eMap_property = { "account": ["account"], "orgunit": ["orgunit"] }
Attributes
- account
The account list for the map.
- orgunit
The organizational unit list for the map.
IcmpTypeCodeProperty
- class CfnPolicyPropsMixin.IcmpTypeCodeProperty(*, code=None, type=None)
Bases:
objectICMP protocol: The ICMP type and code.
- Parameters:
code (
Union[int,float,None]) – ICMP code.type (
Union[int,float,None]) – ICMP type.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins icmp_type_code_property = fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 )
Attributes
- code
ICMP code.
NetworkAclCommonPolicyProperty
- class CfnPolicyPropsMixin.NetworkAclCommonPolicyProperty(*, network_acl_entry_set=None)
Bases:
objectDefines a Firewall Manager network ACL policy.
This is used in the
PolicyOptionof aSecurityServicePolicyDatafor aPolicy, when theSecurityServicePolicyDatatype is set toNETWORK_ACL_COMMON.For information about network ACLs, see Control traffic to subnets using network ACLs in the Amazon Virtual Private Cloud User Guide .
- Parameters:
network_acl_entry_set (
Union[IResolvable,NetworkAclEntrySetProperty,Dict[str,Any],None]) – The definition of the first and last rules for the network ACL policy.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins network_acl_common_policy_property = fms_mixins.CfnPolicyPropsMixin.NetworkAclCommonPolicyProperty( network_acl_entry_set=fms_mixins.CfnPolicyPropsMixin.NetworkAclEntrySetProperty( first_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )], force_remediate_for_first_entries=False, force_remediate_for_last_entries=False, last_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )] ) )
Attributes
- network_acl_entry_set
The definition of the first and last rules for the network ACL policy.
NetworkAclEntryProperty
- class CfnPolicyPropsMixin.NetworkAclEntryProperty(*, cidr_block=None, egress=None, icmp_type_code=None, ipv6_cidr_block=None, port_range=None, protocol=None, rule_action=None)
Bases:
objectDescribes a rule in a network ACL.
Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the network ACL, AWS processes the entries in the network ACL according to the rule numbers, in ascending order.
When you manage an individual network ACL, you explicitly specify the rule numbers. When you specify the network ACL rules in a Firewall Manager policy, you provide the rules to run first, in the order that you want them to run, and the rules to run last, in the order that you want them to run. Firewall Manager assigns the rule numbers for you when you save the network ACL policy specification.
- Parameters:
cidr_block (
Optional[str]) – The IPv4 network range to allow or deny, in CIDR notation.egress (
Union[bool,IResolvable,None]) – Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet). If it’s not an egress rule, then it’s an ingress, or inbound, rule.icmp_type_code (
Union[IResolvable,IcmpTypeCodeProperty,Dict[str,Any],None]) – ICMP protocol: The ICMP type and code.ipv6_cidr_block (
Optional[str]) – The IPv6 network range to allow or deny, in CIDR notation.port_range (
Union[IResolvable,PortRangeProperty,Dict[str,Any],None]) – TCP or UDP protocols: The range of ports the rule applies to.protocol (
Optional[str]) – The protocol number. A value of “-1” means all protocols.rule_action (
Optional[str]) – Indicates whether to allow or deny the traffic that matches the rule.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins network_acl_entry_property = fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )
Attributes
- cidr_block
The IPv4 network range to allow or deny, in CIDR notation.
- egress
Indicates whether the rule is an egress, or outbound, rule (applied to traffic leaving the subnet).
If it’s not an egress rule, then it’s an ingress, or inbound, rule.
- icmp_type_code
The ICMP type and code.
- ipv6_cidr_block
The IPv6 network range to allow or deny, in CIDR notation.
- port_range
The range of ports the rule applies to.
- protocol
The protocol number.
A value of “-1” means all protocols.
- rule_action
Indicates whether to allow or deny the traffic that matches the rule.
NetworkAclEntrySetProperty
- class CfnPolicyPropsMixin.NetworkAclEntrySetProperty(*, first_entries=None, force_remediate_for_first_entries=None, force_remediate_for_last_entries=None, last_entries=None)
Bases:
objectThe configuration of the first and last rules for the network ACL policy, and the remediation settings for each.
- Parameters:
first_entries (
Union[IResolvable,Sequence[Union[IResolvable,NetworkAclEntryProperty,Dict[str,Any]]],None]) – The rules that you want to run first in the Firewall Manager managed network ACLs. .. epigraph:: Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates. You must specify at least one first entry or one last entry in any network ACL policy.force_remediate_for_first_entries (
Union[bool,IResolvable,None]) – Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the AWS Firewall Manager Developer Guide .force_remediate_for_last_entries (
Union[bool,IResolvable,None]) –Applies only when remediation is enabled for the policy as a whole. Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries. If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the AWS Firewall Manager Developer Guide .
last_entries (
Union[IResolvable,Sequence[Union[IResolvable,NetworkAclEntryProperty,Dict[str,Any]]],None]) – The rules that you want to run last in the Firewall Manager managed network ACLs. .. epigraph:: Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates. You must specify at least one first entry or one last entry in any network ACL policy.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins network_acl_entry_set_property = fms_mixins.CfnPolicyPropsMixin.NetworkAclEntrySetProperty( first_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )], force_remediate_for_first_entries=False, force_remediate_for_last_entries=False, last_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )] )
Attributes
- first_entries
The rules that you want to run first in the Firewall Manager managed network ACLs.
Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.
You must specify at least one first entry or one last entry in any network ACL policy.
- force_remediate_for_first_entries
Applies only when remediation is enabled for the policy as a whole.
Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the AWS Firewall Manager Developer Guide .
- force_remediate_for_last_entries
Applies only when remediation is enabled for the policy as a whole.
Firewall Manager uses this setting when it finds policy violations that involve conflicts between the custom entries and the policy entries.
If forced remediation is disabled, Firewall Manager marks the network ACL as noncompliant and does not try to remediate. For more information about the remediation behavior, see Remediation for managed network ACLs in the AWS Firewall Manager Developer Guide .
- last_entries
The rules that you want to run last in the Firewall Manager managed network ACLs.
Provide these in the order in which you want them to run. Firewall Manager will assign the specific rule numbers for you, in the network ACLs that it creates.
You must specify at least one first entry or one last entry in any network ACL policy.
NetworkFirewallPolicyProperty
- class CfnPolicyPropsMixin.NetworkFirewallPolicyProperty(*, firewall_deployment_model=None)
Bases:
objectConfigures the firewall policy deployment model of AWS Network Firewall .
For information about Network Firewall deployment models, see AWS Network Firewall example architectures with routing in the Network Firewall Developer Guide .
- Parameters:
firewall_deployment_model (
Optional[str]) – Defines the deployment model to use for the firewall policy. To use a distributed model, set FirewallDeploymentModel toDISTRIBUTED.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins network_firewall_policy_property = fms_mixins.CfnPolicyPropsMixin.NetworkFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" )
Attributes
- firewall_deployment_model
Defines the deployment model to use for the firewall policy.
To use a distributed model, set FirewallDeploymentModel to
DISTRIBUTED.
PolicyOptionProperty
- class CfnPolicyPropsMixin.PolicyOptionProperty(*, network_acl_common_policy=None, network_firewall_policy=None, third_party_firewall_policy=None)
Bases:
objectContains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy.
- Parameters:
network_acl_common_policy (
Union[IResolvable,NetworkAclCommonPolicyProperty,Dict[str,Any],None]) – Defines a Firewall Manager network ACL policy.network_firewall_policy (
Union[IResolvable,NetworkFirewallPolicyProperty,Dict[str,Any],None]) – Defines the deployment model to use for the firewall policy.third_party_firewall_policy (
Union[IResolvable,ThirdPartyFirewallPolicyProperty,Dict[str,Any],None]) – Defines the policy options for a third-party firewall policy.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins policy_option_property = fms_mixins.CfnPolicyPropsMixin.PolicyOptionProperty( network_acl_common_policy=fms_mixins.CfnPolicyPropsMixin.NetworkAclCommonPolicyProperty( network_acl_entry_set=fms_mixins.CfnPolicyPropsMixin.NetworkAclEntrySetProperty( first_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )], force_remediate_for_first_entries=False, force_remediate_for_last_entries=False, last_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )] ) ), network_firewall_policy=fms_mixins.CfnPolicyPropsMixin.NetworkFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ), third_party_firewall_policy=fms_mixins.CfnPolicyPropsMixin.ThirdPartyFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ) )
Attributes
- network_acl_common_policy
Defines a Firewall Manager network ACL policy.
- network_firewall_policy
Defines the deployment model to use for the firewall policy.
- third_party_firewall_policy
Defines the policy options for a third-party firewall policy.
PolicyTagProperty
- class CfnPolicyPropsMixin.PolicyTagProperty(*, key=None, value=None)
Bases:
objectA collection of key:value pairs associated with an AWS 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 AWS resource.
- Parameters:
key (
Optional[str]) – 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 (
Optional[str]) – 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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins policy_tag_property = fms_mixins.CfnPolicyPropsMixin.PolicyTagProperty( key="key", value="value" )
Attributes
- 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
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.
PortRangeProperty
- class CfnPolicyPropsMixin.PortRangeProperty(*, from_=None, to=None)
Bases:
objectTCP or UDP protocols: The range of ports the rule applies to.
- Parameters:
from – The beginning port number of the range.
to (
Union[int,float,None]) – The ending port number of the range.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins port_range_property = fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 )
Attributes
- from_
The beginning port number of the range.
- to
The ending port number of the range.
ResourceTagProperty
- class CfnPolicyPropsMixin.ResourceTagProperty(*, key=None, value=None)
Bases:
objectThe resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy.
Tags enable you to categorize your AWS 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 .
- Parameters:
key (
Optional[str]) – The resource tag key.value (
Optional[str]) – The resource tag value.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins resource_tag_property = fms_mixins.CfnPolicyPropsMixin.ResourceTagProperty( key="key", value="value" )
Attributes
- key
The resource tag key.
- value
The resource tag value.
SecurityServicePolicyDataProperty
- class CfnPolicyPropsMixin.SecurityServicePolicyDataProperty(*, managed_service_data=None, policy_option=None, type=None)
Bases:
objectDetails about the security service that is being used to protect the resources.
- Parameters:
managed_service_data (
Optional[str]) –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}]}".. epigraph:: Valid values forpreProcessRuleGroupsare between 1 and 99. Valid values forpostProcessRuleGroupsare between 9901 and 10000. - Example:NETWORK_FIREWALL- Centralized deployment model"{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Example:NETWORK_FIREWALL- Distributed deployment model with automatic Availability Zone configuration"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Example:NETWORK_FIREWALL- Distributed deployment model with automatic Availability Zone configuration and route management"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Example:NETWORK_FIREWALL- Distributed deployment model with custom Availability Zone configuration"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ \"10.0.0.0/28\"]}]} },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuringfirewallCreationConfig. To configure the Availability Zones infirewallCreationConfig, specify either theavailabilityZoneNameoravailabilityZoneIdparameter, not both parameters. To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Example:NETWORK_FIREWALL- Distributed deployment model with custom Availability Zone configuration and route management"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Example:THIRD_PARTY_FIREWALL- Palo Alto Networks Cloud Next-Generation Firewall centralized deployment model"{ \"type\":\"THIRD_PARTY_FIREWALL\", \"thirdPartyFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\", \"thirdPartyFirewallConfig\":{ \"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"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 distributed deployment model, you must set FirewallDeploymentModel toCENTRALIZED. - Example:THIRD_PARTY_FIREWALL- Palo Alto Networks Cloud Next-Generation Firewall distributed deployment model"{\"type\":\"THIRD_PARTY_FIREWALL\",\"thirdPartyFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\",\"thirdPartyFirewallConfig\":{\"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"firewallDeploymentModel\":{ \"distributedFirewallDeploymentModel\":{ \"distributedFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{ \"availabilityZoneConfigList\":[ {\"availabilityZoneName\":\"${AvailabilityZone}\" } ] } }, \"allowedIPV4CidrList\":[ ] } } } }"To use the distributed deployment model, you must set FirewallDeploymentModel toDISTRIBUTED. - Specification forSHIELD_ADVANCEDfor 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 forautomaticResponseStatusisIGNORED. The value forautomaticResponseActionis only required whenautomaticResponseStatusis set toENABLED. The default value foroverrideCustomerWebaclClassicisfalse. For other resource types that you can protect with a Shield Advanced policy, thisManagedServiceDataconfiguration 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 theloggingConfiguration, you can specify onelogDestinationConfigs, you can optionally provide up to 20redactedFields, and theRedactedFieldTypemust be one ofURI,QUERY_STRING,HEADER, orMETHOD. - Example:AWS WAF Classic"{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"- Example:WAFV2- AWS Firewall Manager support for AWS WAF managed rule group versioning"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"To use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must setversionEnabledtotrue, and setversionto the version you’d like to use. If you don’t setversionEnabledtotrue, or if you omitversionEnabled, then Firewall Manager uses the default version of the AWS WAF managed rule group. - 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 beALLOWorDENY. ForALLOW, all in-scope security group rules must be within the allowed range of the policy’s security group rules. ForDENY, 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}"policy_option (
Union[IResolvable,PolicyOptionProperty,Dict[str,Any],None]) – Contains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy.type (
Optional[str]) – The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS 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 SUPlong .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins security_service_policy_data_property = fms_mixins.CfnPolicyPropsMixin.SecurityServicePolicyDataProperty( managed_service_data="managedServiceData", policy_option=fms_mixins.CfnPolicyPropsMixin.PolicyOptionProperty( network_acl_common_policy=fms_mixins.CfnPolicyPropsMixin.NetworkAclCommonPolicyProperty( network_acl_entry_set=fms_mixins.CfnPolicyPropsMixin.NetworkAclEntrySetProperty( first_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )], force_remediate_for_first_entries=False, force_remediate_for_last_entries=False, last_entries=[fms_mixins.CfnPolicyPropsMixin.NetworkAclEntryProperty( cidr_block="cidrBlock", egress=False, icmp_type_code=fms_mixins.CfnPolicyPropsMixin.IcmpTypeCodeProperty( code=123, type=123 ), ipv6_cidr_block="ipv6CidrBlock", port_range=fms_mixins.CfnPolicyPropsMixin.PortRangeProperty( from=123, to=123 ), protocol="protocol", rule_action="ruleAction" )] ) ), network_firewall_policy=fms_mixins.CfnPolicyPropsMixin.NetworkFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ), third_party_firewall_policy=fms_mixins.CfnPolicyPropsMixin.ThirdPartyFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" ) ), type="type" )
Attributes
- managed_service_data
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}]}".. epigraph:Valid values for ``preProcessRuleGroups`` are between 1 and 99. Valid values for ``postProcessRuleGroups`` are between 9901 and 10000.
Example:
NETWORK_FIREWALL- Centralized deployment model
"{\"type\":\"NETWORK_FIREWALL\",\"awsNetworkFirewallConfig\":{\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}},\"firewallDeploymentModel\":{\"centralizedFirewallDeploymentModel\":{\"centralizedFirewallOrchestrationConfig\":{\"inspectionVpcIds\":[{\"resourceId\":\"vpc-1234\",\"accountId\":\"123456789011\"}],\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneId\":null,\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"allowedIPV4CidrList\":[]}}}}"To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Example:
NETWORK_FIREWALL- Distributed deployment model with automatic Availability Zone configuration
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"OFF\"},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Example:
NETWORK_FIREWALL- Distributed deployment model with automatic Availability Zone configuration and route management
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":[\"10.0.0.0/28\",\"192.168.0.0/28\"],\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"]},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\": \"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":true}}"To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Example:
NETWORK_FIREWALL- Distributed deployment model with custom Availability Zone configuration
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\", \"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{ \"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[ \"10.0.0.0/28\"]}]} },\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"OFF\",\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"With custom Availability Zone configuration, you define which specific Availability Zones to create endpoints in by configuring
firewallCreationConfig. To configure the Availability Zones infirewallCreationConfig, specify either theavailabilityZoneNameoravailabilityZoneIdparameter, not both parameters.To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Example:
NETWORK_FIREWALL- Distributed deployment model with custom Availability Zone configuration and route management
"{\"type\":\"NETWORK_FIREWALL\",\"networkFirewallStatelessRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\",\"priority\":1}],\"networkFirewallStatelessDefaultActions\":[\"aws:forward_to_sfe\",\"customActionName\"],\"networkFirewallStatelessFragmentDefaultActions\":[\"aws:forward_to_sfe\",\"fragmentcustomactionname\"],\"networkFirewallStatelessCustomActions\":[{\"actionName\":\"customActionName\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"metricdimensionvalue\"}]}}},{\"actionName\":\"fragmentcustomactionname\",\"actionDefinition\":{\"publishMetricAction\":{\"dimensions\":[{\"value\":\"fragmentmetricdimensionvalue\"}]}}}],\"networkFirewallStatefulRuleGroupReferences\":[{\"resourceARN\":\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\"}],\"networkFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{\"availabilityZoneConfigList\":[{\"availabilityZoneName\":\"us-east-1a\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]},{\"availabilityZoneName\":\"us-east-1b\",\"allowedIPV4CidrList\":[\"10.0.0.0/28\"]}]}},\"singleFirewallEndpointPerVPC\":false,\"allowedIPV4CidrList\":null,\"routeManagementAction\":\"MONITOR\",\"routeManagementTargetTypes\":[\"InternetGateway\"],\"routeManagementConfig\":{\"allowCrossAZTrafficIfNoEndpoint\":true}},\"networkFirewallLoggingConfiguration\":{\"logDestinationConfigs\":[{\"logDestinationType\":\"S3\",\"logType\":\"ALERT\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}},{\"logDestinationType\":\"S3\",\"logType\":\"FLOW\",\"logDestination\":{\"bucketName\":\"s3-bucket-name\"}}],\"overrideExistingConfig\":boolean}}"To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Example:
THIRD_PARTY_FIREWALL- Palo Alto Networks Cloud Next-Generation Firewall centralized deployment model
"{ \"type\":\"THIRD_PARTY_FIREWALL\", \"thirdPartyFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\", \"thirdPartyFirewallConfig\":{ \"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"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 distributed deployment model, you must set FirewallDeploymentModel to
CENTRALIZED.Example:
THIRD_PARTY_FIREWALL- Palo Alto Networks Cloud Next-Generation Firewall distributed deployment model
"{\"type\":\"THIRD_PARTY_FIREWALL\",\"thirdPartyFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\",\"thirdPartyFirewallConfig\":{\"thirdPartyFirewallPolicyList\":[\"global-1\"] },\"firewallDeploymentModel\":{ \"distributedFirewallDeploymentModel\":{ \"distributedFirewallOrchestrationConfig\":{\"firewallCreationConfig\":{\"endpointLocation\":{ \"availabilityZoneConfigList\":[ {\"availabilityZoneName\":\"${AvailabilityZone}\" } ] } }, \"allowedIPV4CidrList\":[ ] } } } }"To use the distributed deployment model, you must set FirewallDeploymentModel to
DISTRIBUTED.Specification for
SHIELD_ADVANCEDfor 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
automaticResponseStatusisIGNORED. The value forautomaticResponseActionis only required whenautomaticResponseStatusis set toENABLED. The default value foroverrideCustomerWebaclClassicisfalse.For other resource types that you can protect with a Shield Advanced policy, this
ManagedServiceDataconfiguration 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 onelogDestinationConfigs, you can optionally provide up to 20redactedFields, and theRedactedFieldTypemust be one ofURI,QUERY_STRING,HEADER, orMETHOD.Example:
AWS WAF Classic
"{\"type\": \"WAF\", \"ruleGroups\": [{\"id\":\"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}"Example:
WAFV2- AWS Firewall Manager support for AWS WAF managed rule group versioning
"{\"type\":\"WAFV2\",\"preProcessRuleGroups\":[{\"ruleGroupArn\":null,\"overrideAction\":{\"type\":\"NONE\"},\"managedRuleGroupIdentifier\":{\"versionEnabled\":true,\"version\":\"Version_2.0\",\"vendorName\":\"AWS\",\"managedRuleGroupName\":\"AWSManagedRulesCommonRuleSet\"},\"ruleGroupType\":\"ManagedRuleGroup\",\"excludeRules\":[{\"name\":\"NoUserAgent_HEADER\"}]}],\"postProcessRuleGroups\":[],\"defaultAction\":{\"type\":\"ALLOW\"},\"overrideCustomerWebACLAssociation\":false,\"loggingConfiguration\":{\"logDestinationConfigs\":[\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\"],\"redactedFields\":[{\"redactedFieldType\":\"SingleHeader\",\"redactedFieldValue\":\"Cookies\"},{\"redactedFieldType\":\"Method\"}]}}"To use a specific version of a AWS WAF managed rule group in your Firewall Manager policy, you must set
versionEnabledtotrue, and setversionto the version you’d like to use. If you don’t setversionEnabledtotrue, or if you omitversionEnabled, then Firewall Manager uses the default version of the AWS WAF managed rule group.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
ALLOWorDENY. ForALLOW, all in-scope security group rules must be within the allowed range of the policy’s security group rules. ForDENY, 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}"
- policy_option
Contains the settings to configure a network ACL policy, a AWS Network Firewall firewall policy deployment model, or a third-party firewall policy.
- type
The service that the policy is using to protect the resources.
This specifies the type of policy that is created, either an AWS 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 SUPlong .
ThirdPartyFirewallPolicyProperty
- class CfnPolicyPropsMixin.ThirdPartyFirewallPolicyProperty(*, firewall_deployment_model=None)
Bases:
objectConfigures the deployment model for the third-party firewall.
- Parameters:
firewall_deployment_model (
Optional[str]) – Defines the deployment model to use for the third-party firewall policy.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_fms import mixins as fms_mixins third_party_firewall_policy_property = fms_mixins.CfnPolicyPropsMixin.ThirdPartyFirewallPolicyProperty( firewall_deployment_model="firewallDeploymentModel" )
Attributes
- firewall_deployment_model
Defines the deployment model to use for the third-party firewall policy.