@aws-cdk_aws-route53resolver-alpha.FirewallDomainList

class FirewallDomainList (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Route53Resolver.Alpha.FirewallDomainList
Gogithub.com/aws/aws-cdk-go/awscdkroute53resolveralpha/v2#FirewallDomainList
Javasoftware.amazon.awscdk.services.route53resolver.alpha.FirewallDomainList
Pythonaws_cdk.aws_route53resolver_alpha.FirewallDomainList
TypeScript (source)@aws-cdk/aws-route53resolver-alpha ยป FirewallDomainList

Implements IConstruct, IDependable, IResource, IFirewallDomainList

A Firewall Domain List.

Example

const blockList = new route53resolver.FirewallDomainList(this, 'BlockList', {
  domains: route53resolver.FirewallDomains.fromList(['bad-domain.com', 'bot-domain.net']),
});

const s3List = new route53resolver.FirewallDomainList(this, 'S3List', {
  domains: route53resolver.FirewallDomains.fromS3Url('s3://bucket/prefix/object'),
});

const assetList = new route53resolver.FirewallDomainList(this, 'AssetList', {
  domains: route53resolver.FirewallDomains.fromAsset('/path/to/domains.txt'),
});

Initializer

new FirewallDomainList(scope: Construct, id: string, props: FirewallDomainListProps)

Parameters

  • scope Construct
  • id string
  • props FirewallDomainListProps

Construct Props

NameTypeDescription
domains๐Ÿ”นFirewallDomainsA list of domains.
name?๐Ÿ”นstringA name for the domain list.

domains๐Ÿ”น

Type: FirewallDomains

A list of domains.


name?๐Ÿ”น

Type: string (optional, default: a CloudFormation generated name)

A name for the domain list.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
firewallDomainListArn๐Ÿ”นstringThe ARN (Amazon Resource Name) of the domain list.
firewallDomainListCreationTime๐Ÿ”นstringThe date and time that the domain list was created.
firewallDomainListCreatorRequestId๐Ÿ”นstringThe creator request ID.
firewallDomainListDomainCount๐Ÿ”นnumberThe number of domains in the list.
firewallDomainListId๐Ÿ”นstringThe ID of the domain list.
firewallDomainListManagedOwnerName๐Ÿ”นstringThe owner of the list, used only for lists that are not managed by you.
firewallDomainListModificationTime๐Ÿ”นstringThe date and time that the domain list was last modified.
firewallDomainListStatus๐Ÿ”นstringThe status of the domain list.
firewallDomainListStatusMessage๐Ÿ”นstringAdditional information about the status of the rule group.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


firewallDomainListArn๐Ÿ”น

Type: string

The ARN (Amazon Resource Name) of the domain list.


firewallDomainListCreationTime๐Ÿ”น

Type: string

The date and time that the domain list was created.


firewallDomainListCreatorRequestId๐Ÿ”น

Type: string

The creator request ID.


firewallDomainListDomainCount๐Ÿ”น

Type: number

The number of domains in the list.


firewallDomainListId๐Ÿ”น

Type: string

The ID of the domain list.


firewallDomainListManagedOwnerName๐Ÿ”น

Type: string

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.


firewallDomainListModificationTime๐Ÿ”น

Type: string

The date and time that the domain list was last modified.


firewallDomainListStatus๐Ÿ”น

Type: string

The status of the domain list.


firewallDomainListStatusMessage๐Ÿ”น

Type: string

Additional information about the status of the rule group.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromFirewallDomainListId(scope, id, firewallDomainListId)๐Ÿ”นImport an existing Firewall Rule Group.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromFirewallDomainListId(scope, id, firewallDomainListId)๐Ÿ”น

public static fromFirewallDomainListId(scope: Construct, id: string, firewallDomainListId: string): IFirewallDomainList

Parameters

  • scope Construct
  • id string
  • firewallDomainListId string

Returns

  • IFirewallDomainList

Import an existing Firewall Rule Group.