Class: AWSCDK::FMS::CfnPolicyProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fms/cfn_policy_props.rb

Overview

Properties for defining a CfnPolicy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(exclude_resource_tags:, policy_name:, remediation_enabled:, security_service_policy_data:, delete_all_policy_resources: nil, exclude_map: nil, include_map: nil, policy_description: nil, resources_clean_up: nil, resource_set_ids: nil, resource_tag_logical_operator: nil, resource_tags: nil, resource_type: nil, resource_type_list: nil, tags: nil) ⇒ CfnPolicyProps

Returns a new instance of CfnPolicyProps.

Parameters:

  • exclude_resource_tags (Boolean, AWSCDK::IResolvable) —

    Used only when tags are specified in the ResourceTags property.

  • policy_name (String) —

    The name of the AWS Firewall Manager policy.

  • remediation_enabled (Boolean, AWSCDK::IResolvable) —

    Indicates if the policy should be automatically applied to new resources.

  • security_service_policy_data (AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::SecurityServicePolicyDataProperty) —

    Details about the security service that is being used to protect the resources.

  • delete_all_policy_resources (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Used when deleting a policy. If true , Firewall Manager performs cleanup according to the policy type.

  • exclude_map (AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::IEMapProperty, nil) (defaults to: nil) —

    Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to exclude from the policy.

  • include_map (AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::IEMapProperty, nil) (defaults to: nil) —

    Specifies the AWS account IDs and AWS Organizations organizational units (OUs) to include in the policy.

  • policy_description (String, nil) (defaults to: nil) —

    Your description of the AWS Firewall Manager policy.

  • resources_clean_up (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether AWS 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.

  • resource_set_ids (Array<String>, nil) (defaults to: nil) —

    The unique identifiers of the resource sets used by the policy.

  • resource_tag_logical_operator (String, nil) (defaults to: nil) —

    Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.

  • resource_tags (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::ResourceTagProperty>, nil) (defaults to: nil) —

    An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them.

  • resource_type (String, nil) (defaults to: nil) —

    The type of resource protected by or in scope of the policy.

  • resource_type_list (Array<String>, nil) (defaults to: nil) —

    An array of ResourceType objects.

  • tags (Array<AWSCDK::FMS::CfnPolicy::PolicyTagProperty>, nil) (defaults to: nil) —

    A collection of key:value pairs associated with an AWS resource.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'fms/cfn_policy_props.rb', line 24

def initialize(exclude_resource_tags:, policy_name:, remediation_enabled:, security_service_policy_data:, delete_all_policy_resources: nil, exclude_map: nil, include_map: nil, policy_description: nil, resources_clean_up: nil, resource_set_ids: nil, resource_tag_logical_operator: nil, resource_tags: nil, resource_type: nil, resource_type_list: nil, tags: nil)
  @exclude_resource_tags = exclude_resource_tags
  Jsii::Type.check_type(@exclude_resource_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "excludeResourceTags")
  @policy_name = policy_name
  Jsii::Type.check_type(@policy_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyName")
  @remediation_enabled = remediation_enabled
  Jsii::Type.check_type(@remediation_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "remediationEnabled")
  @security_service_policy_data = security_service_policy_data.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::SecurityServicePolicyDataProperty.new(**security_service_policy_data.transform_keys(&:to_sym)) : security_service_policy_data
  Jsii::Type.check_type(@security_service_policy_data, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LlNlY3VyaXR5U2VydmljZVBvbGljeURhdGFQcm9wZXJ0eSJ9XX19")), "securityServicePolicyData")
  @delete_all_policy_resources = delete_all_policy_resources
  Jsii::Type.check_type(@delete_all_policy_resources, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAllPolicyResources") unless @delete_all_policy_resources.nil?
  @exclude_map = exclude_map.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::IEMapProperty.new(**exclude_map.transform_keys(&:to_sym)) : exclude_map
  Jsii::Type.check_type(@exclude_map, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LklFTWFwUHJvcGVydHkifV19fQ==")), "excludeMap") unless @exclude_map.nil?
  @include_map = include_map.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::IEMapProperty.new(**include_map.transform_keys(&:to_sym)) : include_map
  Jsii::Type.check_type(@include_map, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LklFTWFwUHJvcGVydHkifV19fQ==")), "includeMap") unless @include_map.nil?
  @policy_description = policy_description
  Jsii::Type.check_type(@policy_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyDescription") unless @policy_description.nil?
  @resources_clean_up = resources_clean_up
  Jsii::Type.check_type(@resources_clean_up, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "resourcesCleanUp") unless @resources_clean_up.nil?
  @resource_set_ids = resource_set_ids
  Jsii::Type.check_type(@resource_set_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceSetIds") unless @resource_set_ids.nil?
  @resource_tag_logical_operator = resource_tag_logical_operator
  Jsii::Type.check_type(@resource_tag_logical_operator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceTagLogicalOperator") unless @resource_tag_logical_operator.nil?
  @resource_tags = resource_tags
  Jsii::Type.check_type(@resource_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZm1zLkNmblBvbGljeS5SZXNvdXJjZVRhZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "resourceTags") unless @resource_tags.nil?
  @resource_type = resource_type
  Jsii::Type.check_type(@resource_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceType") unless @resource_type.nil?
  @resource_type_list = resource_type_list
  Jsii::Type.check_type(@resource_type_list, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceTypeList") unless @resource_type_list.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::FMS::CfnPolicy::PolicyTagProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19mbXMuQ2ZuUG9saWN5LlBvbGljeVRhZ1Byb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "tags") unless @tags.nil?
end

Instance Attribute Details

#delete_all_policy_resources ⇒ Boolean, ... (readonly)

Used when deleting a policy. If true , Firewall Manager performs cleanup according to the policy type.

For AWS WAF and Shield Advanced policies, Firewall Manager does the following:

  • Deletes rule groups created by Firewall Manager
  • Removes web ACLs from in-scope resources
  • Deletes web ACLs that contain no rules or rule groups

For security group policies, Firewall Manager does the following for each security group in the policy:

  • Disassociates the security group from in-scope resources
  • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

Returns:

See Also:



197
198
199
 
# File 'fms/cfn_policy_props.rb', line 197

def delete_all_policy_resources
  @delete_all_policy_resources
end

#exclude_map ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the AWS account IDs and AWS 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 , AWS 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 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”]} .

Returns:

See Also:



212
213
214
 
# File 'fms/cfn_policy_props.rb', line 212

def exclude_map
  @exclude_map
end

#exclude_resource_tags ⇒ Boolean, AWSCDK::IResolvable (readonly)

Used only when tags are specified in the ResourceTags property.

If this property is True , resources with the specified tags are not in scope of the policy. If it's False , only resources with the specified tags are in scope of the policy.

Returns:

See Also:



63
64
65
 
# File 'fms/cfn_policy_props.rb', line 63

def exclude_resource_tags
  @exclude_resource_tags
end

#include_map ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the AWS account IDs and AWS 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 , AWS 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 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”]} .

Returns:

See Also:



227
228
229
 
# File 'fms/cfn_policy_props.rb', line 227

def include_map
  @include_map
end

#policy_description ⇒ String? (readonly)

Your description of the AWS Firewall Manager policy.

Returns:

  • (String, nil)

See Also:



232
233
234
 
# File 'fms/cfn_policy_props.rb', line 232

def policy_description
  @policy_description
end

#policy_name ⇒ String (readonly)

The name of the AWS Firewall Manager policy.

Returns:

  • (String)

See Also:



68
69
70
 
# File 'fms/cfn_policy_props.rb', line 68

def policy_name
  @policy_name
end

#remediation_enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

Indicates if the policy should be automatically applied to new resources.

Returns:

See Also:



73
74
75
 
# File 'fms/cfn_policy_props.rb', line 73

def remediation_enabled
  @remediation_enabled
end

#resource_set_ids ⇒ Array<String>? (readonly)

The unique identifiers of the resource sets used by the policy.

Returns:

  • (Array<String>, nil)

See Also:



248
249
250
 
# File 'fms/cfn_policy_props.rb', line 248

def resource_set_ids
  @resource_set_ids
end

#resource_tag_logical_operator ⇒ String? (readonly)

Specifies whether to combine multiple resource tags with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag.

Default: AND

Returns:

  • (String, nil)

See Also:



255
256
257
 
# File 'fms/cfn_policy_props.rb', line 255

def resource_tag_logical_operator
  @resource_tag_logical_operator
end

#resource_tags ⇒ AWSCDK::IResolvable, ... (readonly)

An array of ResourceTag objects, used to explicitly include resources in the policy scope or explicitly exclude them.

If this isn't set, then tags aren't used to modify policy scope. See also ExcludeResourceTags .

Returns:

See Also:



262
263
264
 
# File 'fms/cfn_policy_props.rb', line 262

def resource_tags
  @resource_tags
end

#resource_type ⇒ String? (readonly)

The type of resource protected by or in scope of the policy.

This is in the format shown in the AWS Resource Types Reference . To apply this policy to multiple resource types, specify a resource type of ResourceTypeList and then specify the resource types in a ResourceTypeList .

The following are valid resource types for each Firewall Manager policy type:

  • AWS WAF Classic - AWS::ApiGateway::Stage , AWS::CloudFront::Distribution , and AWS::ElasticLoadBalancingV2::LoadBalancer .
  • AWS WAF - AWS::ApiGateway::Stage , AWS::ElasticLoadBalancingV2::LoadBalancer , and AWS::CloudFront::Distribution .
  • Shield Advanced - AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::ElasticLoadBalancing::LoadBalancer , AWS::EC2::EIP , and AWS::CloudFront::Distribution .
  • Network ACL - AWS::EC2::Subnet .
  • Security group usage audit - AWS::EC2::SecurityGroup .
  • Security group content audit - AWS::EC2::SecurityGroup , AWS::EC2::NetworkInterface , and AWS::EC2::Instance .
  • DNS Firewall, AWS Network Firewall , and third-party firewall - AWS::EC2::VPC .

Returns:

  • (String, nil)

See Also:



279
280
281
 
# File 'fms/cfn_policy_props.rb', line 279

def resource_type
  @resource_type
end

#resource_type_list ⇒ Array<String>? (readonly)

An array of ResourceType objects.

Use this only to specify multiple resource types. To specify a single resource type, use ResourceType .

Returns:

  • (Array<String>, nil)

See Also:



286
287
288
 
# File 'fms/cfn_policy_props.rb', line 286

def resource_type_list
  @resource_type_list
end

#resources_clean_up ⇒ Boolean, ... (readonly)

Indicates whether AWS 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 AWS WAF Classic policies.

Returns:

See Also:



243
244
245
 
# File 'fms/cfn_policy_props.rb', line 243

def resources_clean_up
  @resources_clean_up
end

#security_service_policy_data ⇒ AWSCDK::IResolvable, AWSCDK::FMS::CfnPolicy::SecurityServicePolicyDataProperty (readonly)

Details about the security service that is being used to protect the resources.

This contains the following settings:

  • Type - Indicates the service type that the policy uses to protect the resource. 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 .

Valid values: DNS_FIREWALL | NETWORK_FIREWALL | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | SHIELD_ADVANCED | THIRD_PARTY_FIREWALL | WAFV2 | WAF

  • ManagedServiceData - Details about the service that are specific to the service type, in JSON format.
  • Example: DNS_FIREWALL

"{\"type\":\"DNS_FIREWALL\",\"preProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-1\",\"priority\":10}],\"postProcessRuleGroups\":[{\"ruleGroupId\":\"rslvr-frg-2\",\"priority\":9911}]}"

Valid values for pre_process_rule_groups are between 1 and 99. Valid values for post_process_rule_groups 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 firewall_creation_config . To configure the Availability Zones in firewall_creation_config , specify either the availability_zone_name or availability_zone_id parameter, 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_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 automatic_response_status is IGNORED . The value for automatic_response_action is only required when automatic_response_status is set to ENABLED . The default value for override_customer_webacl_classic 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 logging_configuration , you can specify one log_destination_configs , you can optionally provide up to 20 redacted_fields , and the RedactedFieldType must be one of URI , QUERY_STRING , HEADER , or METHOD .

  • 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 version_enabled to true , and set version to the version you'd like to use. If you don't set version_enabled to true , or if you omit version_enabled , 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 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}"

Returns:

See Also:



179
180
181
 
# File 'fms/cfn_policy_props.rb', line 179

def security_service_policy_data
  @security_service_policy_data
end

#tags ⇒ Array<AWSCDK::FMS::CfnPolicy::PolicyTagProperty>? (readonly)

A 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.

Returns:

See Also:



293
294
295
 
# File 'fms/cfn_policy_props.rb', line 293

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'fms/cfn_policy_props.rb', line 295

def self.jsii_properties
  {
    :exclude_resource_tags => "excludeResourceTags",
    :policy_name => "policyName",
    :remediation_enabled => "remediationEnabled",
    :security_service_policy_data => "securityServicePolicyData",
    :delete_all_policy_resources => "deleteAllPolicyResources",
    :exclude_map => "excludeMap",
    :include_map => "includeMap",
    :policy_description => "policyDescription",
    :resources_clean_up => "resourcesCleanUp",
    :resource_set_ids => "resourceSetIds",
    :resource_tag_logical_operator => "resourceTagLogicalOperator",
    :resource_tags => "resourceTags",
    :resource_type => "resourceType",
    :resource_type_list => "resourceTypeList",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'fms/cfn_policy_props.rb', line 315

def to_jsii
  result = {}
  result.merge!({
    "excludeResourceTags" => @exclude_resource_tags,
    "policyName" => @policy_name,
    "remediationEnabled" => @remediation_enabled,
    "securityServicePolicyData" => @security_service_policy_data,
    "deleteAllPolicyResources" => @delete_all_policy_resources,
    "excludeMap" => @exclude_map,
    "includeMap" => @include_map,
    "policyDescription" => @policy_description,
    "resourcesCleanUp" => @resources_clean_up,
    "resourceSetIds" => @resource_set_ids,
    "resourceTagLogicalOperator" => @resource_tag_logical_operator,
    "resourceTags" => @resource_tags,
    "resourceType" => @resource_type,
    "resourceTypeList" => @resource_type_list,
    "tags" => @tags,
  })
  result.compact
end