{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/core": "1.204.0" }, "dependencyClosure": { "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::NetworkFirewall", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::NetworkFirewall", "aws-networkfirewall" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-networkfirewall", "readme": { "markdown": "# AWS::NetworkFirewall Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n```ts nofixture\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\n```\n\n\n\nThere are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:\n\n- Search [Construct Hub for NetworkFirewall construct libraries](https://constructs.dev/search?q=networkfirewall)\n- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::NetworkFirewall resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_NetworkFirewall.html) directly.\n\n\n\n\nThere are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.\nHowever, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.\n\nFor more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::NetworkFirewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_NetworkFirewall.html).\n\n(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)\n\n\n" }, "repository": { "directory": "packages/@aws-cdk/aws-networkfirewall", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.NetworkFirewall", "packageId": "Amazon.CDK.AWS.NetworkFirewall" }, "java": { "maven": { "artifactId": "networkfirewall", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.networkfirewall" }, "js": { "npm": "@aws-cdk/aws-networkfirewall" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-networkfirewall", "module": "aws_cdk.aws_networkfirewall" } }, "types": { "@aws-cdk/aws-networkfirewall.CfnFirewall": { "assembly": "@aws-cdk/aws-networkfirewall", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::NetworkFirewall::Firewall", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Use the `Firewall` to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC .\n\nThe firewall defines the configuration settings for an AWS Network Firewall firewall. The settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.", "stability": "external", "summary": "A CloudFormation `AWS::NetworkFirewall::Firewall`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnFirewall = new networkfirewall.CfnFirewall(this, 'MyCfnFirewall', {\n firewallName: 'firewallName',\n firewallPolicyArn: 'firewallPolicyArn',\n subnetMappings: [{\n subnetId: 'subnetId',\n\n // the properties below are optional\n ipAddressType: 'ipAddressType',\n }],\n vpcId: 'vpcId',\n\n // the properties below are optional\n deleteProtection: false,\n description: 'description',\n firewallPolicyChangeProtection: false,\n subnetChangeProtection: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewall", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::NetworkFirewall::Firewall`." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 291 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 174 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 318 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 337 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnFirewall", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 178 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "EndpointIds" }, "remarks": "The subnets are not listed in any particular order. For example: `[\"us-west-2c:vpce-111122223333\", \"us-west-2a:vpce-987654321098\", \"us-west-2b:vpce-012345678901\"]` .", "stability": "external", "summary": "The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 203 }, "name": "attrEndpointIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "cloudformationAttribute": "FirewallArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `Firewall` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 209 }, "name": "attrFirewallArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "FirewallId" }, "stability": "external", "summary": "The name of the `Firewall` resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 215 }, "name": "attrFirewallId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 323 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 282 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallname" }, "remarks": "You can't change the name of a firewall after you create it.", "stability": "external", "summary": "The descriptive name of the firewall." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 222 }, "name": "firewallName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicyarn" }, "remarks": "The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the firewall policy." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 231 }, "name": "firewallPolicyArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetmappings" }, "remarks": "Each subnet must belong to a different Availability Zone.", "stability": "external", "summary": "The public subnets that Network Firewall is using for the firewall." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 238 }, "name": "subnetMappings", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewall.SubnetMappingProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-vpcid" }, "remarks": "You can't change the VPC of a firewall after you create the firewall.", "stability": "external", "summary": "The unique identifier of the VPC where the firewall is in use." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 245 }, "name": "vpcId", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-deleteprotection" }, "remarks": "A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE` .", "stability": "external", "summary": "A flag indicating whether it is possible to delete the firewall." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 252 }, "name": "deleteProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-description" }, "stability": "external", "summary": "A description of the firewall." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 259 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicychangeprotection" }, "remarks": "Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .", "stability": "external", "summary": "A setting indicating whether the firewall is protected against a change to the firewall policy association." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 266 }, "name": "firewallPolicyChangeProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetchangeprotection" }, "remarks": "Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .", "stability": "external", "summary": "A setting indicating whether the firewall is protected against changes to the subnet associations." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 273 }, "name": "subnetChangeProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewall" }, "@aws-cdk/aws-networkfirewall.CfnFirewall.SubnetMappingProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html", "exampleMetadata": "fixture=_generated" }, "remarks": "AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.", "stability": "external", "summary": "The ID for a subnet that you want to associate with the firewall.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst subnetMappingProperty: networkfirewall.CfnFirewall.SubnetMappingProperty = {\n subnetId: 'subnetId',\n\n // the properties below are optional\n ipAddressType: 'ipAddressType',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewall.SubnetMappingProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 351 }, "name": "SubnetMappingProperty", "namespace": "CfnFirewall", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-subnetid" }, "stability": "external", "summary": "The unique identifier for the subnet." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 363 }, "name": "subnetId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-ipaddresstype" }, "remarks": "You can't change the IP address type after you create the subnet.", "stability": "external", "summary": "The subnet's IP address type." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 357 }, "name": "ipAddressType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewall.SubnetMappingProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy": { "assembly": "@aws-cdk/aws-networkfirewall", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::NetworkFirewall::FirewallPolicy", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Use the `FirewallPolicy` to define the stateless and stateful network traffic filtering behavior for your `Firewall` . You can use one firewall policy for multiple firewalls.", "stability": "external", "summary": "A CloudFormation `AWS::NetworkFirewall::FirewallPolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnFirewallPolicy = new networkfirewall.CfnFirewallPolicy(this, 'MyCfnFirewallPolicy', {\n firewallPolicy: {\n statelessDefaultActions: ['statelessDefaultActions'],\n statelessFragmentDefaultActions: ['statelessFragmentDefaultActions'],\n\n // the properties below are optional\n policyVariables: {\n ruleVariables: {\n ruleVariablesKey: {\n definition: ['definition'],\n },\n },\n },\n statefulDefaultActions: ['statefulDefaultActions'],\n statefulEngineOptions: {\n ruleOrder: 'ruleOrder',\n streamExceptionPolicy: 'streamExceptionPolicy',\n },\n statefulRuleGroupReferences: [{\n resourceArn: 'resourceArn',\n\n // the properties below are optional\n override: {\n action: 'action',\n },\n priority: 123,\n }],\n statelessCustomActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n statelessRuleGroupReferences: [{\n priority: 123,\n resourceArn: 'resourceArn',\n }],\n },\n firewallPolicyName: 'firewallPolicyName',\n\n // the properties below are optional\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::NetworkFirewall::FirewallPolicy`." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 600 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 526 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 619 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 633 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnFirewallPolicy", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 530 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "FirewallPolicyArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `FirewallPolicy` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 555 }, "name": "attrFirewallPolicyArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "FirewallPolicyId" }, "stability": "external", "summary": "The unique ID of the `FirewallPolicy` resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 561 }, "name": "attrFirewallPolicyId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 624 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 591 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy" }, "stability": "external", "summary": "The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 568 }, "name": "firewallPolicy", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname" }, "remarks": "You can't change the name of a firewall policy after you create it.", "stability": "external", "summary": "The descriptive name of the firewall policy." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 575 }, "name": "firewallPolicyName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description" }, "stability": "external", "summary": "A description of the firewall policy." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 582 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.ActionDefinitionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A custom action to use in stateless rule actions settings.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst actionDefinitionProperty: networkfirewall.CfnFirewallPolicy.ActionDefinitionProperty = {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.ActionDefinitionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 647 }, "name": "ActionDefinitionProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction" }, "remarks": "This setting defines a CloudWatch dimension value to be published.\n\nYou can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.", "stability": "external", "summary": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 655 }, "name": "publishMetricAction", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PublishMetricActionProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.ActionDefinitionProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.CustomActionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You can define this in addition to the standard action that you must specify.\n\nYou define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.\n\nYou can use custom actions in the following places:\n\n- In an `RuleGroup.StatelessRulesAndCustomActions` . The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.\n- In an `FirewallPolicy` specification, in `StatelessCustomActions` . The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.", "stability": "external", "summary": "An optional, non-standard action to use for stateless packet handling.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst customActionProperty: networkfirewall.CfnFirewallPolicy.CustomActionProperty = {\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.CustomActionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 723 }, "name": "CustomActionProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition" }, "stability": "external", "summary": "The custom action associated with the action name." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 729 }, "name": "actionDefinition", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.ActionDefinitionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actionname" }, "remarks": "You can't change the name of a custom action after you create it.", "stability": "external", "summary": "The descriptive name of the custom action." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 735 }, "name": "actionName", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.CustomActionProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.DimensionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.\n\nAWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value.\n\nFor more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) .", "stability": "external", "summary": "The value to use in an Amazon CloudWatch custom metric dimension.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst dimensionProperty: networkfirewall.CfnFirewallPolicy.DimensionProperty = {\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.DimensionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 805 }, "name": "DimensionProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html#cfn-networkfirewall-firewallpolicy-dimension-value" }, "stability": "external", "summary": "The value to use in the custom metric dimension." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 811 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.DimensionProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst firewallPolicyProperty: networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty = {\n statelessDefaultActions: ['statelessDefaultActions'],\n statelessFragmentDefaultActions: ['statelessFragmentDefaultActions'],\n\n // the properties below are optional\n policyVariables: {\n ruleVariables: {\n ruleVariablesKey: {\n definition: ['definition'],\n },\n },\n },\n statefulDefaultActions: ['statefulDefaultActions'],\n statefulEngineOptions: {\n ruleOrder: 'ruleOrder',\n streamExceptionPolicy: 'streamExceptionPolicy',\n },\n statefulRuleGroupReferences: [{\n resourceArn: 'resourceArn',\n\n // the properties below are optional\n override: {\n action: 'action',\n },\n priority: 123,\n }],\n statelessCustomActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n statelessRuleGroupReferences: [{\n priority: 123,\n resourceArn: 'resourceArn',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 873 }, "name": "FirewallPolicyProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions" }, "remarks": "If you want non-matching packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` .\n\nYou must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice.\n\nFor example, you could specify `[\"aws:pass\"]` or you could specify `[\"aws:pass\", “customActionName”]` . For information about compatibility, see the custom action descriptions.", "stability": "external", "summary": "The actions to take on a packet if it doesn't match any of the stateless rules in the policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 922 }, "name": "statelessDefaultActions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions" }, "remarks": "If you want non-matching fragmented packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` .\n\nYou must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice.\n\nFor example, you could specify `[\"aws:pass\"]` or you could specify `[\"aws:pass\", “customActionName”]` . For information about compatibility, see the custom action descriptions.", "stability": "external", "summary": "The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 932 }, "name": "statelessFragmentDefaultActions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables" }, "stability": "external", "summary": "Contains variables that you can use to override default Suricata settings in your firewall policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 879 }, "name": "policyVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PolicyVariablesProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions" }, "remarks": "The stateful default action is optional, and is only valid when using the strict rule order.\n\nValid values of the stateful default action:\n\n- aws:drop_strict\n- aws:drop_established\n- aws:alert_strict\n- aws:alert_established\n\nFor more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* .", "stability": "external", "summary": "The default actions to take on a packet that doesn't match any stateful rules." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 894 }, "name": "statefulDefaultActions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions" }, "remarks": "The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.", "stability": "external", "summary": "Additional options governing how Network Firewall handles stateful rules." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 900 }, "name": "statefulEngineOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulEngineOptionsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences" }, "remarks": "These define the inspection criteria in stateful rules.", "stability": "external", "summary": "References to the stateful rule groups that are used in the policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 906 }, "name": "statefulRuleGroupReferences", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions" }, "remarks": "You name each custom action that you define, and then you can use it by name in your default actions specifications.", "stability": "external", "summary": "The custom action definitions that are available for use in the firewall policy's `StatelessDefaultActions` setting." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 912 }, "name": "statelessCustomActions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.CustomActionProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences" }, "remarks": "These define the matching criteria in stateless rules.", "stability": "external", "summary": "References to the stateless rule groups that are used in the policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 938 }, "name": "statelessRuleGroupReferences", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatelessRuleGroupReferenceProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.FirewallPolicyProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.IPSetProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is part of a `RuleVariables` .", "stability": "external", "summary": "A list of IP addresses and address ranges, in CIDR notation.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst iPSetProperty: networkfirewall.CfnFirewallPolicy.IPSetProperty = {\n definition: ['definition'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.IPSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1022 }, "name": "IPSetProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html#cfn-networkfirewall-firewallpolicy-ipset-definition" }, "stability": "external", "summary": "The list of IP addresses and address ranges, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1028 }, "name": "definition", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.IPSetProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PolicyVariablesProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-policyvariables.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Contains variables that you can use to override default Suricata settings in your firewall policy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst policyVariablesProperty: networkfirewall.CfnFirewallPolicy.PolicyVariablesProperty = {\n ruleVariables: {\n ruleVariablesKey: {\n definition: ['definition'],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PolicyVariablesProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1089 }, "name": "PolicyVariablesProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-policyvariables.html#cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables" }, "remarks": "If your firewall uses an inspection VPC, you might want to override the `HOME_NET` variable with the CIDRs of your home networks. If you don't override `HOME_NET` with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.", "stability": "external", "summary": "The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata `HOME_NET` variable." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1095 }, "name": "ruleVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.IPSetProperty" } ] } }, "kind": "map" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.PolicyVariablesProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PublishMetricActionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This setting defines a CloudWatch dimension value to be published.", "stability": "external", "summary": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst publishMetricActionProperty: networkfirewall.CfnFirewallPolicy.PublishMetricActionProperty = {\n dimensions: [{\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.PublishMetricActionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1156 }, "name": "PublishMetricActionProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions" }, "stability": "external", "summary": "`CfnFirewallPolicy.PublishMetricActionProperty.Dimensions`." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1162 }, "name": "dimensions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.DimensionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.PublishMetricActionProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulEngineOptionsProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Configuration settings for the handling of the stateful rule groups in a firewall policy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statefulEngineOptionsProperty: networkfirewall.CfnFirewallPolicy.StatefulEngineOptionsProperty = {\n ruleOrder: 'ruleOrder',\n streamExceptionPolicy: 'streamExceptionPolicy',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulEngineOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1224 }, "name": "StatefulEngineOptionsProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder" }, "remarks": "`DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* .", "stability": "external", "summary": "Indicates how to manage the order of stateful rule evaluation for the policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1230 }, "name": "ruleOrder", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy" }, "remarks": "Network connections can break due to disruptions in external networks or within the firewall itself.\n\n- `DROP` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.\n- `CONTINUE` - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action.\n- `REJECT` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.", "stability": "external", "summary": "Configures how Network Firewall processes traffic when a network connection breaks midstream." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1240 }, "name": "streamExceptionPolicy", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.StatefulEngineOptionsProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupOverrideProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The setting that allows the policy owner to change the behavior of the rule group within a policy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statefulRuleGroupOverrideProperty: networkfirewall.CfnFirewallPolicy.StatefulRuleGroupOverrideProperty = {\n action: 'action',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupOverrideProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1304 }, "name": "StatefulRuleGroupOverrideProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action" }, "remarks": "This only applies to managed rule groups.", "stability": "external", "summary": "The action that changes the rule group from `DROP` to `ALERT` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1310 }, "name": "action", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.StatefulRuleGroupOverrideProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statefulRuleGroupReferenceProperty: networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty = {\n resourceArn: 'resourceArn',\n\n // the properties below are optional\n override: {\n action: 'action',\n },\n priority: 123,\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1371 }, "name": "StatefulRuleGroupReferenceProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the stateful rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1393 }, "name": "resourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override" }, "stability": "external", "summary": "The action that allows the policy owner to override the behavior of the rule group within a policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1377 }, "name": "override", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatefulRuleGroupOverrideProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority" }, "remarks": "This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings.\n\nNetwork Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.\n\nYou can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.", "stability": "external", "summary": "An integer setting that indicates the order in which to run the stateful rule groups in a single `FirewallPolicy` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1387 }, "name": "priority", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.StatefulRuleGroupReferenceProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatelessRuleGroupReferenceProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statelessRuleGroupReferenceProperty: networkfirewall.CfnFirewallPolicy.StatelessRuleGroupReferenceProperty = {\n priority: 123,\n resourceArn: 'resourceArn',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.StatelessRuleGroupReferenceProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1461 }, "name": "StatelessRuleGroupReferenceProperty", "namespace": "CfnFirewallPolicy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority" }, "remarks": "Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.", "stability": "external", "summary": "An integer setting that indicates the order in which to run the stateless rule groups in a single `FirewallPolicy` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1467 }, "name": "priority", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the stateless rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1473 }, "name": "resourceArn", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicy.StatelessRuleGroupReferenceProperty" }, "@aws-cdk/aws-networkfirewall.CfnFirewallPolicyProps": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnFirewallPolicy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnFirewallPolicyProps: networkfirewall.CfnFirewallPolicyProps = {\n firewallPolicy: {\n statelessDefaultActions: ['statelessDefaultActions'],\n statelessFragmentDefaultActions: ['statelessFragmentDefaultActions'],\n\n // the properties below are optional\n policyVariables: {\n ruleVariables: {\n ruleVariablesKey: {\n definition: ['definition'],\n },\n },\n },\n statefulDefaultActions: ['statefulDefaultActions'],\n statefulEngineOptions: {\n ruleOrder: 'ruleOrder',\n streamExceptionPolicy: 'streamExceptionPolicy',\n },\n statefulRuleGroupReferences: [{\n resourceArn: 'resourceArn',\n\n // the properties below are optional\n override: {\n action: 'action',\n },\n priority: 123,\n }],\n statelessCustomActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n statelessRuleGroupReferences: [{\n priority: 123,\n resourceArn: 'resourceArn',\n }],\n },\n firewallPolicyName: 'firewallPolicyName',\n\n // the properties below are optional\n description: 'description',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicyProps", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 427 }, "name": "CfnFirewallPolicyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy" }, "stability": "external", "summary": "The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 434 }, "name": "firewallPolicy", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname" }, "remarks": "You can't change the name of a firewall policy after you create it.", "stability": "external", "summary": "The descriptive name of the firewall policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 441 }, "name": "firewallPolicyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description" }, "stability": "external", "summary": "A description of the firewall policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 448 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 457 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallPolicyProps" }, "@aws-cdk/aws-networkfirewall.CfnFirewallProps": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnFirewall`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnFirewallProps: networkfirewall.CfnFirewallProps = {\n firewallName: 'firewallName',\n firewallPolicyArn: 'firewallPolicyArn',\n subnetMappings: [{\n subnetId: 'subnetId',\n\n // the properties below are optional\n ipAddressType: 'ipAddressType',\n }],\n vpcId: 'vpcId',\n\n // the properties below are optional\n deleteProtection: false,\n description: 'description',\n firewallPolicyChangeProtection: false,\n subnetChangeProtection: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewallProps", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 19 }, "name": "CfnFirewallProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallname" }, "remarks": "You can't change the name of a firewall after you create it.", "stability": "external", "summary": "The descriptive name of the firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 26 }, "name": "firewallName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicyarn" }, "remarks": "The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the firewall policy." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 35 }, "name": "firewallPolicyArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetmappings" }, "remarks": "Each subnet must belong to a different Availability Zone.", "stability": "external", "summary": "The public subnets that Network Firewall is using for the firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 42 }, "name": "subnetMappings", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-networkfirewall.CfnFirewall.SubnetMappingProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-vpcid" }, "remarks": "You can't change the VPC of a firewall after you create the firewall.", "stability": "external", "summary": "The unique identifier of the VPC where the firewall is in use." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 49 }, "name": "vpcId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-deleteprotection" }, "remarks": "A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE` .", "stability": "external", "summary": "A flag indicating whether it is possible to delete the firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 56 }, "name": "deleteProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-description" }, "stability": "external", "summary": "A description of the firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 63 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicychangeprotection" }, "remarks": "Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .", "stability": "external", "summary": "A setting indicating whether the firewall is protected against a change to the firewall policy association." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 70 }, "name": "firewallPolicyChangeProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetchangeprotection" }, "remarks": "Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` .", "stability": "external", "summary": "A setting indicating whether the firewall is protected against changes to the subnet associations." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 77 }, "name": "subnetChangeProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 86 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnFirewallProps" }, "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration": { "assembly": "@aws-cdk/aws-networkfirewall", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::NetworkFirewall::LoggingConfiguration", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Use the `LoggingConfiguration` to define the destinations and logging options for an `Firewall` .\n\nYou must change the logging configuration by changing one `LogDestinationConfig` setting at a time in your `LogDestinationConfigs` .\n\nYou can make only one of the following changes to your `LoggingConfiguration` resource:\n\n- Create a new log destination object by adding a single `LogDestinationConfig` array element to `LogDestinationConfigs` .\n- Delete a log destination object by removing a single `LogDestinationConfig` array element from `LogDestinationConfigs` .\n- Change the `LogDestination` setting in a single `LogDestinationConfig` array element.\n\nYou can't change the `LogDestinationType` or `LogType` in a `LogDestinationConfig` . To change these settings, delete the existing `LogDestinationConfig` object and create a new one, in two separate modifications.", "stability": "external", "summary": "A CloudFormation `AWS::NetworkFirewall::LoggingConfiguration`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnLoggingConfiguration = new networkfirewall.CfnLoggingConfiguration(this, 'MyCfnLoggingConfiguration', {\n firewallArn: 'firewallArn',\n loggingConfiguration: {\n logDestinationConfigs: [{\n logDestination: {\n logDestinationKey: 'logDestination',\n },\n logDestinationType: 'logDestinationType',\n logType: 'logType',\n }],\n },\n\n // the properties below are optional\n firewallName: 'firewallName',\n});" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::NetworkFirewall::LoggingConfiguration`." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1688 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfigurationProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1635 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1704 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1717 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLoggingConfiguration", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1639 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1709 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallarn" }, "remarks": "You can't change the firewall specification after you create the logging configuration.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1665 }, "name": "firewallArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration" }, "stability": "external", "summary": "Defines how AWS Network Firewall performs logging for a `Firewall` ." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1672 }, "name": "loggingConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LoggingConfigurationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallname" }, "remarks": "You can't change the firewall specification after you create the logging configuration.", "stability": "external", "summary": "The name of the firewall that the logging configuration is associated with." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1679 }, "name": "firewallName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnLoggingConfiguration" }, "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LogDestinationConfigProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used in `LoggingConfiguration` . You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.\n\nNetwork Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to `DROP` or `ALERT` .", "stability": "external", "summary": "Defines where AWS Network Firewall sends logs for the firewall for one log type.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst logDestinationConfigProperty: networkfirewall.CfnLoggingConfiguration.LogDestinationConfigProperty = {\n logDestination: {\n logDestinationKey: 'logDestination',\n },\n logDestinationType: 'logDestinationType',\n logType: 'logType',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LogDestinationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1733 }, "name": "LogDestinationConfigProperty", "namespace": "CfnLoggingConfiguration", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestination" }, "remarks": "- For an Amazon S3 bucket, provide the name of the bucket, with key `bucketName` , and optionally provide a prefix, with key `prefix` . The following example specifies an Amazon S3 bucket named `DOC-EXAMPLE-BUCKET` and the prefix `alerts` :\n\n`\"LogDestination\": { \"bucketName\": \"DOC-EXAMPLE-BUCKET\", \"prefix\": \"alerts\" }`\n- For a CloudWatch log group, provide the name of the CloudWatch log group, with key `logGroup` . The following example specifies a log group named `alert-log-group` :\n\n`\"LogDestination\": { \"logGroup\": \"alert-log-group\" }`\n- For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key `deliveryStream` . The following example specifies a delivery stream named `alert-delivery-stream` :\n\n`\"LogDestination\": { \"deliveryStream\": \"alert-delivery-stream\" }`", "stability": "external", "summary": "The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1749 }, "name": "logDestination", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestinationtype" }, "remarks": "You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.", "stability": "external", "summary": "The type of storage destination to send these logs to." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1755 }, "name": "logDestinationType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logtype" }, "remarks": "Alert logs report traffic that matches a stateful rule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs.", "stability": "external", "summary": "The type of log to send." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1761 }, "name": "logType", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnLoggingConfiguration.LogDestinationConfigProperty" }, "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LoggingConfigurationProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Defines how AWS Network Firewall performs logging for a `Firewall` .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst loggingConfigurationProperty: networkfirewall.CfnLoggingConfiguration.LoggingConfigurationProperty = {\n logDestinationConfigs: [{\n logDestination: {\n logDestinationKey: 'logDestination',\n },\n logDestinationType: 'logDestinationType',\n logType: 'logType',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LoggingConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1831 }, "name": "LoggingConfigurationProperty", "namespace": "CfnLoggingConfiguration", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration-logdestinationconfigs" }, "remarks": "Network Firewall generates logs for stateful rule groups.", "stability": "external", "summary": "Defines the logging destinations for the logs for a firewall." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1837 }, "name": "logDestinationConfigs", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LogDestinationConfigProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnLoggingConfiguration.LoggingConfigurationProperty" }, "@aws-cdk/aws-networkfirewall.CfnLoggingConfigurationProps": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnLoggingConfiguration`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnLoggingConfigurationProps: networkfirewall.CfnLoggingConfigurationProps = {\n firewallArn: 'firewallArn',\n loggingConfiguration: {\n logDestinationConfigs: [{\n logDestination: {\n logDestinationKey: 'logDestination',\n },\n logDestinationType: 'logDestinationType',\n logType: 'logType',\n }],\n },\n\n // the properties below are optional\n firewallName: 'firewallName',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfigurationProps", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1538 }, "name": "CfnLoggingConfigurationProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallarn" }, "remarks": "You can't change the firewall specification after you create the logging configuration.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1545 }, "name": "firewallArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration" }, "stability": "external", "summary": "Defines how AWS Network Firewall performs logging for a `Firewall` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1552 }, "name": "loggingConfiguration", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnLoggingConfiguration.LoggingConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallname" }, "remarks": "You can't change the firewall specification after you create the logging configuration.", "stability": "external", "summary": "The name of the firewall that the logging configuration is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1559 }, "name": "firewallName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnLoggingConfigurationProps" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup": { "assembly": "@aws-cdk/aws-networkfirewall", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::NetworkFirewall::RuleGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Use the `RuleGroup` to define a reusable collection of stateless or stateful network traffic filtering rules. You use rule groups in an `FirewallPolicy` to specify the filtering behavior of an `Firewall` .", "stability": "external", "summary": "A CloudFormation `AWS::NetworkFirewall::RuleGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnRuleGroup = new networkfirewall.CfnRuleGroup(this, 'MyCfnRuleGroup', {\n capacity: 123,\n ruleGroupName: 'ruleGroupName',\n type: 'type',\n\n // the properties below are optional\n description: 'description',\n ruleGroup: {\n rulesSource: {\n rulesSourceList: {\n generatedRulesType: 'generatedRulesType',\n targets: ['targets'],\n targetTypes: ['targetTypes'],\n },\n rulesString: 'rulesString',\n statefulRules: [{\n action: 'action',\n header: {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n },\n ruleOptions: [{\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n }],\n }],\n statelessRulesAndCustomActions: {\n statelessRules: [{\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n }],\n\n // the properties below are optional\n customActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n },\n },\n\n // the properties below are optional\n referenceSets: {\n ipSetReferences: {\n ipSetReferencesKey: {\n referenceArn: 'referenceArn',\n },\n },\n },\n ruleVariables: {\n ipSets: {\n ipSetsKey: {\n definition: ['definition'],\n },\n },\n portSets: {\n portSetsKey: {\n definition: ['definition'],\n },\n },\n },\n statefulRuleOptions: {\n ruleOrder: 'ruleOrder',\n },\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::NetworkFirewall::RuleGroup`." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2108 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2019 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2130 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2146 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnRuleGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2023 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RuleGroupArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the `RuleGroup` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2048 }, "name": "attrRuleGroupArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "RuleGroupId" }, "stability": "external", "summary": "The unique ID of the `RuleGroup` resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2054 }, "name": "attrRuleGroupId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2135 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2099 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity" }, "remarks": "You can't change a rule group's capacity setting after you create the rule group. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.", "stability": "external", "summary": "The maximum operating resources that this rule group can use." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2061 }, "name": "capacity", "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname" }, "remarks": "You can't change the name of a rule group after you create it.", "stability": "external", "summary": "The descriptive name of the rule group." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2068 }, "name": "ruleGroupName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type" }, "remarks": "If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules.", "stability": "external", "summary": "Indicates whether the rule group is stateless or stateful." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2076 }, "name": "type", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-description" }, "stability": "external", "summary": "A description of the rule group." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2083 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup" }, "stability": "external", "summary": "An object that defines the rule group rules." }, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2090 }, "name": "ruleGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleGroupProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ActionDefinitionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A custom action to use in stateless rule actions settings.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst actionDefinitionProperty: networkfirewall.CfnRuleGroup.ActionDefinitionProperty = {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ActionDefinitionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2160 }, "name": "ActionDefinitionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html#cfn-networkfirewall-rulegroup-actiondefinition-publishmetricaction" }, "remarks": "This setting defines a CloudWatch dimension value to be published.\n\nYou can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.", "stability": "external", "summary": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2168 }, "name": "publishMetricAction", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PublishMetricActionProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.ActionDefinitionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.AddressProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used in the `RuleGroup.MatchAttributes` source and destination specifications.", "stability": "external", "summary": "A single IP address specification.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst addressProperty: networkfirewall.CfnRuleGroup.AddressProperty = {\n addressDefinition: 'addressDefinition',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.AddressProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2229 }, "name": "AddressProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html#cfn-networkfirewall-rulegroup-address-addressdefinition" }, "remarks": "Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .", "stability": "external", "summary": "Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2244 }, "name": "addressDefinition", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.AddressProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.CustomActionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You can define this in addition to the standard action that you must specify.\n\nYou define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.\n\nYou can use custom actions in the following places:\n\n- In an `RuleGroup.StatelessRulesAndCustomActions` . The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes.\n- In an `FirewallPolicy` specification, in `StatelessCustomActions` . The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.", "stability": "external", "summary": "An optional, non-standard action to use for stateless packet handling.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst customActionProperty: networkfirewall.CfnRuleGroup.CustomActionProperty = {\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.CustomActionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2313 }, "name": "CustomActionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actiondefinition" }, "stability": "external", "summary": "The custom action associated with the action name." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2319 }, "name": "actionDefinition", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ActionDefinitionProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actionname" }, "remarks": "You can't change the name of a custom action after you create it.", "stability": "external", "summary": "The descriptive name of the custom action." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2325 }, "name": "actionName", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.CustomActionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.DimensionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.\n\nAWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value.\n\nFor more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) .", "stability": "external", "summary": "The value to use in an Amazon CloudWatch custom metric dimension.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst dimensionProperty: networkfirewall.CfnRuleGroup.DimensionProperty = {\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.DimensionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2395 }, "name": "DimensionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html#cfn-networkfirewall-rulegroup-dimension-value" }, "stability": "external", "summary": "The value to use in the custom metric dimension." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2401 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.DimensionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.HeaderProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Traffic flows that match the criteria are a match for the corresponding stateful rule.", "stability": "external", "summary": "The 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst headerProperty: networkfirewall.CfnRuleGroup.HeaderProperty = {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.HeaderProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2463 }, "name": "HeaderProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destination" }, "remarks": "To match with any address, specify `ANY` .\n\nSpecify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .", "stability": "external", "summary": "The destination IP address or address range to inspect for, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2480 }, "name": "destination", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destinationport" }, "remarks": "You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .", "stability": "external", "summary": "The destination port to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2486 }, "name": "destinationPort", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-direction" }, "remarks": "If set to `ANY` , the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to `FORWARD` , the inspection only matches traffic going from the source to the destination.", "stability": "external", "summary": "The direction of traffic flow to inspect." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2492 }, "name": "direction", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-protocol" }, "remarks": "To specify all, you can use `IP` , because all traffic on AWS and on the internet is IP.", "stability": "external", "summary": "The protocol to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2498 }, "name": "protocol", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-source" }, "remarks": "To match with any address, specify `ANY` .\n\nSpecify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.\n\nExamples:\n\n- To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` .\n- To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` .\n- To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` .\n- To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` .\n\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) .", "stability": "external", "summary": "The source IP address or address range to inspect for, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2515 }, "name": "source", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-sourceport" }, "remarks": "You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` .", "stability": "external", "summary": "The source port to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2521 }, "name": "sourcePort", "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.HeaderProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipset.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is part of a `RuleGroup.RuleVariables` .", "stability": "external", "summary": "A list of IP addresses and address ranges, in CIDR notation.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst iPSetProperty: networkfirewall.CfnRuleGroup.IPSetProperty = {\n definition: ['definition'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2603 }, "name": "IPSetProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipset.html#cfn-networkfirewall-rulegroup-ipset-definition" }, "stability": "external", "summary": "The list of IP addresses and address ranges, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2609 }, "name": "definition", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.IPSetProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetReferenceProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html", "exampleMetadata": "fixture=_generated" }, "remarks": "An IP set reference is a rule variable that references a resource that you create and manage in another AWS service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the IP set you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall , see [Using IP set references](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall Developer Guide* .", "stability": "external", "summary": "Configures one or more `IPSetReferences` for a Suricata-compatible rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst iPSetReferenceProperty: networkfirewall.CfnRuleGroup.IPSetReferenceProperty = {\n referenceArn: 'referenceArn',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetReferenceProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2670 }, "name": "IPSetReferenceProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html#cfn-networkfirewall-rulegroup-ipsetreference-referencearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the resource to include in the `RuleGroup.IPSetReference` ." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2676 }, "name": "referenceArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.IPSetReferenceProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.MatchAttributesProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.", "stability": "external", "summary": "Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst matchAttributesProperty: networkfirewall.CfnRuleGroup.MatchAttributesProperty = {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.MatchAttributesProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2737 }, "name": "MatchAttributesProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinationports" }, "remarks": "If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).\n\nYou can specify individual ports, for example `1994` and you can specify port ranges, for example `1990:1994` .", "stability": "external", "summary": "The destination ports to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2745 }, "name": "destinationPorts", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortRangeProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinations" }, "remarks": "If not specified, this matches with any destination address.", "stability": "external", "summary": "The destination IP addresses and address ranges to inspect for, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2751 }, "name": "destinations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.AddressProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-protocols" }, "remarks": "If not specified, this matches with any protocol.", "stability": "external", "summary": "The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA)." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2757 }, "name": "protocols", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "number" }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sourceports" }, "remarks": "If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).\n\nYou can specify individual ports, for example `1994` and you can specify port ranges, for example `1990:1994` .", "stability": "external", "summary": "The source ports to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2765 }, "name": "sourcePorts", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortRangeProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sources" }, "remarks": "If not specified, this matches with any source address.", "stability": "external", "summary": "The source IP addresses and address ranges to inspect for, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2771 }, "name": "sources", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.AddressProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-tcpflags" }, "remarks": "If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).", "stability": "external", "summary": "The TCP flags and masks to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2777 }, "name": "tcpFlags", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.TCPFlagFieldProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.MatchAttributesProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortRangeProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used for source and destination port ranges in the stateless `RuleGroup.MatchAttributes` .", "stability": "external", "summary": "A single port range specification.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst portRangeProperty: networkfirewall.CfnRuleGroup.PortRangeProperty = {\n fromPort: 123,\n toPort: 123,\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortRangeProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2853 }, "name": "PortRangeProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-fromport" }, "remarks": "This must be less than or equal to the `ToPort` specification.", "stability": "external", "summary": "The lower limit of the port range." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2859 }, "name": "fromPort", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-toport" }, "remarks": "This must be greater than or equal to the `FromPort` specification.", "stability": "external", "summary": "The upper limit of the port range." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2865 }, "name": "toPort", "type": { "primitive": "number" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.PortRangeProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortSetProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "A set of port ranges for use in the rules in a rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst portSetProperty: networkfirewall.CfnRuleGroup.PortSetProperty = {\n definition: ['definition'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortSetProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2931 }, "name": "PortSetProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html#cfn-networkfirewall-rulegroup-portset-definition" }, "stability": "external", "summary": "The set of port ranges." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2937 }, "name": "definition", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.PortSetProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PublishMetricActionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This setting defines a CloudWatch dimension value to be published.", "stability": "external", "summary": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst publishMetricActionProperty: networkfirewall.CfnRuleGroup.PublishMetricActionProperty = {\n dimensions: [{\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PublishMetricActionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 2998 }, "name": "PublishMetricActionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html#cfn-networkfirewall-rulegroup-publishmetricaction-dimensions" }, "stability": "external", "summary": "`CfnRuleGroup.PublishMetricActionProperty.Dimensions`." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3004 }, "name": "dimensions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.DimensionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.PublishMetricActionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ReferenceSetsProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see the [Using IP set references in Suricata compatible rule groups](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall User Guide* .", "stability": "external", "summary": "Configures the `ReferenceSets` for a stateful rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst referenceSetsProperty: networkfirewall.CfnRuleGroup.ReferenceSetsProperty = {\n ipSetReferences: {\n ipSetReferencesKey: {\n referenceArn: 'referenceArn',\n },\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ReferenceSetsProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3066 }, "name": "ReferenceSetsProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html#cfn-networkfirewall-rulegroup-referencesets-ipsetreferences" }, "stability": "external", "summary": "The IP set references to use in the stateful rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3072 }, "name": "ipSetReferences", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetReferenceProperty" } ] } }, "kind": "map" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.ReferenceSetsProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleDefinitionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html", "exampleMetadata": "fixture=_generated" }, "remarks": "AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.", "stability": "external", "summary": "The inspection criteria and action for a single stateless rule.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst ruleDefinitionProperty: networkfirewall.CfnRuleGroup.RuleDefinitionProperty = {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleDefinitionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3133 }, "name": "RuleDefinitionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-actions" }, "remarks": "You must specify a standard action and you can add custom actions.\n\n> Network Firewall only forwards a packet for stateful rule inspection if you specify `aws:forward_to_sfe` for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify `aws:forward_to_sfe` for the `StatelessDefaultActions` setting for the `FirewallPolicy` .\n\nFor every rule, you must specify exactly one of the following standard actions.\n\n- *aws:pass* - Discontinues all inspection of the packet and permits it to go to its intended destination.\n- *aws:drop* - Discontinues all inspection of the packet and blocks it from going to its intended destination.\n- *aws:forward_to_sfe* - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection.\n\nAdditionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this `Actions` setting.\n\nTo provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named `MyMetricsAction` , then you could specify the standard action `aws:pass` combined with the custom action using `[“aws:pass”, “MyMetricsAction”]` .", "stability": "external", "summary": "The actions to take on a packet that matches one of the stateless rule definition's match attributes." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3151 }, "name": "actions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-matchattributes" }, "remarks": "Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.", "stability": "external", "summary": "Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3157 }, "name": "matchAttributes", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.MatchAttributesProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RuleDefinitionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleGroupProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.\n\nTo use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.", "stability": "external", "summary": "The object that defines the rules in a rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst ruleGroupProperty: networkfirewall.CfnRuleGroup.RuleGroupProperty = {\n rulesSource: {\n rulesSourceList: {\n generatedRulesType: 'generatedRulesType',\n targets: ['targets'],\n targetTypes: ['targetTypes'],\n },\n rulesString: 'rulesString',\n statefulRules: [{\n action: 'action',\n header: {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n },\n ruleOptions: [{\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n }],\n }],\n statelessRulesAndCustomActions: {\n statelessRules: [{\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n }],\n\n // the properties below are optional\n customActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n },\n },\n\n // the properties below are optional\n referenceSets: {\n ipSetReferences: {\n ipSetReferencesKey: {\n referenceArn: 'referenceArn',\n },\n },\n },\n ruleVariables: {\n ipSets: {\n ipSetsKey: {\n definition: ['definition'],\n },\n },\n portSets: {\n portSetsKey: {\n definition: ['definition'],\n },\n },\n },\n statefulRuleOptions: {\n ruleOrder: 'ruleOrder',\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleGroupProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3227 }, "name": "RuleGroupProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulessource" }, "stability": "external", "summary": "The stateful rules or stateless rules for the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3245 }, "name": "rulesSource", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-referencesets" }, "stability": "external", "summary": "The reference sets for the stateful rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3233 }, "name": "referenceSets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.ReferenceSetsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulevariables" }, "remarks": "You can only use these for stateful rule groups.", "stability": "external", "summary": "Settings that are available for use in the rules in the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3239 }, "name": "ruleVariables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleVariablesProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-statefulruleoptions" }, "remarks": "The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings.", "stability": "external", "summary": "Additional options governing how Network Firewall handles stateful rules." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3251 }, "name": "statefulRuleOptions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleOptionsProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RuleGroupProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleOptionProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Additional settings for a stateful rule.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst ruleOptionProperty: networkfirewall.CfnRuleGroup.RuleOptionProperty = {\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleOptionProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3322 }, "name": "RuleOptionProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-keyword" }, "remarks": "For Network Firewall , the keyword signature ID (sid) is required in the format `sid: 112233` . The sid must be unique within the rule group. For information about Suricata rule option keywords, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) .", "stability": "external", "summary": "The Suricata rule option keywords." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3328 }, "name": "keyword", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-settings" }, "remarks": "Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is `number` . For information about Suricata rule option settings, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) .", "stability": "external", "summary": "The Suricata rule option settings." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3334 }, "name": "settings", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RuleOptionProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleVariablesProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Settings that are available for use in the rules in the `RuleGroup` where this is defined.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst ruleVariablesProperty: networkfirewall.CfnRuleGroup.RuleVariablesProperty = {\n ipSets: {\n ipSetsKey: {\n definition: ['definition'],\n },\n },\n portSets: {\n portSetsKey: {\n definition: ['definition'],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleVariablesProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3399 }, "name": "RuleVariablesProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-ipsets" }, "stability": "external", "summary": "A list of IP addresses and address ranges, in CIDR notation." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3405 }, "name": "ipSets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.IPSetProperty" } ] } }, "kind": "map" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-portsets" }, "stability": "external", "summary": "A list of port ranges." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3411 }, "name": "portSets", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.PortSetProperty" } ] } }, "kind": "map" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RuleVariablesProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceListProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.\n\nBy default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the `HOME_NET` rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see `RuleGroup.RuleVariables` in this guide and [Stateful domain list rule groups in AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) in the *Network Firewall Developer Guide*", "stability": "external", "summary": "Stateful inspection criteria for a domain list rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst rulesSourceListProperty: networkfirewall.CfnRuleGroup.RulesSourceListProperty = {\n generatedRulesType: 'generatedRulesType',\n targets: ['targets'],\n targetTypes: ['targetTypes'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceListProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3575 }, "name": "RulesSourceListProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-generatedrulestype" }, "stability": "external", "summary": "Whether you want to allow or deny access to the domains in your target list." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3581 }, "name": "generatedRulesType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targets" }, "remarks": "- Explicit names. For example, `abc.example.com` matches only the domain `abc.example.com` .\n- Names that use a domain wildcard, which you indicate with an initial ' `.` '. For example, `.example.com` matches `example.com` and matches all subdomains of `example.com` , such as `abc.example.com` and `www.example.com` .", "stability": "external", "summary": "The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3596 }, "name": "targets", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targettypes" }, "remarks": "Valid values are `TLS_SNI` and `HTTP_HOST` .", "stability": "external", "summary": "The types of targets to inspect for." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3587 }, "name": "targetTypes", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RulesSourceListProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Each rule group requires a single `RulesSource` . You can use an instance of this for either stateless rules or stateful rules.", "stability": "external", "summary": "The stateless or stateful rules definitions for use in a single rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst rulesSourceProperty: networkfirewall.CfnRuleGroup.RulesSourceProperty = {\n rulesSourceList: {\n generatedRulesType: 'generatedRulesType',\n targets: ['targets'],\n targetTypes: ['targetTypes'],\n },\n rulesString: 'rulesString',\n statefulRules: [{\n action: 'action',\n header: {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n },\n ruleOptions: [{\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n }],\n }],\n statelessRulesAndCustomActions: {\n statelessRules: [{\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n }],\n\n // the properties below are optional\n customActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3475 }, "name": "RulesSourceProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulessourcelist" }, "stability": "external", "summary": "Stateful inspection criteria for a domain list rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3481 }, "name": "rulesSourceList", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RulesSourceListProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulesstring" }, "remarks": "Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.\n\nThese rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.", "stability": "external", "summary": "Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3489 }, "name": "rulesString", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statefulrules" }, "remarks": "Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html) .", "stability": "external", "summary": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3495 }, "name": "statefulRules", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statelessrulesandcustomactions" }, "stability": "external", "summary": "Stateless inspection criteria to be used in a stateless rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3501 }, "name": "statelessRulesAndCustomActions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRulesAndCustomActionsProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.RulesSourceProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleOptionsProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "You can only use these for stateful rule groups.", "stability": "external", "summary": "Additional options governing how Network Firewall handles the rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statefulRuleOptionsProperty: networkfirewall.CfnRuleGroup.StatefulRuleOptionsProperty = {\n ruleOrder: 'ruleOrder',\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleOptionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3766 }, "name": "StatefulRuleOptionsProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html#cfn-networkfirewall-rulegroup-statefulruleoptions-ruleorder" }, "remarks": "`DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* .", "stability": "external", "summary": "Indicates how to manage the order of the rule evaluation for the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3772 }, "name": "ruleOrder", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.StatefulRuleOptionsProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html) .", "stability": "external", "summary": "A single Suricata rules specification, for use in a stateful rule group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statefulRuleProperty: networkfirewall.CfnRuleGroup.StatefulRuleProperty = {\n action: 'action',\n header: {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n },\n ruleOptions: [{\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatefulRuleProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3666 }, "name": "StatefulRuleProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-action" }, "remarks": "For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow.\n\nThe actions for a stateful rule are defined as follows:\n\n- *PASS* - Permits the packets to go to the intended destination.\n- *DROP* - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the `Firewall` `LoggingConfiguration` .\n- *REJECT* - Drops traffic that matches the conditions of the stateful rule and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. `REJECT` is available only for TCP traffic.\n- *ALERT* - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the `Firewall` `LoggingConfiguration` .\n\nYou can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with `ALERT` action, verify in the logs that the rule is filtering as you want, then change the action to `DROP` .\n- *REJECT* - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the `Firewall` `LoggingConfiguration` .\n\n`REJECT` isn't currently available for use with IMAP and FTP protocols.", "stability": "external", "summary": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3684 }, "name": "action", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-header" }, "stability": "external", "summary": "The stateful inspection criteria for this rule, used to inspect traffic flows." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3690 }, "name": "header", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.HeaderProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-ruleoptions" }, "stability": "external", "summary": "Additional settings for a stateful rule, provided as keywords and settings." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3696 }, "name": "ruleOptions", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleOptionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.StatefulRuleProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRuleProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This is used in `RuleGroup.StatelessRulesAndCustomActions` .", "stability": "external", "summary": "A single stateless rule.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statelessRuleProperty: networkfirewall.CfnRuleGroup.StatelessRuleProperty = {\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRuleProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3833 }, "name": "StatelessRuleProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-priority" }, "remarks": "Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group.\n\nEach stateless rule group uses exactly one `StatelessRulesAndCustomActions` object, and each `StatelessRulesAndCustomActions` contains exactly one `StatelessRules` object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single `StatelessRules` object.\n\nYou can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on.", "stability": "external", "summary": "Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3843 }, "name": "priority", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-ruledefinition" }, "stability": "external", "summary": "Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3849 }, "name": "ruleDefinition", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleDefinitionProperty" } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.StatelessRuleProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRulesAndCustomActionsProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html", "exampleMetadata": "fixture=_generated" }, "remarks": "Each stateless rule group uses exactly one of these data types to define its stateless rules.", "stability": "external", "summary": "Stateless inspection criteria.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst statelessRulesAndCustomActionsProperty: networkfirewall.CfnRuleGroup.StatelessRulesAndCustomActionsProperty = {\n statelessRules: [{\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n }],\n\n // the properties below are optional\n customActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRulesAndCustomActionsProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3915 }, "name": "StatelessRulesAndCustomActionsProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-statelessrules" }, "stability": "external", "summary": "Defines the set of stateless rules for use in a stateless rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3927 }, "name": "statelessRules", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.StatelessRuleProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-customactions" }, "remarks": "You name each custom action that you define, and then you can use it by name in your stateless rule `RuleGroup.RuleDefinition` `Actions` specification.", "stability": "external", "summary": "Defines an array of individual custom action definitions that are available for use by the stateless rules in this `StatelessRulesAndCustomActions` specification." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3921 }, "name": "customActions", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.CustomActionProperty" } ] } }, "kind": "array" } } ] } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.StatelessRulesAndCustomActionsProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroup.TCPFlagFieldProperty": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For example:\n\n`\"TCPFlags\": [ { \"Flags\": [ \"ECE\", \"SYN\" ], \"Masks\": [ \"SYN\", \"ECE\" ] } ]`", "stability": "external", "summary": "TCP flags and masks to inspect packets for. This is used in the `RuleGroup.MatchAttributes` specification.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst tCPFlagFieldProperty: networkfirewall.CfnRuleGroup.TCPFlagFieldProperty = {\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.TCPFlagFieldProperty", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 3996 }, "name": "TCPFlagFieldProperty", "namespace": "CfnRuleGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-flags" }, "remarks": "This setting can only specify values that are also specified in the `Masks` setting.\n\nFor the flags that are specified in the masks setting, the following must be true for the packet to match:\n\n- The ones that are set in this flags setting must be set in the packet.\n- The ones that are not set in this flags setting must also not be set in the packet.", "stability": "external", "summary": "Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 4007 }, "name": "flags", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-masks" }, "remarks": "To inspect all flags in the valid values list, leave this with no setting.", "stability": "external", "summary": "The set of flags to consider in the inspection." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 4013 }, "name": "masks", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroup.TCPFlagFieldProperty" }, "@aws-cdk/aws-networkfirewall.CfnRuleGroupProps": { "assembly": "@aws-cdk/aws-networkfirewall", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRuleGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as networkfirewall from '@aws-cdk/aws-networkfirewall';\nconst cfnRuleGroupProps: networkfirewall.CfnRuleGroupProps = {\n capacity: 123,\n ruleGroupName: 'ruleGroupName',\n type: 'type',\n\n // the properties below are optional\n description: 'description',\n ruleGroup: {\n rulesSource: {\n rulesSourceList: {\n generatedRulesType: 'generatedRulesType',\n targets: ['targets'],\n targetTypes: ['targetTypes'],\n },\n rulesString: 'rulesString',\n statefulRules: [{\n action: 'action',\n header: {\n destination: 'destination',\n destinationPort: 'destinationPort',\n direction: 'direction',\n protocol: 'protocol',\n source: 'source',\n sourcePort: 'sourcePort',\n },\n ruleOptions: [{\n keyword: 'keyword',\n\n // the properties below are optional\n settings: ['settings'],\n }],\n }],\n statelessRulesAndCustomActions: {\n statelessRules: [{\n priority: 123,\n ruleDefinition: {\n actions: ['actions'],\n matchAttributes: {\n destinationPorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n destinations: [{\n addressDefinition: 'addressDefinition',\n }],\n protocols: [123],\n sourcePorts: [{\n fromPort: 123,\n toPort: 123,\n }],\n sources: [{\n addressDefinition: 'addressDefinition',\n }],\n tcpFlags: [{\n flags: ['flags'],\n\n // the properties below are optional\n masks: ['masks'],\n }],\n },\n },\n }],\n\n // the properties below are optional\n customActions: [{\n actionDefinition: {\n publishMetricAction: {\n dimensions: [{\n value: 'value',\n }],\n },\n },\n actionName: 'actionName',\n }],\n },\n },\n\n // the properties below are optional\n referenceSets: {\n ipSetReferences: {\n ipSetReferencesKey: {\n referenceArn: 'referenceArn',\n },\n },\n },\n ruleVariables: {\n ipSets: {\n ipSetsKey: {\n definition: ['definition'],\n },\n },\n portSets: {\n portSetsKey: {\n definition: ['definition'],\n },\n },\n },\n statefulRuleOptions: {\n ruleOrder: 'ruleOrder',\n },\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1898 }, "name": "CfnRuleGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity" }, "remarks": "You can't change a rule group's capacity setting after you create the rule group. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.", "stability": "external", "summary": "The maximum operating resources that this rule group can use." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1905 }, "name": "capacity", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname" }, "remarks": "You can't change the name of a rule group after you create it.", "stability": "external", "summary": "The descriptive name of the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1912 }, "name": "ruleGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type" }, "remarks": "If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules.", "stability": "external", "summary": "Indicates whether the rule group is stateless or stateful." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1920 }, "name": "type", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-description" }, "stability": "external", "summary": "A description of the rule group." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1927 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup" }, "stability": "external", "summary": "An object that defines the rule group rules." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1934 }, "name": "ruleGroup", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-networkfirewall.CfnRuleGroup.RuleGroupProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-tags" }, "remarks": "For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .", "stability": "external", "summary": "An array of key-value pairs to apply to this resource." }, "immutable": true, "locationInModule": { "filename": "lib/networkfirewall.generated.ts", "line": 1943 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/networkfirewall.generated:CfnRuleGroupProps" } }, "version": "1.204.0", "fingerprint": "**********" }