Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. VpcAttachment
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.VpcAttachment

Explore with Pulumi AI

nsxt logo
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
vmware/terraform-provider-nsxt

    Create VpcAttachment Resource

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

    Constructor syntax

    new VpcAttachment(name: string, args: VpcAttachmentArgs, opts?: CustomResourceOptions);
    @overload
def VpcAttachment(resource_name: str,
                  args: VpcAttachmentArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def VpcAttachment(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  parent_path: Optional[str] = None,
                  vpc_connectivity_profile: Optional[str] = None,
                  description: Optional[str] = None,
                  nsx_id: Optional[str] = None,
                  tags: Optional[Sequence[VpcAttachmentTagArgs]] = None,
                  vpc_attachment_id: Optional[str] = None)
    func NewVpcAttachment(ctx *Context, name string, args VpcAttachmentArgs, opts ...ResourceOption) (*VpcAttachment, error)
    public VpcAttachment(string name, VpcAttachmentArgs args, CustomResourceOptions? opts = null)
    public VpcAttachment(String name, VpcAttachmentArgs args)
public VpcAttachment(String name, VpcAttachmentArgs args, CustomResourceOptions options)

    type: nsxt:VpcAttachment
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 VpcAttachmentArgs
    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 VpcAttachmentArgs
    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 VpcAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcAttachmentArgs
    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 vpcAttachmentResource = new Nsxt.VpcAttachment("vpcAttachmentResource", new()
{
    DisplayName = "string",
    ParentPath = "string",
    VpcConnectivityProfile = "string",
    Description = "string",
    NsxId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.VpcAttachmentTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    VpcAttachmentId = "string",
});

    example, err := nsxt.NewVpcAttachment(ctx, "vpcAttachmentResource", &nsxt.VpcAttachmentArgs{
	DisplayName:            pulumi.String("string"),
	ParentPath:             pulumi.String("string"),
	VpcConnectivityProfile: pulumi.String("string"),
	Description:            pulumi.String("string"),
	NsxId:                  pulumi.String("string"),
	Tags: nsxt.VpcAttachmentTagArray{
		&nsxt.VpcAttachmentTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	VpcAttachmentId: pulumi.String("string"),
})

    var vpcAttachmentResource = new VpcAttachment("vpcAttachmentResource", VpcAttachmentArgs.builder()
    .displayName("string")
    .parentPath("string")
    .vpcConnectivityProfile("string")
    .description("string")
    .nsxId("string")
    .tags(VpcAttachmentTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .vpcAttachmentId("string")
    .build());

    vpc_attachment_resource = nsxt.VpcAttachment("vpcAttachmentResource",
    display_name="string",
    parent_path="string",
    vpc_connectivity_profile="string",
    description="string",
    nsx_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    vpc_attachment_id="string")

    const vpcAttachmentResource = new nsxt.VpcAttachment("vpcAttachmentResource", {
    displayName: "string",
    parentPath: "string",
    vpcConnectivityProfile: "string",
    description: "string",
    nsxId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    vpcAttachmentId: "string",
});

    type: nsxt:VpcAttachment
properties:
    description: string
    displayName: string
    nsxId: string
    parentPath: string
    tags:
        - scope: string
          tag: string
    vpcAttachmentId: string
    vpcConnectivityProfile: string

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

    DisplayName string
    Display name of the resource.
    ParentPath string
    Policy path of parent VPC object.
    VpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Tags List<VpcAttachmentTag>
    A list of scope + tag pairs to associate with this resource.
    VpcAttachmentId string
    ID of the resource.
    DisplayName string
    Display name of the resource.
    ParentPath string
    Policy path of parent VPC object.
    VpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Tags []VpcAttachmentTagArgs
    A list of scope + tag pairs to associate with this resource.
    VpcAttachmentId string
    ID of the resource.
    displayName String
    Display name of the resource.
    parentPath String
    Policy path of parent VPC object.
    vpcConnectivityProfile String
    Path of VPC connectivity profile to attach to the VPC.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags List<VpcAttachmentTag>
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId String
    ID of the resource.
    displayName string
    Display name of the resource.
    parentPath string
    Policy path of parent VPC object.
    vpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags VpcAttachmentTag[]
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId string
    ID of the resource.
    display_name str
    Display name of the resource.
    parent_path str
    Policy path of parent VPC object.
    vpc_connectivity_profile str
    Path of VPC connectivity profile to attach to the VPC.
    description str
    Description of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags Sequence[VpcAttachmentTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vpc_attachment_id str
    ID of the resource.
    displayName String
    Display name of the resource.
    parentPath String
    Policy path of parent VPC object.
    vpcConnectivityProfile String
    Path of VPC connectivity profile to attach to the VPC.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId String
    ID of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing VpcAttachment Resource

    Get an existing VpcAttachment 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?: VpcAttachmentState, opts?: CustomResourceOptions): VpcAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        parent_path: Optional[str] = None,
        path: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[VpcAttachmentTagArgs]] = None,
        vpc_attachment_id: Optional[str] = None,
        vpc_connectivity_profile: Optional[str] = None) -> VpcAttachment
    func GetVpcAttachment(ctx *Context, name string, id IDInput, state *VpcAttachmentState, opts ...ResourceOption) (*VpcAttachment, error)
    public static VpcAttachment Get(string name, Input<string> id, VpcAttachmentState? state, CustomResourceOptions? opts = null)
    public static VpcAttachment get(String name, Output<String> id, VpcAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:VpcAttachment    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:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ParentPath string
    Policy path of parent VPC object.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<VpcAttachmentTag>
    A list of scope + tag pairs to associate with this resource.
    VpcAttachmentId string
    ID of the resource.
    VpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ParentPath string
    Policy path of parent VPC object.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []VpcAttachmentTagArgs
    A list of scope + tag pairs to associate with this resource.
    VpcAttachmentId string
    ID of the resource.
    VpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath String
    Policy path of parent VPC object.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<VpcAttachmentTag>
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId String
    ID of the resource.
    vpcConnectivityProfile String
    Path of VPC connectivity profile to attach to the VPC.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath string
    Policy path of parent VPC object.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags VpcAttachmentTag[]
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId string
    ID of the resource.
    vpcConnectivityProfile string
    Path of VPC connectivity profile to attach to the VPC.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parent_path str
    Policy path of parent VPC object.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[VpcAttachmentTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vpc_attachment_id str
    ID of the resource.
    vpc_connectivity_profile str
    Path of VPC connectivity profile to attach to the VPC.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath String
    Policy path of parent VPC object.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vpcAttachmentId String
    ID of the resource.
    vpcConnectivityProfile String
    Path of VPC connectivity profile to attach to the VPC.

    Supporting Types

    VpcAttachmentTag, VpcAttachmentTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
    vmware/terraform-provider-nsxt