Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. VpcConnection
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.quicksight.VpcConnection

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS QuickSight VPC Connection.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const vpcConnectionRole = new aws.iam.Role("vpc_connection_role", {
    assumeRolePolicy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Effect: "Allow",
            Action: "sts:AssumeRole",
            Principal: {
                Service: "quicksight.amazonaws.com",
            },
        }],
    }),
    inlinePolicies: [{
        name: "QuickSightVPCConnectionRolePolicy",
        policy: JSON.stringify({
            Version: "2012-10-17",
            Statement: [{
                Effect: "Allow",
                Action: [
                    "ec2:CreateNetworkInterface",
                    "ec2:ModifyNetworkInterfaceAttribute",
                    "ec2:DeleteNetworkInterface",
                    "ec2:DescribeSubnets",
                    "ec2:DescribeSecurityGroups",
                ],
                Resource: ["*"],
            }],
        }),
    }],
});
const example = new aws.quicksight.VpcConnection("example", {
    vpcConnectionId: "example-connection-id",
    name: "Example Connection",
    roleArn: vpcConnectionRole.arn,
    securityGroupIds: ["sg-00000000000000000"],
    subnetIds: [
        "subnet-00000000000000000",
        "subnet-00000000000000001",
    ],
});

    import pulumi
import json
import pulumi_aws as aws

vpc_connection_role = aws.iam.Role("vpc_connection_role",
    assume_role_policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Effect": "Allow",
            "Action": "sts:AssumeRole",
            "Principal": {
                "Service": "quicksight.amazonaws.com",
            },
        }],
    }),
    inline_policies=[{
        "name": "QuickSightVPCConnectionRolePolicy",
        "policy": json.dumps({
            "Version": "2012-10-17",
            "Statement": [{
                "Effect": "Allow",
                "Action": [
                    "ec2:CreateNetworkInterface",
                    "ec2:ModifyNetworkInterfaceAttribute",
                    "ec2:DeleteNetworkInterface",
                    "ec2:DescribeSubnets",
                    "ec2:DescribeSecurityGroups",
                ],
                "Resource": ["*"],
            }],
        }),
    }])
