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

nsxt.PolicyTransitGateway

Explore with Pulumi AI

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

    Create PolicyTransitGateway Resource

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

    Constructor syntax

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

@overload
def PolicyTransitGateway(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         context: Optional[PolicyTransitGatewayContextArgs] = None,
                         display_name: Optional[str] = None,
                         description: Optional[str] = None,
                         nsx_id: Optional[str] = None,
                         policy_transit_gateway_id: Optional[str] = None,
                         tags: Optional[Sequence[PolicyTransitGatewayTagArgs]] = None,
                         transit_subnets: Optional[Sequence[str]] = None)
    func NewPolicyTransitGateway(ctx *Context, name string, args PolicyTransitGatewayArgs, opts ...ResourceOption) (*PolicyTransitGateway, error)
    public PolicyTransitGateway(string name, PolicyTransitGatewayArgs args, CustomResourceOptions? opts = null)
    public PolicyTransitGateway(String name, PolicyTransitGatewayArgs args)
public PolicyTransitGateway(String name, PolicyTransitGatewayArgs args, CustomResourceOptions options)

    type: nsxt:PolicyTransitGateway
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 PolicyTransitGatewayArgs
    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 PolicyTransitGatewayArgs
    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 PolicyTransitGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyTransitGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyTransitGatewayArgs
    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 policyTransitGatewayResource = new Nsxt.PolicyTransitGateway("policyTransitGatewayResource", new()
{
    Context = new Nsxt.Inputs.PolicyTransitGatewayContextArgs
    {
        ProjectId = "string",
    },
    DisplayName = "string",
    Description = "string",
    NsxId = "string",
    PolicyTransitGatewayId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyTransitGatewayTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    TransitSubnets = new[]
    {
        "string",
    },
});

    example, err := nsxt.NewPolicyTransitGateway(ctx, "policyTransitGatewayResource", &nsxt.PolicyTransitGatewayArgs{
	Context: &nsxt.PolicyTransitGatewayContextArgs{
		ProjectId: pulumi.String("string"),
	},
	DisplayName:            pulumi.String("string"),
	Description:            pulumi.String("string"),
	NsxId:                  pulumi.String("string"),
	PolicyTransitGatewayId: pulumi.String("string"),
	Tags: nsxt.PolicyTransitGatewayTagArray{
		&nsxt.PolicyTransitGatewayTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	TransitSubnets: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var policyTransitGatewayResource = new PolicyTransitGateway("policyTransitGatewayResource", PolicyTransitGatewayArgs.builder()
    .context(PolicyTransitGatewayContextArgs.builder()
        .projectId("string")
        .build())
    .displayName("string")
    .description("string")
    .nsxId("string")
    .policyTransitGatewayId("string")
    .tags(PolicyTransitGatewayTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .transitSubnets("string")
    .build());

    policy_transit_gateway_resource = nsxt.PolicyTransitGateway("policyTransitGatewayResource",
    context={
        "project_id": "string",
    },
    display_name="string",
    description="string",
    nsx_id="string",
    policy_transit_gateway_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    transit_subnets=["string"])

    const policyTransitGatewayResource = new nsxt.PolicyTransitGateway("policyTransitGatewayResource", {
    context: {
        projectId: "string",
    },
    displayName: "string",
    description: "string",
    nsxId: "string",
    policyTransitGatewayId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    transitSubnets: ["string"],
});

    type: nsxt:PolicyTransitGateway
properties:
    context:
        projectId: string
    description: string
    displayName: string
    nsxId: string
    policyTransitGatewayId: string
    tags:
        - scope: string
          tag: string
    transitSubnets:
        - string

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

    Context PolicyTransitGatewayContext
    Resource context
    DisplayName string
    Display name of the resource.
    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.
    PolicyTransitGatewayId string
    ID of the resource.
    Tags List<PolicyTransitGatewayTag>
    A list of scope + tag pairs to associate with this resource.
    TransitSubnets List<string>
    Array of IPV4 CIDRs for internal VPC attachment networks.
    Context PolicyTransitGatewayContextArgs
    Resource context
    DisplayName string
    Display name of the resource.
    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.
    PolicyTransitGatewayId string
    ID of the resource.
    Tags []PolicyTransitGatewayTagArgs
    A list of scope + tag pairs to associate with this resource.
    TransitSubnets []string
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContext
    Resource context
    displayName String
    Display name of the resource.
    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.
    policyTransitGatewayId String
    ID of the resource.
    tags List<PolicyTransitGatewayTag>
    A list of scope + tag pairs to associate with this resource.
    transitSubnets List<String>
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContext
    Resource context
    displayName string
    Display name of the resource.
    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.
    policyTransitGatewayId string
    ID of the resource.
    tags PolicyTransitGatewayTag[]
    A list of scope + tag pairs to associate with this resource.
    transitSubnets string[]
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContextArgs
    Resource context
    display_name str
    Display name of the resource.
    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.
    policy_transit_gateway_id str
    ID of the resource.
    tags Sequence[PolicyTransitGatewayTagArgs]
    A list of scope + tag pairs to associate with this resource.
    transit_subnets Sequence[str]
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context Property Map
    Resource context
    displayName String
    Display name of the resource.
    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.
    policyTransitGatewayId String
    ID of the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    transitSubnets List<String>
    Array of IPV4 CIDRs for internal VPC attachment networks.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyTransitGateway 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 PolicyTransitGateway Resource

    Get an existing PolicyTransitGateway 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?: PolicyTransitGatewayState, opts?: CustomResourceOptions): PolicyTransitGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyTransitGatewayContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_transit_gateway_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyTransitGatewayTagArgs]] = None,
        transit_subnets: Optional[Sequence[str]] = None) -> PolicyTransitGateway
    func GetPolicyTransitGateway(ctx *Context, name string, id IDInput, state *PolicyTransitGatewayState, opts ...ResourceOption) (*PolicyTransitGateway, error)
    public static PolicyTransitGateway Get(string name, Input<string> id, PolicyTransitGatewayState? state, CustomResourceOptions? opts = null)
    public static PolicyTransitGateway get(String name, Output<String> id, PolicyTransitGatewayState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyTransitGateway    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:
    Context PolicyTransitGatewayContext
    Resource context
    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.
    Path string
    The NSX path of the policy resource.
    PolicyTransitGatewayId string
    ID of the 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<PolicyTransitGatewayTag>
    A list of scope + tag pairs to associate with this resource.
    TransitSubnets List<string>
    Array of IPV4 CIDRs for internal VPC attachment networks.
    Context PolicyTransitGatewayContextArgs
    Resource context
    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.
    Path string
    The NSX path of the policy resource.
    PolicyTransitGatewayId string
    ID of the 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 []PolicyTransitGatewayTagArgs
    A list of scope + tag pairs to associate with this resource.
    TransitSubnets []string
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContext
    Resource context
    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.
    path String
    The NSX path of the policy resource.
    policyTransitGatewayId String
    ID of the 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<PolicyTransitGatewayTag>
    A list of scope + tag pairs to associate with this resource.
    transitSubnets List<String>
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContext
    Resource context
    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.
    path string
    The NSX path of the policy resource.
    policyTransitGatewayId string
    ID of the 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 PolicyTransitGatewayTag[]
    A list of scope + tag pairs to associate with this resource.
    transitSubnets string[]
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context PolicyTransitGatewayContextArgs
    Resource context
    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.
    path str
    The NSX path of the policy resource.
    policy_transit_gateway_id str
    ID of the 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[PolicyTransitGatewayTagArgs]
    A list of scope + tag pairs to associate with this resource.
    transit_subnets Sequence[str]
    Array of IPV4 CIDRs for internal VPC attachment networks.
    context Property Map
    Resource context
    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.
    path String
    The NSX path of the policy resource.
    policyTransitGatewayId String
    ID of the 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.
    transitSubnets List<String>
    Array of IPV4 CIDRs for internal VPC attachment networks.

    Supporting Types

    PolicyTransitGatewayContext, PolicyTransitGatewayContextArgs

    ProjectId string
    Id of the project which the resource belongs to.
    ProjectId string
    Id of the project which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.
    projectId string
    Id of the project which the resource belongs to.
    project_id str
    Id of the project which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.

    PolicyTransitGatewayTag, PolicyTransitGatewayTagArgs

    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