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
@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)
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
- 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.
- 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.
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
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:
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 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
VpcConnectionNetworkInterfaceStatus
| Name | Value |
|---|
| Creating | CREATING |
| Available | AVAILABLE |
| CreationFailed | CREATION_FAILED |
| Updating | UPDATING |
| UpdateFailed | UPDATE_FAILED |
| Deleting | DELETING |
| Deleted | DELETED |
| DeletionFailed | DELETION_FAILED |
| DeletionScheduled | DELETION_SCHEDULED |
| AttachmentFailedRollbackFailed | ATTACHMENT_FAILED_ROLLBACK_FAILED |
| Name | Value |
|---|
| VpcConnectionNetworkInterfaceStatusCreating | CREATING |
| VpcConnectionNetworkInterfaceStatusAvailable | AVAILABLE |
| VpcConnectionNetworkInterfaceStatusCreationFailed | CREATION_FAILED |
| VpcConnectionNetworkInterfaceStatusUpdating | UPDATING |
| VpcConnectionNetworkInterfaceStatusUpdateFailed | UPDATE_FAILED |
| VpcConnectionNetworkInterfaceStatusDeleting | DELETING |
| VpcConnectionNetworkInterfaceStatusDeleted | DELETED |
| VpcConnectionNetworkInterfaceStatusDeletionFailed | DELETION_FAILED |
| VpcConnectionNetworkInterfaceStatusDeletionScheduled | DELETION_SCHEDULED |
| VpcConnectionNetworkInterfaceStatusAttachmentFailedRollbackFailed | ATTACHMENT_FAILED_ROLLBACK_FAILED |
| Value |
|---|
CREATING |
AVAILABLE |
CREATION_FAILED |
UPDATING |
UPDATE_FAILED |
DELETING |
DELETED |
DELETION_FAILED |
DELETION_SCHEDULED |
ATTACHMENT_FAILED_ROLLBACK_FAILED |
| Name | Value |
|---|
| Creating | CREATING |
| Available | AVAILABLE |
| CreationFailed | CREATION_FAILED |
| Updating | UPDATING |
| UpdateFailed | UPDATE_FAILED |
| Deleting | DELETING |
| Deleted | DELETED |
| DeletionFailed | DELETION_FAILED |
| DeletionScheduled | DELETION_SCHEDULED |
| AttachmentFailedRollbackFailed | ATTACHMENT_FAILED_ROLLBACK_FAILED |
| Name | Value |
|---|
| Creating | CREATING |
| Available | AVAILABLE |
| CreationFailed | CREATION_FAILED |
| Updating | UPDATING |
| UpdateFailed | UPDATE_FAILED |
| Deleting | DELETING |
| Deleted | DELETED |
| DeletionFailed | DELETION_FAILED |
| DeletionScheduled | DELETION_SCHEDULED |
| AttachmentFailedRollbackFailed | ATTACHMENT_FAILED_ROLLBACK_FAILED |
| Name | Value |
|---|
| 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 |
| Value |
|---|
CREATING |
AVAILABLE |
CREATION_FAILED |
UPDATING |
UPDATE_FAILED |
DELETING |
DELETED |
DELETION_FAILED |
DELETION_SCHEDULED |
ATTACHMENT_FAILED_ROLLBACK_FAILED |
VpcConnectionVpcConnectionAvailabilityStatus
| Name | Value |
|---|
| Available | AVAILABLE |
| Unavailable | UNAVAILABLE |
| PartiallyAvailable | PARTIALLY_AVAILABLE |
| Name | Value |
|---|
| VpcConnectionVpcConnectionAvailabilityStatusAvailable | AVAILABLE |
| VpcConnectionVpcConnectionAvailabilityStatusUnavailable | UNAVAILABLE |
| VpcConnectionVpcConnectionAvailabilityStatusPartiallyAvailable | PARTIALLY_AVAILABLE |
| Value |
|---|
AVAILABLE |
UNAVAILABLE |
PARTIALLY_AVAILABLE |
| Name | Value |
|---|
| Available | AVAILABLE |
| Unavailable | UNAVAILABLE |
| PartiallyAvailable | PARTIALLY_AVAILABLE |
| Name | Value |
|---|
| Available | AVAILABLE |
| Unavailable | UNAVAILABLE |
| PartiallyAvailable | PARTIALLY_AVAILABLE |
| Name | Value |
|---|
| AVAILABLE | AVAILABLE |
| UNAVAILABLE | UNAVAILABLE |
| PARTIALLY_AVAILABLE | PARTIALLY_AVAILABLE |
| Value |
|---|
AVAILABLE |
UNAVAILABLE |
PARTIALLY_AVAILABLE |
VpcConnectionVpcConnectionResourceStatus
| Name | Value |
|---|
| CreationInProgress | CREATION_IN_PROGRESS |
| CreationSuccessful | CREATION_SUCCESSFUL |
| CreationFailed | CREATION_FAILED |
| UpdateInProgress | UPDATE_IN_PROGRESS |
| UpdateSuccessful | UPDATE_SUCCESSFUL |
| UpdateFailed | UPDATE_FAILED |
| DeletionInProgress | DELETION_IN_PROGRESS |
| DeletionFailed | DELETION_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|
| VpcConnectionVpcConnectionResourceStatusCreationInProgress | CREATION_IN_PROGRESS |
| VpcConnectionVpcConnectionResourceStatusCreationSuccessful | CREATION_SUCCESSFUL |
| VpcConnectionVpcConnectionResourceStatusCreationFailed | CREATION_FAILED |
| VpcConnectionVpcConnectionResourceStatusUpdateInProgress | UPDATE_IN_PROGRESS |
| VpcConnectionVpcConnectionResourceStatusUpdateSuccessful | UPDATE_SUCCESSFUL |
| VpcConnectionVpcConnectionResourceStatusUpdateFailed | UPDATE_FAILED |
| VpcConnectionVpcConnectionResourceStatusDeletionInProgress | DELETION_IN_PROGRESS |
| VpcConnectionVpcConnectionResourceStatusDeletionFailed | DELETION_FAILED |
| VpcConnectionVpcConnectionResourceStatusDeleted | DELETED |
| Value |
|---|
CREATION_IN_PROGRESS |
CREATION_SUCCESSFUL |
CREATION_FAILED |
UPDATE_IN_PROGRESS |
UPDATE_SUCCESSFUL |
UPDATE_FAILED |
DELETION_IN_PROGRESS |
DELETION_FAILED |
DELETED |
| Name | Value |
|---|
| CreationInProgress | CREATION_IN_PROGRESS |
| CreationSuccessful | CREATION_SUCCESSFUL |
| CreationFailed | CREATION_FAILED |
| UpdateInProgress | UPDATE_IN_PROGRESS |
| UpdateSuccessful | UPDATE_SUCCESSFUL |
| UpdateFailed | UPDATE_FAILED |
| DeletionInProgress | DELETION_IN_PROGRESS |
| DeletionFailed | DELETION_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|
| CreationInProgress | CREATION_IN_PROGRESS |
| CreationSuccessful | CREATION_SUCCESSFUL |
| CreationFailed | CREATION_FAILED |
| UpdateInProgress | UPDATE_IN_PROGRESS |
| UpdateSuccessful | UPDATE_SUCCESSFUL |
| UpdateFailed | UPDATE_FAILED |
| DeletionInProgress | DELETION_IN_PROGRESS |
| DeletionFailed | DELETION_FAILED |
| Deleted | DELETED |
| Name | Value |
|---|
| 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 |
| 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