1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. quicksight
  6. VpcConnection

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Definition of the AWS::QuickSight::VPCConnection Resource Type.

    Create VpcConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcConnection(name: string, args?: VpcConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def VpcConnection(resource_name: str,
                      args: Optional[VpcConnectionArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      availability_status: Optional[VpcConnectionVpcConnectionAvailabilityStatus] = None,
                      aws_account_id: Optional[str] = None,
                      dns_resolvers: Optional[Sequence[str]] = None,
                      name: Optional[str] = None,
                      role_arn: Optional[str] = None,
                      security_group_ids: Optional[Sequence[str]] = None,
                      subnet_ids: Optional[Sequence[str]] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                      vpc_connection_id: Optional[str] = None)
    func NewVpcConnection(ctx *Context, name string, args *VpcConnectionArgs, opts ...ResourceOption) (*VpcConnection, error)
    public VpcConnection(string name, VpcConnectionArgs? args = null, CustomResourceOptions? opts = null)
    public VpcConnection(String name, VpcConnectionArgs args)
    public VpcConnection(String name, VpcConnectionArgs args, CustomResourceOptions options)
    
    type: aws-native:quicksight:VpcConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_quicksight_vpc_connection" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    VpcConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpcConnection resource accepts the following input properties:

    AvailabilityStatus Pulumi.AwsNative.QuickSight.VpcConnectionVpcConnectionAvailabilityStatus
    The availability status of the VPC connection.
    AwsAccountId string
    The AWS account ID of the account where you want to create a new VPC connection.
    DnsResolvers List<string>
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    Name string
    The display name for the VPC connection.
    RoleArn string
    The ARN of the IAM role associated with the VPC connection.
    SecurityGroupIds List<string>
    The Amazon EC2 security group IDs associated with the VPC connection.
    SubnetIds List<string>
    A list of subnet IDs for the VPC connection.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    VpcConnectionId string
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    AvailabilityStatus VpcConnectionVpcConnectionAvailabilityStatus
    The availability status of the VPC connection.
    AwsAccountId string
    The AWS account ID of the account where you want to create a new VPC connection.
    DnsResolvers []string
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    Name string
    The display name for the VPC connection.
    RoleArn string
    The ARN of the IAM role associated with the VPC connection.
    SecurityGroupIds []string
    The Amazon EC2 security group IDs associated with the VPC connection.
    SubnetIds []string
    A list of subnet IDs for the VPC connection.
    Tags TagArgs
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    VpcConnectionId string
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    availability_status "AVAILABLE" | "UNAVAILABLE" | "PARTIALLY_AVAILABLE"
    The availability status of the VPC connection.
    aws_account_id string
    The AWS account ID of the account where you want to create a new VPC connection.
    dns_resolvers list(string)
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name string
    The display name for the VPC connection.
    role_arn string
    The ARN of the IAM role associated with the VPC connection.
    security_group_ids list(string)
    The Amazon EC2 security group IDs associated with the VPC connection.
    subnet_ids list(string)
    A list of subnet IDs for the VPC connection.
    tags list(object)
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    vpc_connection_id string
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    availabilityStatus VpcConnectionVpcConnectionAvailabilityStatus
    The availability status of the VPC connection.
    awsAccountId String
    The AWS account ID of the account where you want to create a new VPC connection.
    dnsResolvers List<String>
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name String
    The display name for the VPC connection.
    roleArn String
    The ARN of the IAM role associated with the VPC connection.
    securityGroupIds List<String>
    The Amazon EC2 security group IDs associated with the VPC connection.
    subnetIds List<String>
    A list of subnet IDs for the VPC connection.
    tags List<Tag>
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    vpcConnectionId String
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    availabilityStatus VpcConnectionVpcConnectionAvailabilityStatus
    The availability status of the VPC connection.
    awsAccountId string
    The AWS account ID of the account where you want to create a new VPC connection.
    dnsResolvers string[]
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name string
    The display name for the VPC connection.
    roleArn string
    The ARN of the IAM role associated with the VPC connection.
    securityGroupIds string[]
    The Amazon EC2 security group IDs associated with the VPC connection.
    subnetIds string[]
    A list of subnet IDs for the VPC connection.
    tags Tag[]
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    vpcConnectionId string
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    availability_status VpcConnectionVpcConnectionAvailabilityStatus
    The availability status of the VPC connection.
    aws_account_id str
    The AWS account ID of the account where you want to create a new VPC connection.
    dns_resolvers Sequence[str]
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name str
    The display name for the VPC connection.
    role_arn str
    The ARN of the IAM role associated with the VPC connection.
    security_group_ids Sequence[str]
    The Amazon EC2 security group IDs associated with the VPC connection.
    subnet_ids Sequence[str]
    A list of subnet IDs for the VPC connection.
    tags Sequence[TagArgs]
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    vpc_connection_id str
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.
    availabilityStatus "AVAILABLE" | "UNAVAILABLE" | "PARTIALLY_AVAILABLE"
    The availability status of the VPC connection.
    awsAccountId String
    The AWS account ID of the account where you want to create a new VPC connection.
    dnsResolvers List<String>
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name String
    The display name for the VPC connection.
    roleArn String
    The ARN of the IAM role associated with the VPC connection.
    securityGroupIds List<String>
    The Amazon EC2 security group IDs associated with the VPC connection.
    subnetIds List<String>
    A list of subnet IDs for the VPC connection.
    tags List<Property Map>
    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
    vpcConnectionId String
    The ID of the VPC connection that you're creating. This ID is a unique identifier for each AWS Region in an AWS account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcConnection resource produces the following output properties:

    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    NetworkInterfaces []VpcConnectionNetworkInterface
    Status VpcConnectionVpcConnectionResourceStatus
    The HTTP status of the request.
    VpcId string
    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    networkInterfaces List<VpcConnectionNetworkInterface>
    status VpcConnectionVpcConnectionResourceStatus
    The HTTP status of the request.
    vpcId String
    arn string
    createdTime string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    networkInterfaces VpcConnectionNetworkInterface[]
    status VpcConnectionVpcConnectionResourceStatus
    The HTTP status of the request.
    vpcId string
    arn str
    created_time str
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    network_interfaces Sequence[VpcConnectionNetworkInterface]
    status VpcConnectionVpcConnectionResourceStatus
    The HTTP status of the request.
    vpc_id str

    Look up Existing VpcConnection Resource

    Get an existing VpcConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): VpcConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> VpcConnection
    func GetVpcConnection(ctx *Context, name string, id IDInput, state *VpcConnectionState, opts ...ResourceOption) (*VpcConnection, error)
    public static VpcConnection Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static VpcConnection get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingVpcConnection:    type: aws-native:quicksight:VpcConnection    get:      id: ${id}
    import {
      to = aws-native_quicksight_vpc_connection.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state VpcConnectionState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    VpcConnectionNetworkInterface

    AvailabilityZone string
    ErrorMessage string
    NetworkInterfaceId string
    Status VpcConnectionNetworkInterfaceStatus
    The status of the network interface.
    SubnetId string
    availabilityZone String
    errorMessage String
    networkInterfaceId String
    status VpcConnectionNetworkInterfaceStatus
    The status of the network interface.
    subnetId String
    availabilityZone string
    errorMessage string
    networkInterfaceId string
    status VpcConnectionNetworkInterfaceStatus
    The status of the network interface.
    subnetId string

    VpcConnectionNetworkInterfaceStatus

    NameValue
    CreatingCREATING
    AvailableAVAILABLE
    CreationFailedCREATION_FAILED
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    DeletedDELETED
    DeletionFailedDELETION_FAILED
    DeletionScheduledDELETION_SCHEDULED
    AttachmentFailedRollbackFailedATTACHMENT_FAILED_ROLLBACK_FAILED
    NameValue
    VpcConnectionNetworkInterfaceStatusCreatingCREATING
    VpcConnectionNetworkInterfaceStatusAvailableAVAILABLE
    VpcConnectionNetworkInterfaceStatusCreationFailedCREATION_FAILED
    VpcConnectionNetworkInterfaceStatusUpdatingUPDATING
    VpcConnectionNetworkInterfaceStatusUpdateFailedUPDATE_FAILED
    VpcConnectionNetworkInterfaceStatusDeletingDELETING
    VpcConnectionNetworkInterfaceStatusDeletedDELETED
    VpcConnectionNetworkInterfaceStatusDeletionFailedDELETION_FAILED
    VpcConnectionNetworkInterfaceStatusDeletionScheduledDELETION_SCHEDULED
    VpcConnectionNetworkInterfaceStatusAttachmentFailedRollbackFailedATTACHMENT_FAILED_ROLLBACK_FAILED
    Value
    CREATING
    AVAILABLE
    CREATION_FAILED
    UPDATING
    UPDATE_FAILED
    DELETING
    DELETED
    DELETION_FAILED
    DELETION_SCHEDULED
    ATTACHMENT_FAILED_ROLLBACK_FAILED
    NameValue
    CreatingCREATING
    AvailableAVAILABLE
    CreationFailedCREATION_FAILED
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    DeletedDELETED
    DeletionFailedDELETION_FAILED
    DeletionScheduledDELETION_SCHEDULED
    AttachmentFailedRollbackFailedATTACHMENT_FAILED_ROLLBACK_FAILED
    NameValue
    CreatingCREATING
    AvailableAVAILABLE
    CreationFailedCREATION_FAILED
    UpdatingUPDATING
    UpdateFailedUPDATE_FAILED
    DeletingDELETING
    DeletedDELETED
    DeletionFailedDELETION_FAILED
    DeletionScheduledDELETION_SCHEDULED
    AttachmentFailedRollbackFailedATTACHMENT_FAILED_ROLLBACK_FAILED
    NameValue
    CREATINGCREATING
    AVAILABLEAVAILABLE
    CREATION_FAILEDCREATION_FAILED
    UPDATINGUPDATING
    UPDATE_FAILEDUPDATE_FAILED
    DELETINGDELETING
    DELETEDDELETED
    DELETION_FAILEDDELETION_FAILED
    DELETION_SCHEDULEDDELETION_SCHEDULED
    ATTACHMENT_FAILED_ROLLBACK_FAILEDATTACHMENT_FAILED_ROLLBACK_FAILED
    Value
    CREATING
    AVAILABLE
    CREATION_FAILED
    UPDATING
    UPDATE_FAILED
    DELETING
    DELETED
    DELETION_FAILED
    DELETION_SCHEDULED
    ATTACHMENT_FAILED_ROLLBACK_FAILED

    VpcConnectionVpcConnectionAvailabilityStatus

    NameValue
    AvailableAVAILABLE
    UnavailableUNAVAILABLE
    PartiallyAvailablePARTIALLY_AVAILABLE
    NameValue
    VpcConnectionVpcConnectionAvailabilityStatusAvailableAVAILABLE
    VpcConnectionVpcConnectionAvailabilityStatusUnavailableUNAVAILABLE
    VpcConnectionVpcConnectionAvailabilityStatusPartiallyAvailablePARTIALLY_AVAILABLE
    Value
    AVAILABLE
    UNAVAILABLE
    PARTIALLY_AVAILABLE
    NameValue
    AvailableAVAILABLE
    UnavailableUNAVAILABLE
    PartiallyAvailablePARTIALLY_AVAILABLE
    NameValue
    AvailableAVAILABLE
    UnavailableUNAVAILABLE
    PartiallyAvailablePARTIALLY_AVAILABLE
    NameValue
    AVAILABLEAVAILABLE
    UNAVAILABLEUNAVAILABLE
    PARTIALLY_AVAILABLEPARTIALLY_AVAILABLE
    Value
    AVAILABLE
    UNAVAILABLE
    PARTIALLY_AVAILABLE

    VpcConnectionVpcConnectionResourceStatus

    NameValue
    CreationInProgressCREATION_IN_PROGRESS
    CreationSuccessfulCREATION_SUCCESSFUL
    CreationFailedCREATION_FAILED
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    DeletionInProgressDELETION_IN_PROGRESS
    DeletionFailedDELETION_FAILED
    DeletedDELETED
    NameValue
    VpcConnectionVpcConnectionResourceStatusCreationInProgressCREATION_IN_PROGRESS
    VpcConnectionVpcConnectionResourceStatusCreationSuccessfulCREATION_SUCCESSFUL
    VpcConnectionVpcConnectionResourceStatusCreationFailedCREATION_FAILED
    VpcConnectionVpcConnectionResourceStatusUpdateInProgressUPDATE_IN_PROGRESS
    VpcConnectionVpcConnectionResourceStatusUpdateSuccessfulUPDATE_SUCCESSFUL
    VpcConnectionVpcConnectionResourceStatusUpdateFailedUPDATE_FAILED
    VpcConnectionVpcConnectionResourceStatusDeletionInProgressDELETION_IN_PROGRESS
    VpcConnectionVpcConnectionResourceStatusDeletionFailedDELETION_FAILED
    VpcConnectionVpcConnectionResourceStatusDeletedDELETED
    Value
    CREATION_IN_PROGRESS
    CREATION_SUCCESSFUL
    CREATION_FAILED
    UPDATE_IN_PROGRESS
    UPDATE_SUCCESSFUL
    UPDATE_FAILED
    DELETION_IN_PROGRESS
    DELETION_FAILED
    DELETED
    NameValue
    CreationInProgressCREATION_IN_PROGRESS
    CreationSuccessfulCREATION_SUCCESSFUL
    CreationFailedCREATION_FAILED
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    DeletionInProgressDELETION_IN_PROGRESS
    DeletionFailedDELETION_FAILED
    DeletedDELETED
    NameValue
    CreationInProgressCREATION_IN_PROGRESS
    CreationSuccessfulCREATION_SUCCESSFUL
    CreationFailedCREATION_FAILED
    UpdateInProgressUPDATE_IN_PROGRESS
    UpdateSuccessfulUPDATE_SUCCESSFUL
    UpdateFailedUPDATE_FAILED
    DeletionInProgressDELETION_IN_PROGRESS
    DeletionFailedDELETION_FAILED
    DeletedDELETED
    NameValue
    CREATION_IN_PROGRESSCREATION_IN_PROGRESS
    CREATION_SUCCESSFULCREATION_SUCCESSFUL
    CREATION_FAILEDCREATION_FAILED
    UPDATE_IN_PROGRESSUPDATE_IN_PROGRESS
    UPDATE_SUCCESSFULUPDATE_SUCCESSFUL
    UPDATE_FAILEDUPDATE_FAILED
    DELETION_IN_PROGRESSDELETION_IN_PROGRESS
    DELETION_FAILEDDELETION_FAILED
    DELETEDDELETED
    Value
    CREATION_IN_PROGRESS
    CREATION_SUCCESSFUL
    CREATION_FAILED
    UPDATE_IN_PROGRESS
    UPDATE_SUCCESSFUL
    UPDATE_FAILED
    DELETION_IN_PROGRESS
    DELETION_FAILED
    DELETED

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial