software.amazon.awscdk.services.networkfirewall

Class CfnFirewallPolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.networkfirewall.CfnFirewallPolicy

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.883Z")
public class CfnFirewallPolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkFirewall::FirewallPolicy`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkfirewall.*;
 CfnFirewallPolicy cfnFirewallPolicy = CfnFirewallPolicy.Builder.create(this, "MyCfnFirewallPolicy")
         .firewallPolicy(FirewallPolicyProperty.builder()
                 .statelessDefaultActions(List.of("statelessDefaultActions"))
                 .statelessFragmentDefaultActions(List.of("statelessFragmentDefaultActions"))
                 // the properties below are optional
                 .statefulDefaultActions(List.of("statefulDefaultActions"))
                 .statefulEngineOptions(StatefulEngineOptionsProperty.builder()
                         .ruleOrder("ruleOrder")
                         .streamExceptionPolicy("streamExceptionPolicy")
                         .build())
                 .statefulRuleGroupReferences(List.of(StatefulRuleGroupReferenceProperty.builder()
                         .resourceArn("resourceArn")
                         // the properties below are optional
                         .override(StatefulRuleGroupOverrideProperty.builder()
                                 .action("action")
                                 .build())
                         .priority(123)
                         .build()))
                 .statelessCustomActions(List.of(CustomActionProperty.builder()
                         .actionDefinition(ActionDefinitionProperty.builder()
                                 .publishMetricAction(PublishMetricActionProperty.builder()
                                         .dimensions(List.of(DimensionProperty.builder()
                                                 .value("value")
                                                 .build()))
                                         .build())
                                 .build())
                         .actionName("actionName")
                         .build()))
                 .statelessRuleGroupReferences(List.of(StatelessRuleGroupReferenceProperty.builder()
                         .priority(123)
                         .resourceArn("resourceArn")
                         .build()))
                 .build())
         .firewallPolicyName("firewallPolicyName")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFirewallPolicy.ActionDefinitionProperty A custom action to use in stateless rule actions settings.
static class	CfnFirewallPolicy.Builder A fluent builder for CfnFirewallPolicy.
static interface	CfnFirewallPolicy.CustomActionProperty An optional, non-standard action to use for stateless packet handling.
static interface	CfnFirewallPolicy.DimensionProperty The value to use in an Amazon CloudWatch custom metric dimension.
static interface	CfnFirewallPolicy.FirewallPolicyProperty The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
static interface	CfnFirewallPolicy.PublishMetricActionProperty Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
static interface	CfnFirewallPolicy.StatefulEngineOptionsProperty Configuration settings for the handling of the stateful rule groups in a firewall policy.
static interface	CfnFirewallPolicy.StatefulRuleGroupOverrideProperty The setting that allows the policy owner to change the behavior of the rule group within a policy.
static interface	CfnFirewallPolicy.StatefulRuleGroupReferenceProperty Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
static interface	CfnFirewallPolicy.StatelessRuleGroupReferenceProperty Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFirewallPolicy(Construct scope, java.lang.String id, CfnFirewallPolicyProps props) Create a new `AWS::NetworkFirewall::FirewallPolicy`.
protected	CfnFirewallPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFirewallPolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrFirewallPolicyArn() The Amazon Resource Name (ARN) of the `FirewallPolicy` .
java.lang.String	getAttrFirewallPolicyId() The unique ID of the `FirewallPolicy` resource.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the firewall policy.
java.lang.Object	getFirewallPolicy() The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
java.lang.String	getFirewallPolicyName() The descriptive name of the firewall policy.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description of the firewall policy.
void	setFirewallPolicy(CfnFirewallPolicy.FirewallPolicyProperty value) The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
void	setFirewallPolicy(IResolvable value) The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
void	setFirewallPolicyName(java.lang.String value) The descriptive name of the firewall policy.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFirewallPolicy

protected CfnFirewallPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnFirewallPolicy

protected CfnFirewallPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFirewallPolicy

public CfnFirewallPolicy(Construct scope,
                         java.lang.String id,
                         CfnFirewallPolicyProps props)

Create a new `AWS::NetworkFirewall::FirewallPolicy`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFirewallPolicyArn

public java.lang.String getAttrFirewallPolicyArn()

The Amazon Resource Name (ARN) of the `FirewallPolicy` .

getAttrFirewallPolicyId

public java.lang.String getAttrFirewallPolicyId()

The unique ID of the `FirewallPolicy` resource.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getFirewallPolicy

public java.lang.Object getFirewallPolicy()

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

setFirewallPolicy

public void setFirewallPolicy(IResolvable value)

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

setFirewallPolicy

public void setFirewallPolicy(CfnFirewallPolicy.FirewallPolicyProperty value)

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

getFirewallPolicyName

public java.lang.String getFirewallPolicyName()

The descriptive name of the firewall policy.

You can't change the name of a firewall policy after you create it.

setFirewallPolicyName

public void setFirewallPolicyName(java.lang.String value)

The descriptive name of the firewall policy.

You can't change the name of a firewall policy after you create it.

getDescription

public java.lang.String getDescription()

A description of the firewall policy.

setDescription

public void setDescription(java.lang.String value)

A description of the firewall policy.