software.amazon.awscdk.services.route53resolver

Class CfnFirewallDomainList

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.CfnFirewallDomainList

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

A CloudFormation `AWS::Route53Resolver::FirewallDomainList`.

High-level information about a list of firewall domains for use in a AWS::Route53Resolver::FirewallRule . This is returned by GetFirewallDomainList .

To retrieve the domains that are defined for this domain list, call ListFirewallDomains .

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.*;
 CfnFirewallDomainList cfnFirewallDomainList = CfnFirewallDomainList.Builder.create(this, "MyCfnFirewallDomainList")
         .domainFileUrl("domainFileUrl")
         .domains(List.of("domains"))
         .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	CfnFirewallDomainList.Builder A fluent builder for CfnFirewallDomainList.

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

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the firewall domain list.
String	getAttrCreationTime() The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC).
String	getAttrCreatorRequestId() A unique string defined by you to identify the request.
Number	getAttrDomainCount() The number of domain names that are specified in the domain list.
String	getAttrId() The ID of the domain list.
String	getAttrManagedOwnerName() The owner of the list, used only for lists that are not managed by you.
String	getAttrModificationTime() The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC).
String	getAttrStatus() The status of the domain list.
String	getAttrStatusMessage() Additional information about the status of the list, if available.
protected Map<String,Object>	getCfnProperties()
String	getDomainFileUrl() The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
List<String>	getDomains() A list of the domain lists that you have defined.
String	getName() The name of the domain list.
TagManager	getTags() A list of the tag keys and values that you want to associate with the domain list.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainFileUrl(String value) The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
void	setDomains(List<String> value) A list of the domain lists that you have defined.
void	setName(String value) The name of the domain list.

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

CfnFirewallDomainList

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

CfnFirewallDomainList

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

CfnFirewallDomainList

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

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

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.

CfnFirewallDomainList

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

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

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 Amazon Resource Name (ARN) of the firewall domain list.

getAttrCreationTime

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

The date and time that the domain list 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.

getAttrDomainCount

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

The number of domain names that are specified in the domain list.

getAttrId

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

The ID of the domain list.

getAttrManagedOwnerName

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

The owner of the list, used only for lists that are not managed by you.

For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall .

getAttrModificationTime

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

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

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 list, 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 domain list.

getDomainFileUrl

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

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

setDomainFileUrl

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

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

getDomains

@Stability(value=Stable)
 @Nullable
public List<String> getDomains()

A list of the domain lists that you have defined.

setDomains

@Stability(value=Stable)
public void setDomains(@Nullable
                                                List<String> value)

A list of the domain lists that you have defined.

getName

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

The name of the domain list.

setName

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

The name of the domain list.