software.amazon.awscdk.services.networkfirewall

Class CfnFirewallPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.networkfirewall.CfnFirewallPolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.023Z")
 @Stability(value=Stable)
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")
                         .build())
                 .statefulRuleGroupReferences(List.of(StatefulRuleGroupReferenceProperty.builder()
                         .resourceArn("resourceArn")
                         // the properties below are optional
                         .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.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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFirewallPolicy(software.constructs.Construct scope, 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
String	getAttrFirewallPolicyArn() The Amazon Resource Name (ARN) of the `FirewallPolicy` .
String	getAttrFirewallPolicyId() The unique ID of the `FirewallPolicy` resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the firewall policy.
Object	getFirewallPolicy() The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(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(String value) The descriptive name of the firewall policy.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnFirewallPolicy(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrFirewallPolicyArn

@Stability(value=Stable)
 @NotNull
public String getAttrFirewallPolicyArn()

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

getAttrFirewallPolicyId

@Stability(value=Stable)
 @NotNull
public String getAttrFirewallPolicyId()

The unique ID of the `FirewallPolicy` resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getFirewallPolicy

@Stability(value=Stable)
 @NotNull
public Object getFirewallPolicy()

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

setFirewallPolicy

@Stability(value=Stable)
public void setFirewallPolicy(@NotNull
                                                       CfnFirewallPolicy.FirewallPolicyProperty value)

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

setFirewallPolicy

@Stability(value=Stable)
public void setFirewallPolicy(@NotNull
                                                       IResolvable value)

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

getFirewallPolicyName

@Stability(value=Stable)
 @NotNull
public String getFirewallPolicyName()

The descriptive name of the firewall policy.

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

setFirewallPolicyName

@Stability(value=Stable)
public void setFirewallPolicyName(@NotNull
                                                           String value)

The descriptive name of the firewall policy.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the firewall policy.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the firewall policy.