CreateFirewallDomainListCommand

Suggest an Edit

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Route53ResolverClient, CreateFirewallDomainListCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import
// const { Route53ResolverClient, CreateFirewallDomainListCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import
const client = new Route53ResolverClient(config);
const input = { // CreateFirewallDomainListRequest
  CreatorRequestId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateFirewallDomainListCommand(input);
const response = await client.send(command);
// { // CreateFirewallDomainListResponse
//   FirewallDomainList: { // FirewallDomainList
//     Id: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     DomainCount: Number("int"),
//     Status: "COMPLETE" || "COMPLETE_IMPORT_FAILED" || "IMPORTING" || "DELETING" || "UPDATING",
//     StatusMessage: "STRING_VALUE",
//     ManagedOwnerName: "STRING_VALUE",
//     CreatorRequestId: "STRING_VALUE",
//     CreationTime: "STRING_VALUE",
//     ModificationTime: "STRING_VALUE",
//   },
// };

CreateFirewallDomainListCommand Input

See CreateFirewallDomainListCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

A name that lets you identify the domain list to manage and use it.

CreatorRequestId
string | undefined

A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Tags
Tag[] | undefined

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

CreateFirewallDomainListCommand Output

See CreateFirewallDomainListCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FirewallDomainList
FirewallDomainList | undefined

The domain list that you just created.

Throws

Name
Fault
Details
AccessDeniedException
client

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException
client

We encountered an unknown error. Try again in a few minutes.

LimitExceededException
client

The request caused one or more limits to be exceeded.

ThrottlingException
client

The request was throttled. Try again in a few minutes.

ValidationException
client

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

Route53ResolverServiceException
Base exception class for all service exceptions from Route53Resolver service.