CreateVPCConnectionCommand

Creates a new VPC connection.

Example Syntax

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

import { QuickSightClient, CreateVPCConnectionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, CreateVPCConnectionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // CreateVPCConnectionRequest
  AwsAccountId: "STRING_VALUE", // required
  VPCConnectionId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  SubnetIds: [ // SubnetIdList // required
    "STRING_VALUE",
  ],
  SecurityGroupIds: [ // SecurityGroupIdList // required
    "STRING_VALUE",
  ],
  DnsResolvers: [ // DnsResolverList
    "STRING_VALUE",
  ],
  RoleArn: "STRING_VALUE", // required
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new CreateVPCConnectionCommand(input);
const response = await client.send(command);
// { // CreateVPCConnectionResponse
//   Arn: "STRING_VALUE",
//   VPCConnectionId: "STRING_VALUE",
//   CreationStatus: "CREATION_IN_PROGRESS" || "CREATION_SUCCESSFUL" || "CREATION_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED" || "DELETION_IN_PROGRESS" || "DELETION_FAILED" || "DELETED",
//   AvailabilityStatus: "AVAILABLE" || "UNAVAILABLE" || "PARTIALLY_AVAILABLE",
//   RequestId: "STRING_VALUE",
//   Status: Number("int"),
// };

CreateVPCConnectionCommand Input

See CreateVPCConnectionCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The Amazon Web Services account ID of the account where you want to create a new VPC connection.

Name
Required
string | undefined

The display name for the VPC connection.

RoleArn
Required
string | undefined

The IAM role to associate with the VPC connection.

SecurityGroupIds
Required
string[] | undefined

A list of security group IDs for the VPC connection.

SubnetIds
Required
string[] | undefined

A list of subnet IDs for the VPC connection.

VPCConnectionId
Required
string | undefined

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

DnsResolvers
string[] | undefined

A list of IP addresses of DNS resolver endpoints for the VPC connection.

Tags
Tag[] | undefined

A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

CreateVPCConnectionCommand Output

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

The Amazon Resource Name (ARN) of the VPC connection.

AvailabilityStatus
VPCConnectionAvailabilityStatus | undefined

The availability status of the VPC connection.

CreationStatus
VPCConnectionResourceStatus | undefined

The status of the creation of the VPC connection.

RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

VPCConnectionId
string | undefined

The ID for the VPC connection that you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

ConflictException
client

Updating or deleting a resource can cause an inconsistent state.

InternalFailureException
server

An internal failure occurred.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

LimitExceededException
client

A limit is exceeded.

ResourceExistsException
client

The resource specified already exists.

ThrottlingException
client

Access is throttled.

UnsupportedUserEditionException
client

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.