software.amazon.awscdk.services.wafv2

Class CfnRuleGroup

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.wafv2.CfnRuleGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:53.588Z")
 @Stability(value=Stable)
public class CfnRuleGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WAFv2::RuleGroup`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnRuleGroup.AndStatementProperty
static class	CfnRuleGroup.Builder A fluent builder for CfnRuleGroup.
static interface	CfnRuleGroup.ByteMatchStatementProperty
static interface	CfnRuleGroup.CustomResponseBodyProperty
static interface	CfnRuleGroup.FieldToMatchProperty
static interface	CfnRuleGroup.ForwardedIPConfigurationProperty
static interface	CfnRuleGroup.GeoMatchStatementProperty
static interface	CfnRuleGroup.IPSetForwardedIPConfigurationProperty
static interface	CfnRuleGroup.IPSetReferenceStatementProperty
static interface	CfnRuleGroup.JsonBodyProperty
static interface	CfnRuleGroup.JsonMatchPatternProperty
static interface	CfnRuleGroup.LabelMatchStatementProperty
static interface	CfnRuleGroup.LabelProperty
static interface	CfnRuleGroup.LabelSummaryProperty
static interface	CfnRuleGroup.NotStatementProperty
static interface	CfnRuleGroup.OrStatementProperty
static interface	CfnRuleGroup.RateBasedStatementProperty
static interface	CfnRuleGroup.RegexPatternSetReferenceStatementProperty
static interface	CfnRuleGroup.RuleActionProperty
static interface	CfnRuleGroup.RuleProperty
static interface	CfnRuleGroup.SizeConstraintStatementProperty
static interface	CfnRuleGroup.SqliMatchStatementProperty
static interface	CfnRuleGroup.StatementProperty
static interface	CfnRuleGroup.TextTransformationProperty
static interface	CfnRuleGroup.VisibilityConfigProperty
static interface	CfnRuleGroup.XssMatchStatementProperty

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
	CfnRuleGroup(software.constructs.Construct scope, String id, CfnRuleGroupProps props) Create a new `AWS::WAFv2::RuleGroup`.
protected	CfnRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
IResolvable	getAttrAvailableLabels()
IResolvable	getAttrConsumedLabels()
String	getAttrId()
String	getAttrLabelNamespace()
Number	getCapacity() `AWS::WAFv2::RuleGroup.Capacity`.
protected Map<String,Object>	getCfnProperties()
Object	getCustomResponseBodies() `AWS::WAFv2::RuleGroup.CustomResponseBodies`.
String	getDescription() `AWS::WAFv2::RuleGroup.Description`.
String	getName() `AWS::WAFv2::RuleGroup.Name`.
Object	getRules() `AWS::WAFv2::RuleGroup.Rules`.
String	getScope() `AWS::WAFv2::RuleGroup.Scope`.
TagManager	getTags() `AWS::WAFv2::RuleGroup.Tags`.
Object	getVisibilityConfig() `AWS::WAFv2::RuleGroup.VisibilityConfig`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacity(Number value) `AWS::WAFv2::RuleGroup.Capacity`.
void	setCustomResponseBodies(IResolvable value) `AWS::WAFv2::RuleGroup.CustomResponseBodies`.
void	setCustomResponseBodies(Map<String,Object> value) `AWS::WAFv2::RuleGroup.CustomResponseBodies`.
void	setDescription(String value) `AWS::WAFv2::RuleGroup.Description`.
void	setName(String value) `AWS::WAFv2::RuleGroup.Name`.
void	setRules(IResolvable value) `AWS::WAFv2::RuleGroup.Rules`.
void	setRules(List<Object> value) `AWS::WAFv2::RuleGroup.Rules`.
void	setScope(String value) `AWS::WAFv2::RuleGroup.Scope`.
void	setVisibilityConfig(CfnRuleGroup.VisibilityConfigProperty value) `AWS::WAFv2::RuleGroup.VisibilityConfig`.
void	setVisibilityConfig(IResolvable value) `AWS::WAFv2::RuleGroup.VisibilityConfig`.

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

CfnRuleGroup

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

CfnRuleGroup

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

CfnRuleGroup

@Stability(value=Stable)
public CfnRuleGroup(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnRuleGroupProps props)

Create a new `AWS::WAFv2::RuleGroup`.

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.

getAttrArn

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

getAttrAvailableLabels

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrAvailableLabels()

getAttrConsumedLabels

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrConsumedLabels()

getAttrId

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

getAttrLabelNamespace

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::WAFv2::RuleGroup.Tags`.

getCapacity

@Stability(value=Stable)
 @NotNull
public Number getCapacity()

`AWS::WAFv2::RuleGroup.Capacity`.

setCapacity

@Stability(value=Stable)
public void setCapacity(@NotNull
                                                 Number value)

`AWS::WAFv2::RuleGroup.Capacity`.

getScope

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

`AWS::WAFv2::RuleGroup.Scope`.

setScope

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

`AWS::WAFv2::RuleGroup.Scope`.

getVisibilityConfig

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

`AWS::WAFv2::RuleGroup.VisibilityConfig`.

setVisibilityConfig

@Stability(value=Stable)
public void setVisibilityConfig(@NotNull
                                                         CfnRuleGroup.VisibilityConfigProperty value)

`AWS::WAFv2::RuleGroup.VisibilityConfig`.

setVisibilityConfig

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

`AWS::WAFv2::RuleGroup.VisibilityConfig`.

getCustomResponseBodies

@Stability(value=Stable)
 @Nullable
public Object getCustomResponseBodies()

`AWS::WAFv2::RuleGroup.CustomResponseBodies`.

setCustomResponseBodies

@Stability(value=Stable)
public void setCustomResponseBodies(@Nullable
                                                             IResolvable value)

`AWS::WAFv2::RuleGroup.CustomResponseBodies`.

setCustomResponseBodies

@Stability(value=Stable)
public void setCustomResponseBodies(@Nullable
                                                             Map<String,Object> value)

`AWS::WAFv2::RuleGroup.CustomResponseBodies`.

getDescription

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

`AWS::WAFv2::RuleGroup.Description`.

setDescription

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

`AWS::WAFv2::RuleGroup.Description`.

getName

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

`AWS::WAFv2::RuleGroup.Name`.

setName

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

`AWS::WAFv2::RuleGroup.Name`.

getRules

@Stability(value=Stable)
 @Nullable
public Object getRules()

`AWS::WAFv2::RuleGroup.Rules`.

setRules

@Stability(value=Stable)
public void setRules(@Nullable
                                              IResolvable value)

`AWS::WAFv2::RuleGroup.Rules`.

setRules

@Stability(value=Stable)
public void setRules(@Nullable
                                              List<Object> value)

`AWS::WAFv2::RuleGroup.Rules`.