We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
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.
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:
- Availability
Status Pulumi.Aws Native. Quick Sight. Vpc Connection Vpc Connection Availability Status - The availability status of the VPC connection.
- Aws
Account stringId - 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 List<string>Ids - The Amazon EC2 security group IDs associated with the VPC connection.
- Subnet
Ids List<string> - A list of subnet IDs for the VPC connection.
-
List<Pulumi.
Aws Native. Inputs. Tag> - A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- Vpc
Connection stringId - 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 VpcConnection Vpc Connection Availability Status - The availability status of the VPC connection.
- Aws
Account stringId - The AWS account ID of the account where you want to create a new VPC connection.
- Dns
Resolvers []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 []stringIds - The Amazon EC2 security group IDs associated with the VPC connection.
- Subnet
Ids []string - A list of subnet IDs for the VPC connection.
-
Tag
Args - A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- Vpc
Connection stringId - 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 VpcConnection Vpc Connection Availability Status - The availability status of the VPC connection.
- aws
Account StringId - 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 List<String>Ids - The Amazon EC2 security group IDs associated with the VPC connection.
- subnet
Ids List<String> - A list of subnet IDs for the VPC connection.
- List<Tag>
- A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- vpc
Connection StringId - 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 VpcConnection Vpc Connection Availability Status - The availability status of the VPC connection.
- aws
Account stringId - The AWS account ID of the account where you want to create a new VPC connection.
- dns
Resolvers 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 string[]Ids - The Amazon EC2 security group IDs associated with the VPC connection.
- subnet
Ids string[] - A list of subnet IDs for the VPC connection.
- Tag[]
- A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- vpc
Connection stringId - 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 VpcConnection Vpc Connection Availability Status - The availability status of the VPC connection.
- aws_
account_ strid - 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_ Sequence[str]ids - The Amazon EC2 security group IDs associated with the VPC connection.
- subnet_
ids Sequence[str] - A list of subnet IDs for the VPC connection.
-
Sequence[Tag
Args] - A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- vpc_
connection_ strid - 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 StringId - 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 List<String>Ids - The Amazon EC2 security group IDs associated with the VPC connection.
- subnet
Ids List<String> - A list of subnet IDs for the VPC connection.
- List<Property Map>
- A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
- vpc
Connection StringId - 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
- Created
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - Network
Interfaces List<Pulumi.Aws Native. Quick Sight. Outputs. Vpc Connection Network Interface> - Status
Pulumi.
Aws Native. Quick Sight. Vpc Connection Vpc Connection Resource Status - The HTTP status of the request.
- Vpc
Id string
- Arn string
- Created
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime - Network
Interfaces []VpcConnection Network Interface - Status
Vpc
Connection Vpc Connection Resource Status - The HTTP status of the request.
- Vpc
Id string
- arn String
- created
Time String - id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - network
Interfaces List<VpcConnection Network Interface> - status
Vpc
Connection Vpc Connection Resource Status - The HTTP status of the request.
- vpc
Id String
- arn string
- created
Time string - id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringTime - network
Interfaces VpcConnection Network Interface[] - status
Vpc
Connection Vpc Connection Resource Status - The HTTP status of the request.
- vpc
Id string
- arn str
- created_
time str - id str
- The provider-assigned unique ID for this managed resource.
- last_
updated_ strtime - network_
interfaces Sequence[VpcConnection Network Interface] - status
Vpc
Connection Vpc Connection Resource Status - The HTTP status of the request.
- vpc_
id str
- arn String
- created
Time String - id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringTime - network
Interfaces List<Property Map> - status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETION_IN_PROGRESS" | "DELETION_FAILED" | "DELETED"
- The HTTP status of the request.
- vpc
Id String
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.VpcConnectionNetworkInterface, VpcConnectionNetworkInterfaceArgs
- Availability
Zone string - Error
Message string - Network
Interface stringId - Status
Pulumi.
Aws Native. Quick Sight. Vpc Connection Network Interface Status - The status of the network interface.
- Subnet
Id string
- Availability
Zone string - Error
Message string - Network
Interface stringId - Status
Vpc
Connection Network Interface Status - The status of the network interface.
- Subnet
Id string
- availability
Zone String - error
Message String - network
Interface StringId - status
Vpc
Connection Network Interface Status - The status of the network interface.
- subnet
Id String
- availability
Zone string - error
Message string - network
Interface stringId - status
Vpc
Connection Network Interface Status - The status of the network interface.
- subnet
Id string
- availability_
zone str - error_
message str - network_
interface_ strid - status
Vpc
Connection Network Interface Status - The status of the network interface.
- subnet_
id str
- availability
Zone String - error
Message String - network
Interface StringId - status "CREATING" | "AVAILABLE" | "CREATION_FAILED" | "UPDATING" | "UPDATE_FAILED" | "DELETING" | "DELETED" | "DELETION_FAILED" | "DELETION_SCHEDULED" | "ATTACHMENT_FAILED_ROLLBACK_FAILED"
- The status of the network interface.
- subnet
Id String
VpcConnectionNetworkInterfaceStatus, VpcConnectionNetworkInterfaceStatusArgs
- Creating
CREATING- Available
AVAILABLE- Creation
Failed CREATION_FAILED- Updating
UPDATING- Update
Failed UPDATE_FAILED- Deleting
DELETING- Deleted
DELETED- Deletion
Failed DELETION_FAILED- Deletion
Scheduled DELETION_SCHEDULED- Attachment
Failed Rollback Failed ATTACHMENT_FAILED_ROLLBACK_FAILED
- Vpc
Connection Network Interface Status Creating CREATING- Vpc
Connection Network Interface Status Available AVAILABLE- Vpc
Connection Network Interface Status Creation Failed CREATION_FAILED- Vpc
Connection Network Interface Status Updating UPDATING- Vpc
Connection Network Interface Status Update Failed UPDATE_FAILED- Vpc
Connection Network Interface Status Deleting DELETING- Vpc
Connection Network Interface Status Deleted DELETED- Vpc
Connection Network Interface Status Deletion Failed DELETION_FAILED- Vpc
Connection Network Interface Status Deletion Scheduled DELETION_SCHEDULED- Vpc
Connection Network Interface Status Attachment Failed Rollback Failed ATTACHMENT_FAILED_ROLLBACK_FAILED
- Creating
CREATING- Available
AVAILABLE- Creation
Failed CREATION_FAILED- Updating
UPDATING- Update
Failed UPDATE_FAILED- Deleting
DELETING- Deleted
DELETED- Deletion
Failed DELETION_FAILED- Deletion
Scheduled DELETION_SCHEDULED- Attachment
Failed Rollback Failed ATTACHMENT_FAILED_ROLLBACK_FAILED
- Creating
CREATING- Available
AVAILABLE- Creation
Failed CREATION_FAILED- Updating
UPDATING- Update
Failed UPDATE_FAILED- Deleting
DELETING- Deleted
DELETED- Deletion
Failed DELETION_FAILED- Deletion
Scheduled DELETION_SCHEDULED- Attachment
Failed Rollback Failed ATTACHMENT_FAILED_ROLLBACK_FAILED
- CREATING
CREATING- AVAILABLE
AVAILABLE- CREATION_FAILED
CREATION_FAILED- UPDATING
UPDATING- UPDATE_FAILED
UPDATE_FAILED- DELETING
DELETING- DELETED
DELETED- DELETION_FAILED
DELETION_FAILED- DELETION_SCHEDULED
DELETION_SCHEDULED- ATTACHMENT_FAILED_ROLLBACK_FAILED
ATTACHMENT_FAILED_ROLLBACK_FAILED
- "CREATING"
CREATING- "AVAILABLE"
AVAILABLE- "CREATION_FAILED"
CREATION_FAILED- "UPDATING"
UPDATING- "UPDATE_FAILED"
UPDATE_FAILED- "DELETING"
DELETING- "DELETED"
DELETED- "DELETION_FAILED"
DELETION_FAILED- "DELETION_SCHEDULED"
DELETION_SCHEDULED- "ATTACHMENT_FAILED_ROLLBACK_FAILED"
ATTACHMENT_FAILED_ROLLBACK_FAILED
VpcConnectionVpcConnectionAvailabilityStatus, VpcConnectionVpcConnectionAvailabilityStatusArgs
- Available
AVAILABLE- Unavailable
UNAVAILABLE- Partially
Available PARTIALLY_AVAILABLE
- Vpc
Connection Vpc Connection Availability Status Available AVAILABLE- Vpc
Connection Vpc Connection Availability Status Unavailable UNAVAILABLE- Vpc
Connection Vpc Connection Availability Status Partially Available PARTIALLY_AVAILABLE
- Available
AVAILABLE- Unavailable
UNAVAILABLE- Partially
Available PARTIALLY_AVAILABLE
- Available
AVAILABLE- Unavailable
UNAVAILABLE- Partially
Available PARTIALLY_AVAILABLE
- AVAILABLE
AVAILABLE- UNAVAILABLE
UNAVAILABLE- PARTIALLY_AVAILABLE
PARTIALLY_AVAILABLE
- "AVAILABLE"
AVAILABLE- "UNAVAILABLE"
UNAVAILABLE- "PARTIALLY_AVAILABLE"
PARTIALLY_AVAILABLE
VpcConnectionVpcConnectionResourceStatus, VpcConnectionVpcConnectionResourceStatusArgs
- Creation
In Progress CREATION_IN_PROGRESS- Creation
Successful CREATION_SUCCESSFUL- Creation
Failed CREATION_FAILED- Update
In Progress UPDATE_IN_PROGRESS- Update
Successful UPDATE_SUCCESSFUL- Update
Failed UPDATE_FAILED- Deletion
In Progress DELETION_IN_PROGRESS- Deletion
Failed DELETION_FAILED- Deleted
DELETED
- Vpc
Connection Vpc Connection Resource Status Creation In Progress CREATION_IN_PROGRESS- Vpc
Connection Vpc Connection Resource Status Creation Successful CREATION_SUCCESSFUL- Vpc
Connection Vpc Connection Resource Status Creation Failed CREATION_FAILED- Vpc
Connection Vpc Connection Resource Status Update In Progress UPDATE_IN_PROGRESS- Vpc
Connection Vpc Connection Resource Status Update Successful UPDATE_SUCCESSFUL- Vpc
Connection Vpc Connection Resource Status Update Failed UPDATE_FAILED- Vpc
Connection Vpc Connection Resource Status Deletion In Progress DELETION_IN_PROGRESS- Vpc
Connection Vpc Connection Resource Status Deletion Failed DELETION_FAILED- Vpc
Connection Vpc Connection Resource Status Deleted DELETED
- Creation
In Progress CREATION_IN_PROGRESS- Creation
Successful CREATION_SUCCESSFUL- Creation
Failed CREATION_FAILED- Update
In Progress UPDATE_IN_PROGRESS- Update
Successful UPDATE_SUCCESSFUL- Update
Failed UPDATE_FAILED- Deletion
In Progress DELETION_IN_PROGRESS- Deletion
Failed DELETION_FAILED- Deleted
DELETED
- Creation
In Progress CREATION_IN_PROGRESS- Creation
Successful CREATION_SUCCESSFUL- Creation
Failed CREATION_FAILED- Update
In Progress UPDATE_IN_PROGRESS- Update
Successful UPDATE_SUCCESSFUL- Update
Failed UPDATE_FAILED- Deletion
In Progress DELETION_IN_PROGRESS- Deletion
Failed DELETION_FAILED- Deleted
DELETED
- CREATION_IN_PROGRESS
CREATION_IN_PROGRESS- CREATION_SUCCESSFUL
CREATION_SUCCESSFUL- CREATION_FAILED
CREATION_FAILED- UPDATE_IN_PROGRESS
UPDATE_IN_PROGRESS- UPDATE_SUCCESSFUL
UPDATE_SUCCESSFUL- UPDATE_FAILED
UPDATE_FAILED- DELETION_IN_PROGRESS
DELETION_IN_PROGRESS- DELETION_FAILED
DELETION_FAILED- DELETED
DELETED
- "CREATION_IN_PROGRESS"
CREATION_IN_PROGRESS- "CREATION_SUCCESSFUL"
CREATION_SUCCESSFUL- "CREATION_FAILED"
CREATION_FAILED- "UPDATE_IN_PROGRESS"
UPDATE_IN_PROGRESS- "UPDATE_SUCCESSFUL"
UPDATE_SUCCESSFUL- "UPDATE_FAILED"
UPDATE_FAILED- "DELETION_IN_PROGRESS"
DELETION_IN_PROGRESS- "DELETION_FAILED"
DELETION_FAILED- "DELETED"
DELETED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