example = aws.quicksight.VpcConnection("example",
    vpc_connection_id="example-connection-id",
    name="Example Connection",
    role_arn=vpc_connection_role.arn,
    security_group_ids=["sg-00000000000000000"],
    subnet_ids=[
        "subnet-00000000000000000",
        "subnet-00000000000000001",
    ])

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Effect": "Allow",
					"Action": "sts:AssumeRole",
					"Principal": map[string]interface{}{
						"Service": "quicksight.amazonaws.com",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Effect": "Allow",
					"Action": []string{
						"ec2:CreateNetworkInterface",
						"ec2:ModifyNetworkInterfaceAttribute",
						"ec2:DeleteNetworkInterface",
						"ec2:DescribeSubnets",
						"ec2:DescribeSecurityGroups",
					},
					"Resource": []string{
						"*",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		vpcConnectionRole, err := iam.NewRole(ctx, "vpc_connection_role", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.String(json0),
			InlinePolicies: iam.RoleInlinePolicyArray{
				&iam.RoleInlinePolicyArgs{
					Name:   pulumi.String("QuickSightVPCConnectionRolePolicy"),
					Policy: pulumi.String(json1),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = quicksight.NewVpcConnection(ctx, "example", &quicksight.VpcConnectionArgs{
			VpcConnectionId: pulumi.String("example-connection-id"),
			Name:            pulumi.String("Example Connection"),
			RoleArn:         vpcConnectionRole.Arn,
			SecurityGroupIds: pulumi.StringArray{
				pulumi.String("sg-00000000000000000"),
			},
			SubnetIds: pulumi.StringArray{
				pulumi.String("subnet-00000000000000000"),
				pulumi.String("subnet-00000000000000001"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var vpcConnectionRole = new Aws.Iam.Role("vpc_connection_role", new()
    {
        AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Effect"] = "Allow",
                    ["Action"] = "sts:AssumeRole",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["Service"] = "quicksight.amazonaws.com",
                    },
                },
            },
        }),
        InlinePolicies = new[]
        {
            new Aws.Iam.Inputs.RoleInlinePolicyArgs
            {
                Name = "QuickSightVPCConnectionRolePolicy",
                Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
                {
                    ["Version"] = "2012-10-17",
                    ["Statement"] = new[]
                    {
                        new Dictionary<string, object?>
                        {
                            ["Effect"] = "Allow",
                            ["Action"] = new[]
                            {
                                "ec2:CreateNetworkInterface",
                                "ec2:ModifyNetworkInterfaceAttribute",
                                "ec2:DeleteNetworkInterface",
                                "ec2:DescribeSubnets",
                                "ec2:DescribeSecurityGroups",
                            },
                            ["Resource"] = new[]
                            {
                                "*",
                            },
                        },
                    },
                }),
            },
        },
    });

    var example = new Aws.Quicksight.VpcConnection("example", new()
    {
        VpcConnectionId = "example-connection-id",
        Name = "Example Connection",
        RoleArn = vpcConnectionRole.Arn,
        SecurityGroupIds = new[]
        {
            "sg-00000000000000000",
        },
        SubnetIds = new[]
        {
            "subnet-00000000000000000",
            "subnet-00000000000000001",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.inputs.RoleInlinePolicyArgs;
import com.pulumi.aws.quicksight.VpcConnection;
import com.pulumi.aws.quicksight.VpcConnectionArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vpcConnectionRole = new Role("vpcConnectionRole", RoleArgs.builder()
            .assumeRolePolicy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Action", "sts:AssumeRole"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("Service", "quicksight.amazonaws.com")
                        ))
                    )))
                )))
            .inlinePolicies(RoleInlinePolicyArgs.builder()
                .name("QuickSightVPCConnectionRolePolicy")
                .policy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Action", jsonArray(
                                "ec2:CreateNetworkInterface", 
                                "ec2:ModifyNetworkInterfaceAttribute", 
                                "ec2:DeleteNetworkInterface", 
                                "ec2:DescribeSubnets", 
                                "ec2:DescribeSecurityGroups"
                            )),
                            jsonProperty("Resource", jsonArray("*"))
                        )))
                    )))
                .build())
            .build());

        var example = new VpcConnection("example", VpcConnectionArgs.builder()
            .vpcConnectionId("example-connection-id")
            .name("Example Connection")
            .roleArn(vpcConnectionRole.arn())
            .securityGroupIds("sg-00000000000000000")
            .subnetIds(            
                "subnet-00000000000000000",
                "subnet-00000000000000001")
            .build());

    }
}

    resources:
  vpcConnectionRole:
    type: aws:iam:Role
    name: vpc_connection_role
    properties:
      assumeRolePolicy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Effect: Allow
              Action: sts:AssumeRole
              Principal:
                Service: quicksight.amazonaws.com
      inlinePolicies:
        - name: QuickSightVPCConnectionRolePolicy
          policy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Effect: Allow
                  Action:
                    - ec2:CreateNetworkInterface
                    - ec2:ModifyNetworkInterfaceAttribute
                    - ec2:DeleteNetworkInterface
                    - ec2:DescribeSubnets
                    - ec2:DescribeSecurityGroups
                  Resource:
                    - '*'
  example:
    type: aws:quicksight:VpcConnection
    properties:
      vpcConnectionId: example-connection-id
      name: Example Connection
      roleArn: ${vpcConnectionRole.arn}
      securityGroupIds:
        - sg-00000000000000000
      subnetIds:
        - subnet-00000000000000000
        - subnet-00000000000000001

    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: VpcConnectionArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def VpcConnection(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  role_arn: Optional[str] = None,
                  security_group_ids: Optional[Sequence[str]] = None,
                  subnet_ids: Optional[Sequence[str]] = None,
                  vpc_connection_id: Optional[str] = None,
                  aws_account_id: Optional[str] = None,
                  dns_resolvers: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  timeouts: Optional[VpcConnectionTimeoutsArgs] = None)
    func NewVpcConnection(ctx *Context, name string, args VpcConnectionArgs, opts ...ResourceOption) (*VpcConnection, error)
    public VpcConnection(string name, VpcConnectionArgs args, CustomResourceOptions? opts = null)
    public VpcConnection(String name, VpcConnectionArgs args)
