1. Packages
  2. Neon Provider
  3. API Docs
  4. VpcEndpointAssignment
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm

neon.VpcEndpointAssignment

Explore with Pulumi AI

neon logo
neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm

    Assigns, or updates existing assignment of a VPC endpoint to a Neon organization. See details: https://neon.tech/docs/guides/neon-private-networking#enable-private-dns

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as neon from "@pulumi/neon";
    
    const example = new neon.VpcEndpointAssignment("example", {
        label: "example",
        orgId: "org-foo-bar-01234567",
        regionId: "aws-us-east-1",
        vpcEndpointId: "vpce-1234567890abcdef0",
    });
    
    import pulumi
    import pulumi_neon as neon
    
    example = neon.VpcEndpointAssignment("example",
        label="example",
        org_id="org-foo-bar-01234567",
        region_id="aws-us-east-1",
        vpc_endpoint_id="vpce-1234567890abcdef0")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/neon/neon"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := neon.NewVpcEndpointAssignment(ctx, "example", &neon.VpcEndpointAssignmentArgs{
    			Label:         pulumi.String("example"),
    			OrgId:         pulumi.String("org-foo-bar-01234567"),
    			RegionId:      pulumi.String("aws-us-east-1"),
    			VpcEndpointId: pulumi.String("vpce-1234567890abcdef0"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Neon = Pulumi.Neon;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Neon.VpcEndpointAssignment("example", new()
        {
            Label = "example",
            OrgId = "org-foo-bar-01234567",
            RegionId = "aws-us-east-1",
            VpcEndpointId = "vpce-1234567890abcdef0",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.neon.VpcEndpointAssignment;
    import com.pulumi.neon.VpcEndpointAssignmentArgs;
    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 example = new VpcEndpointAssignment("example", VpcEndpointAssignmentArgs.builder()
                .label("example")
                .orgId("org-foo-bar-01234567")
                .regionId("aws-us-east-1")
                .vpcEndpointId("vpce-1234567890abcdef0")
                .build());
    
        }
    }
    
    resources:
      example:
        type: neon:VpcEndpointAssignment
        properties:
          label: example
          orgId: org-foo-bar-01234567
          regionId: aws-us-east-1
          vpcEndpointId: vpce-1234567890abcdef0
    

    Create VpcEndpointAssignment Resource

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

    Constructor syntax

    new VpcEndpointAssignment(name: string, args: VpcEndpointAssignmentArgs, opts?: CustomResourceOptions);
    @overload
    def VpcEndpointAssignment(resource_name: str,
                              args: VpcEndpointAssignmentArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcEndpointAssignment(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              label: Optional[str] = None,
                              org_id: Optional[str] = None,
                              region_id: Optional[str] = None,
                              vpc_endpoint_id: Optional[str] = None,
                              vpc_endpoint_assignment_id: Optional[str] = None)
    func NewVpcEndpointAssignment(ctx *Context, name string, args VpcEndpointAssignmentArgs, opts ...ResourceOption) (*VpcEndpointAssignment, error)
    public VpcEndpointAssignment(string name, VpcEndpointAssignmentArgs args, CustomResourceOptions? opts = null)
    public VpcEndpointAssignment(String name, VpcEndpointAssignmentArgs args)
    public VpcEndpointAssignment(String name, VpcEndpointAssignmentArgs args, CustomResourceOptions options)
    
    type: neon:VpcEndpointAssignment
    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 VpcEndpointAssignmentArgs
    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 VpcEndpointAssignmentArgs
    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 VpcEndpointAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcEndpointAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcEndpointAssignmentArgs
    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 vpcEndpointAssignmentResource = new Neon.VpcEndpointAssignment("vpcEndpointAssignmentResource", new()
    {
        Label = "string",
        OrgId = "string",
        RegionId = "string",
        VpcEndpointId = "string",
        VpcEndpointAssignmentId = "string",
    });
    
    example, err := neon.NewVpcEndpointAssignment(ctx, "vpcEndpointAssignmentResource", &neon.VpcEndpointAssignmentArgs{
    	Label:                   pulumi.String("string"),
    	OrgId:                   pulumi.String("string"),
    	RegionId:                pulumi.String("string"),
    	VpcEndpointId:           pulumi.String("string"),
    	VpcEndpointAssignmentId: pulumi.String("string"),
    })
    
    var vpcEndpointAssignmentResource = new VpcEndpointAssignment("vpcEndpointAssignmentResource", VpcEndpointAssignmentArgs.builder()
        .label("string")
        .orgId("string")
        .regionId("string")
        .vpcEndpointId("string")
        .vpcEndpointAssignmentId("string")
        .build());
    
    vpc_endpoint_assignment_resource = neon.VpcEndpointAssignment("vpcEndpointAssignmentResource",
        label="string",
        org_id="string",
        region_id="string",
        vpc_endpoint_id="string",
        vpc_endpoint_assignment_id="string")
    
    const vpcEndpointAssignmentResource = new neon.VpcEndpointAssignment("vpcEndpointAssignmentResource", {
        label: "string",
        orgId: "string",
        regionId: "string",
        vpcEndpointId: "string",
        vpcEndpointAssignmentId: "string",
    });
    
    type: neon:VpcEndpointAssignment
    properties:
        label: string
        orgId: string
        regionId: string
        vpcEndpointAssignmentId: string
        vpcEndpointId: string
    

    VpcEndpointAssignment 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 VpcEndpointAssignment resource accepts the following input properties:

    Label string
    A descriptive label for the VPC endpoint.
    OrgId string
    The Neon organization ID.
    RegionId string
    The Neon region ID.
    VpcEndpointId string
    The VPC endpoint ID.
    VpcEndpointAssignmentId string
    The ID of this resource.
    Label string
    A descriptive label for the VPC endpoint.
    OrgId string
    The Neon organization ID.
    RegionId string
    The Neon region ID.
    VpcEndpointId string
    The VPC endpoint ID.
    VpcEndpointAssignmentId string
    The ID of this resource.
    label String
    A descriptive label for the VPC endpoint.
    orgId String
    The Neon organization ID.
    regionId String
    The Neon region ID.
    vpcEndpointId String
    The VPC endpoint ID.
    vpcEndpointAssignmentId String
    The ID of this resource.
    label string
    A descriptive label for the VPC endpoint.
    orgId string
    The Neon organization ID.
    regionId string
    The Neon region ID.
    vpcEndpointId string
    The VPC endpoint ID.
    vpcEndpointAssignmentId string
    The ID of this resource.
    label str
    A descriptive label for the VPC endpoint.
    org_id str
    The Neon organization ID.
    region_id str
    The Neon region ID.
    vpc_endpoint_id str
    The VPC endpoint ID.
    vpc_endpoint_assignment_id str
    The ID of this resource.
    label String
    A descriptive label for the VPC endpoint.
    orgId String
    The Neon organization ID.
    regionId String
    The Neon region ID.
    vpcEndpointId String
    The VPC endpoint ID.
    vpcEndpointAssignmentId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VpcEndpointAssignment Resource

    Get an existing VpcEndpointAssignment 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?: VpcEndpointAssignmentState, opts?: CustomResourceOptions): VpcEndpointAssignment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            label: Optional[str] = None,
            org_id: Optional[str] = None,
            region_id: Optional[str] = None,
            vpc_endpoint_assignment_id: Optional[str] = None,
            vpc_endpoint_id: Optional[str] = None) -> VpcEndpointAssignment
    func GetVpcEndpointAssignment(ctx *Context, name string, id IDInput, state *VpcEndpointAssignmentState, opts ...ResourceOption) (*VpcEndpointAssignment, error)
    public static VpcEndpointAssignment Get(string name, Input<string> id, VpcEndpointAssignmentState? state, CustomResourceOptions? opts = null)
    public static VpcEndpointAssignment get(String name, Output<String> id, VpcEndpointAssignmentState state, CustomResourceOptions options)
    resources:  _:    type: neon:VpcEndpointAssignment    get:      id: ${id}
    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:
    Label string
    A descriptive label for the VPC endpoint.
    OrgId string
    The Neon organization ID.
    RegionId string
    The Neon region ID.
    VpcEndpointAssignmentId string
    The ID of this resource.
    VpcEndpointId string
    The VPC endpoint ID.
    Label string
    A descriptive label for the VPC endpoint.
    OrgId string
    The Neon organization ID.
    RegionId string
    The Neon region ID.
    VpcEndpointAssignmentId string
    The ID of this resource.
    VpcEndpointId string
    The VPC endpoint ID.
    label String
    A descriptive label for the VPC endpoint.
    orgId String
    The Neon organization ID.
    regionId String
    The Neon region ID.
    vpcEndpointAssignmentId String
    The ID of this resource.
    vpcEndpointId String
    The VPC endpoint ID.
    label string
    A descriptive label for the VPC endpoint.
    orgId string
    The Neon organization ID.
    regionId string
    The Neon region ID.
    vpcEndpointAssignmentId string
    The ID of this resource.
    vpcEndpointId string
    The VPC endpoint ID.
    label str
    A descriptive label for the VPC endpoint.
    org_id str
    The Neon organization ID.
    region_id str
    The Neon region ID.
    vpc_endpoint_assignment_id str
    The ID of this resource.
    vpc_endpoint_id str
    The VPC endpoint ID.
    label String
    A descriptive label for the VPC endpoint.
    orgId String
    The Neon organization ID.
    regionId String
    The Neon region ID.
    vpcEndpointAssignmentId String
    The ID of this resource.
    vpcEndpointId String
    The VPC endpoint ID.

    Import

    The VPC endpoint assignment to organization can be imported to the terraform state by its identifier.

    Import using the import block:

    For example:

    hcl

    import {

    to = neon_vpc_endpoint_assignment.example

    id = “vpce-1234567890abcdef0”

    }

    Import using the command pulumi import:

    commandline

    $ pulumi import neon:index/vpcEndpointAssignment:VpcEndpointAssignment example vpce-1234567890abcdef0
    

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

    Package Details

    Repository
    neon kislerdm/terraform-provider-neon
    License
    Notes
    This Pulumi package is based on the neon Terraform Provider.
    neon logo
    neon 0.9.0 published on Tuesday, May 6, 2025 by kislerdm