CreateOutpostResolverCommand

Creates a Route 53 Resolver on an Outpost.

Example Syntax

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

import { Route53ResolverClient, CreateOutpostResolverCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import
// const { Route53ResolverClient, CreateOutpostResolverCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import
const client = new Route53ResolverClient(config);
const input = { // CreateOutpostResolverRequest
  CreatorRequestId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  InstanceCount: Number("int"),
  PreferredInstanceType: "STRING_VALUE", // required
  OutpostArn: "STRING_VALUE", // required
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateOutpostResolverCommand(input);
const response = await client.send(command);
// { // CreateOutpostResolverResponse
//   OutpostResolver: { // OutpostResolver
//     Arn: "STRING_VALUE",
//     CreationTime: "STRING_VALUE",
//     ModificationTime: "STRING_VALUE",
//     CreatorRequestId: "STRING_VALUE",
//     Id: "STRING_VALUE",
//     InstanceCount: Number("int"),
//     PreferredInstanceType: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Status: "CREATING" || "OPERATIONAL" || "UPDATING" || "DELETING" || "ACTION_NEEDED" || "FAILED_CREATION" || "FAILED_DELETION",
//     StatusMessage: "STRING_VALUE",
//     OutpostArn: "STRING_VALUE",
//   },
// };

CreateOutpostResolverCommand Input

Parameter
Type
Description
CreatorRequestId
Required
string | undefined

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.

CreatorRequestId can be any unique string, for example, a date/time stamp.

Name
Required
string | undefined

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

OutpostArn
Required
string | undefined

The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

PreferredInstanceType
Required
string | undefined

The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.

InstanceCount
number | undefined

Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.

Tags
Tag[] | undefined

A string that helps identify the Route 53 Resolvers on Outpost.

CreateOutpostResolverCommand Output

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

Information about the CreateOutpostResolver request, including the status of the request.

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.

ResourceNotFoundException
client

The specified resource doesn't exist.

ServiceQuotaExceededException
client

Fulfilling the request would cause one or more quotas 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.