public VpcConnection(String name, VpcConnectionArgs args, CustomResourceOptions options)

    type: aws: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsVpcConnectionResource = new Aws.Quicksight.VpcConnection("awsVpcConnectionResource", new()
{
    RoleArn = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    SubnetIds = new[]
    {
        "string",
    },
    VpcConnectionId = "string",
    AwsAccountId = "string",
    DnsResolvers = new[]
    {
        "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Quicksight.Inputs.VpcConnectionTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := quicksight.NewVpcConnection(ctx, "awsVpcConnectionResource", &quicksight.VpcConnectionArgs{
	RoleArn: pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcConnectionId: pulumi.String("string"),
	AwsAccountId:    pulumi.String("string"),
	DnsResolvers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &quicksight.VpcConnectionTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var awsVpcConnectionResource = new VpcConnection("awsVpcConnectionResource", VpcConnectionArgs.builder()
    .roleArn("string")
    .securityGroupIds("string")
    .subnetIds("string")
    .vpcConnectionId("string")
    .awsAccountId("string")
    .dnsResolvers("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .timeouts(VpcConnectionTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    aws_vpc_connection_resource = aws.quicksight.VpcConnection("awsVpcConnectionResource",
    role_arn="string",
    security_group_ids=["string"],
    subnet_ids=["string"],
    vpc_connection_id="string",
    aws_account_id="string",
    dns_resolvers=["string"],
    name="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const awsVpcConnectionResource = new aws.quicksight.VpcConnection("awsVpcConnectionResource", {
    roleArn: "string",
    securityGroupIds: ["string"],
    subnetIds: ["string"],
    vpcConnectionId: "string",
    awsAccountId: "string",
    dnsResolvers: ["string"],
    name: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:quicksight:VpcConnection
properties:
    awsAccountId: string
    dnsResolvers:
        - string
    name: string
    roleArn: string
    securityGroupIds:
        - string
    subnetIds:
        - string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcConnectionId: string

    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:

    RoleArn string
    The IAM role to associate with the VPC connection.
    SecurityGroupIds List<string>
    A list of security group IDs for the VPC connection.
    SubnetIds List<string>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    VpcConnectionId string
    The ID of the VPC connection.
    AwsAccountId string
    AWS account ID.
    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.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts VpcConnectionTimeouts
    RoleArn string
    The IAM role to associate with the VPC connection.
    SecurityGroupIds []string
    A list of security group IDs for the VPC connection.
    SubnetIds []string

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    VpcConnectionId string
    The ID of the VPC connection.
    AwsAccountId string
    AWS account ID.
    DnsResolvers []string
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    Name string
    The display name for the VPC connection.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts VpcConnectionTimeoutsArgs
    roleArn String
    The IAM role to associate with the VPC connection.
    securityGroupIds List<String>
    A list of security group IDs for the VPC connection.
    subnetIds List<String>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    vpcConnectionId String
    The ID of the VPC connection.
    awsAccountId String
    AWS account ID.
    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.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts VpcConnectionTimeouts
    roleArn string
    The IAM role to associate with the VPC connection.
    securityGroupIds string[]
    A list of security group IDs for the VPC connection.
    subnetIds string[]

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    vpcConnectionId string
    The ID of the VPC connection.
    awsAccountId string
    AWS account ID.
    dnsResolvers string[]
    A list of IP addresses of DNS resolver endpoints for the VPC connection.
    name string
    The display name for the VPC connection.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts VpcConnectionTimeouts
    role_arn str
    The IAM role to associate with the VPC connection.
    security_group_ids Sequence[str]
    A list of security group IDs for the VPC connection.
    subnet_ids Sequence[str]

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    vpc_connection_id str
    The ID of the VPC connection.
    aws_account_id str
    AWS account ID.
    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.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts VpcConnectionTimeoutsArgs
    roleArn String
    The IAM role to associate with the VPC connection.
    securityGroupIds List<String>
    A list of security group IDs for the VPC connection.
    subnetIds List<String>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    vpcConnectionId String
    The ID of the VPC connection.
    awsAccountId String
    AWS account ID.
    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.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the VPC connection.
    AvailabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the VPC connection.
    AvailabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the VPC connection.
    availabilityStatus String
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the VPC connection.
    availabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the VPC connection.
    availability_status str
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the VPC connection.
    availabilityStatus String
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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>, state?: VpcConnectionState, opts?: CustomResourceOptions): VpcConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        availability_status: Optional[str] = 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[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[VpcConnectionTimeoutsArgs] = None,
        vpc_connection_id: Optional[str] = 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, VpcConnectionState? state, CustomResourceOptions? opts = null)
    public static VpcConnection get(String name, Output<String> id, VpcConnectionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the VPC connection.
    AvailabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    AwsAccountId string
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    SecurityGroupIds List<string>
    A list of security group IDs for the VPC connection.
    SubnetIds List<string>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts VpcConnectionTimeouts
    VpcConnectionId string
    The ID of the VPC connection.
    Arn string
    ARN of the VPC connection.
    AvailabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    AwsAccountId string
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    SecurityGroupIds []string
    A list of security group IDs for the VPC connection.
    SubnetIds []string

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Timeouts VpcConnectionTimeoutsArgs
    VpcConnectionId string
    The ID of the VPC connection.
    arn String
    ARN of the VPC connection.
    availabilityStatus String
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    awsAccountId String
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    securityGroupIds List<String>
    A list of security group IDs for the VPC connection.
    subnetIds List<String>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts VpcConnectionTimeouts
    vpcConnectionId String
    The ID of the VPC connection.
    arn string
    ARN of the VPC connection.
    availabilityStatus string
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    awsAccountId string
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    securityGroupIds string[]
    A list of security group IDs for the VPC connection.
    subnetIds string[]

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts VpcConnectionTimeouts
    vpcConnectionId string
    The ID of the VPC connection.
    arn str
    ARN of the VPC connection.
    availability_status str
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    aws_account_id str
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    security_group_ids Sequence[str]
    A list of security group IDs for the VPC connection.
    subnet_ids Sequence[str]

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts VpcConnectionTimeoutsArgs
    vpc_connection_id str
    The ID of the VPC connection.
    arn String
    ARN of the VPC connection.
    availabilityStatus String
    The availability status of the VPC connection. Valid values are AVAILABLE, UNAVAILABLE or PARTIALLY_AVAILABLE.
    awsAccountId String
    AWS account ID.
    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 IAM role to associate with the VPC connection.
    securityGroupIds List<String>
    A list of security group IDs for the VPC connection.
    subnetIds List<String>

    A list of subnet IDs for the VPC connection.

    The following arguments are optional:

    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    timeouts Property Map
    vpcConnectionId String
    The ID of the VPC connection.

    Supporting Types

    VpcConnectionTimeouts, VpcConnectionTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Using pulumi import, import QuickSight VPC connection using the AWS account ID and VPC connection ID separated by commas (,). For example:

    $ pulumi import aws:quicksight/vpcConnection:VpcConnection example 123456789012,example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws