software.amazon.awscdk.services.route53resolver

Class CfnFirewallRuleGroup

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.route53resolver.CfnFirewallRuleGroup

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.699Z")
 @Stability(value=Stable)
public class CfnFirewallRuleGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Route53Resolver::FirewallRuleGroup`.

High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules .

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.route53resolver.*;
 CfnFirewallRuleGroup cfnFirewallRuleGroup = CfnFirewallRuleGroup.Builder.create(this, "MyCfnFirewallRuleGroup")
         .firewallRules(List.of(FirewallRuleProperty.builder()
                 .action("action")
                 .firewallDomainListId("firewallDomainListId")
                 .priority(123)
                 // the properties below are optional
                 .blockOverrideDnsType("blockOverrideDnsType")
                 .blockOverrideDomain("blockOverrideDomain")
                 .blockOverrideTtl(123)
                 .blockResponse("blockResponse")
                 .build()))
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFirewallRuleGroup.Builder A fluent builder for CfnFirewallRuleGroup.
static interface	CfnFirewallRuleGroup.FirewallRuleProperty A single firewall rule in a 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
	CfnFirewallRuleGroup(software.constructs.Construct scope, String id) Create a new `AWS::Route53Resolver::FirewallRuleGroup`.
	CfnFirewallRuleGroup(software.constructs.Construct scope, String id, CfnFirewallRuleGroupProps props) Create a new `AWS::Route53Resolver::FirewallRuleGroup`.
protected	CfnFirewallRuleGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFirewallRuleGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN (Amazon Resource Name) of the rule group.
String	getAttrCreationTime() The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).
String	getAttrCreatorRequestId() A unique string defined by you to identify the request.
String	getAttrId() The ID of the rule group.
String	getAttrModificationTime() The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).
String	getAttrOwnerId() The AWS account ID for the account that created the rule group.
Number	getAttrRuleCount() The number of rules in the rule group.
String	getAttrShareStatus() Whether the rule group is shared with other AWS accounts , or was shared with the current account by another AWS account .
String	getAttrStatus() The status of the domain list.
String	getAttrStatusMessage() Additional information about the status of the rule group, if available.
protected Map<String,Object>	getCfnProperties()
Object	getFirewallRules() A list of the rules that you have defined.
String	getName() The name of the rule group.
TagManager	getTags() A list of the tag keys and values that you want to associate with the rule group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFirewallRules(IResolvable value) A list of the rules that you have defined.
void	setFirewallRules(List<Object> value) A list of the rules that you have defined.
void	setName(String value) The name of the rule group.

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

CfnFirewallRuleGroup

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

CfnFirewallRuleGroup

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

CfnFirewallRuleGroup

@Stability(value=Stable)
public CfnFirewallRuleGroup(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @Nullable
                                                     CfnFirewallRuleGroupProps props)

Create a new `AWS::Route53Resolver::FirewallRuleGroup`.

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.

CfnFirewallRuleGroup

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

Create a new `AWS::Route53Resolver::FirewallRuleGroup`.

Parameters:

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

id - - scoped id of the resource. 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()

The ARN (Amazon Resource Name) of the rule group.

getAttrCreationTime

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

The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).

getAttrCreatorRequestId

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

A unique string defined by you to identify the request.

This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

getAttrId

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

The ID of the rule group.

getAttrModificationTime

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

The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).

getAttrOwnerId

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

The AWS account ID for the account that created the rule group.

When a rule group is shared with your account, this is the account that has shared the rule group with you.

getAttrRuleCount

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

The number of rules in the rule group.

getAttrShareStatus

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

Whether the rule group is shared with other AWS accounts , or was shared with the current account by another AWS account .

Sharing is configured through AWS Resource Access Manager ( AWS RAM ).

getAttrStatus

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

The status of the domain list.

getAttrStatusMessage

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

Additional information about the status of the rule group, if available.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

A list of the tag keys and values that you want to associate with the rule group.

getFirewallRules

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

A list of the rules that you have defined.

setFirewallRules

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

A list of the rules that you have defined.

setFirewallRules

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

A list of the rules that you have defined.

getName

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

The name of the rule group.

setName

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

The name of the rule group.