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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.365Z")
 @Stability(value=Stable)
public class CfnFirewallPolicy
extends CfnResource
implements IInspectable

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

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 Example:
static class	CfnFirewallPolicy.Builder A fluent builder for CfnFirewallPolicy.
static interface	CfnFirewallPolicy.CustomActionProperty Example:
static interface	CfnFirewallPolicy.DimensionProperty Example:
static interface	CfnFirewallPolicy.FirewallPolicyProperty Example:
static interface	CfnFirewallPolicy.PublishMetricActionProperty Example:
static interface	CfnFirewallPolicy.StatefulEngineOptionsProperty Example:
static interface	CfnFirewallPolicy.StatefulRuleGroupReferenceProperty Example:
static interface	CfnFirewallPolicy.StatelessRuleGroupReferenceProperty Example:

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()
String	getAttrFirewallPolicyId()
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::NetworkFirewall::FirewallPolicy.Description`.
Object	getFirewallPolicy() `AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.
String	getFirewallPolicyName() `AWS::NetworkFirewall::FirewallPolicy.FirewallPolicyName`.
TagManager	getTags() `AWS::NetworkFirewall::FirewallPolicy.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::NetworkFirewall::FirewallPolicy.Description`.
void	setFirewallPolicy(CfnFirewallPolicy.FirewallPolicyProperty value) `AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.
void	setFirewallPolicy(IResolvable value) `AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.
void	setFirewallPolicyName(String value) `AWS::NetworkFirewall::FirewallPolicy.FirewallPolicyName`.

Methods inherited from class software.amazon.awscdk.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.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()

getAttrFirewallPolicyId

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDescription

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

`AWS::NetworkFirewall::FirewallPolicy.Description`.

setDescription

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

`AWS::NetworkFirewall::FirewallPolicy.Description`.

getFirewallPolicy

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

`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.

setFirewallPolicy

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

`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.

setFirewallPolicy

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

`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicy`.

getFirewallPolicyName

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

`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicyName`.

setFirewallPolicyName

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

`AWS::NetworkFirewall::FirewallPolicy.FirewallPolicyName`.

getTags

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

`AWS::NetworkFirewall::FirewallPolicy.Tags`.