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

nsxt.PolicyGatewayConnection

Explore with Pulumi AI

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

    Create PolicyGatewayConnection Resource

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

    Constructor syntax

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

@overload
def PolicyGatewayConnection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            tier0_path: Optional[str] = None,
                            advertise_outbound_route_filters: Optional[Sequence[str]] = None,
                            aggregate_routes: Optional[Sequence[str]] = None,
                            description: Optional[str] = None,
                            nsx_id: Optional[str] = None,
                            policy_gateway_connection_id: Optional[str] = None,
                            tags: Optional[Sequence[PolicyGatewayConnectionTagArgs]] = None)
    func NewPolicyGatewayConnection(ctx *Context, name string, args PolicyGatewayConnectionArgs, opts ...ResourceOption) (*PolicyGatewayConnection, error)
    public PolicyGatewayConnection(string name, PolicyGatewayConnectionArgs args, CustomResourceOptions? opts = null)
    public PolicyGatewayConnection(String name, PolicyGatewayConnectionArgs args)
public PolicyGatewayConnection(String name, PolicyGatewayConnectionArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGatewayConnection
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 PolicyGatewayConnectionArgs
    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 PolicyGatewayConnectionArgs
    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 PolicyGatewayConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGatewayConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGatewayConnectionArgs
    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 policyGatewayConnectionResource = new Nsxt.PolicyGatewayConnection("policyGatewayConnectionResource", new()
{
    DisplayName = "string",
    Tier0Path = "string",
    AdvertiseOutboundRouteFilters = new[]
    {
        "string",
    },
    AggregateRoutes = new[]
    {
        "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyGatewayConnectionId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyGatewayConnectionTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyGatewayConnection(ctx, "policyGatewayConnectionResource", &nsxt.PolicyGatewayConnectionArgs{
	DisplayName: pulumi.String("string"),
	Tier0Path:   pulumi.String("string"),
	AdvertiseOutboundRouteFilters: pulumi.StringArray{
		pulumi.String("string"),
	},
	AggregateRoutes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:               pulumi.String("string"),
	NsxId:                     pulumi.String("string"),
	PolicyGatewayConnectionId: pulumi.String("string"),
	Tags: nsxt.PolicyGatewayConnectionTagArray{
		&nsxt.PolicyGatewayConnectionTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyGatewayConnectionResource = new PolicyGatewayConnection("policyGatewayConnectionResource", PolicyGatewayConnectionArgs.builder()
    .displayName("string")
    .tier0Path("string")
    .advertiseOutboundRouteFilters("string")
    .aggregateRoutes("string")
    .description("string")
    .nsxId("string")
    .policyGatewayConnectionId("string")
    .tags(PolicyGatewayConnectionTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_gateway_connection_resource = nsxt.PolicyGatewayConnection("policyGatewayConnectionResource",
    display_name="string",
    tier0_path="string",
    advertise_outbound_route_filters=["string"],
    aggregate_routes=["string"],
    description="string",
    nsx_id="string",
    policy_gateway_connection_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyGatewayConnectionResource = new nsxt.PolicyGatewayConnection("policyGatewayConnectionResource", {
    displayName: "string",
    tier0Path: "string",
    advertiseOutboundRouteFilters: ["string"],
    aggregateRoutes: ["string"],
    description: "string",
    nsxId: "string",
    policyGatewayConnectionId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyGatewayConnection
properties:
    advertiseOutboundRouteFilters:
        - string
    aggregateRoutes:
        - string
    description: string
    displayName: string
    nsxId: string
    policyGatewayConnectionId: string
    tags:
        - scope: string
          tag: string
    tier0Path: string

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

    DisplayName string
    Display name of the resource.
    Tier0Path string
    Tier-0 gateway object path
    AdvertiseOutboundRouteFilters List<string>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    AggregateRoutes List<string>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    PolicyGatewayConnectionId string
    ID of the resource.
    Tags List<PolicyGatewayConnectionTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    Tier0Path string
    Tier-0 gateway object path
    AdvertiseOutboundRouteFilters []string
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    AggregateRoutes []string
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    PolicyGatewayConnectionId string
    ID of the resource.
    Tags []PolicyGatewayConnectionTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    tier0Path String
    Tier-0 gateway object path
    advertiseOutboundRouteFilters List<String>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes List<String>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId String
    ID of the resource.
    tags List<PolicyGatewayConnectionTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    tier0Path string
    Tier-0 gateway object path
    advertiseOutboundRouteFilters string[]
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes string[]
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId string
    ID of the resource.
    tags PolicyGatewayConnectionTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    tier0_path str
    Tier-0 gateway object path
    Sequence[str]
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregate_routes Sequence[str]
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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_gateway_connection_id str
    ID of the resource.
    tags Sequence[PolicyGatewayConnectionTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    tier0Path String
    Tier-0 gateway object path
    advertiseOutboundRouteFilters List<String>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes List<String>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId String
    ID of the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

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

    Get an existing PolicyGatewayConnection 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?: PolicyGatewayConnectionState, opts?: CustomResourceOptions): PolicyGatewayConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advertise_outbound_route_filters: Optional[Sequence[str]] = None,
        aggregate_routes: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_gateway_connection_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyGatewayConnectionTagArgs]] = None,
        tier0_path: Optional[str] = None) -> PolicyGatewayConnection
    func GetPolicyGatewayConnection(ctx *Context, name string, id IDInput, state *PolicyGatewayConnectionState, opts ...ResourceOption) (*PolicyGatewayConnection, error)
    public static PolicyGatewayConnection Get(string name, Input<string> id, PolicyGatewayConnectionState? state, CustomResourceOptions? opts = null)
    public static PolicyGatewayConnection get(String name, Output<String> id, PolicyGatewayConnectionState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGatewayConnection    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:
    AdvertiseOutboundRouteFilters List<string>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    AggregateRoutes List<string>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    PolicyGatewayConnectionId 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<PolicyGatewayConnectionTag>
    A list of scope + tag pairs to associate with this resource.
    Tier0Path string
    Tier-0 gateway object path
    AdvertiseOutboundRouteFilters []string
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    AggregateRoutes []string
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    PolicyGatewayConnectionId 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 []PolicyGatewayConnectionTagArgs
    A list of scope + tag pairs to associate with this resource.
    Tier0Path string
    Tier-0 gateway object path
    advertiseOutboundRouteFilters List<String>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes List<String>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId 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<PolicyGatewayConnectionTag>
    A list of scope + tag pairs to associate with this resource.
    tier0Path String
    Tier-0 gateway object path
    advertiseOutboundRouteFilters string[]
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes string[]
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId 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 PolicyGatewayConnectionTag[]
    A list of scope + tag pairs to associate with this resource.
    tier0Path string
    Tier-0 gateway object path
    advertise_outbound_route_filters Sequence[str]
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregate_routes Sequence[str]
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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_gateway_connection_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[PolicyGatewayConnectionTagArgs]
    A list of scope + tag pairs to associate with this resource.
    tier0_path str
    Tier-0 gateway object path
    advertiseOutboundRouteFilters List<String>
    List of prefixlist object paths that will have Transit gateway to tier-0 gateway advertise route filter.
    aggregateRoutes List<String>
    Configure aggregate TGW_PREFIXES routes on Tier-0 gateway for prefixes owned by TGW gateway. If not specified then in-use prefixes are configured as TGW_PREFIXES routes on Tier-0 gateway.
    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.
    policyGatewayConnectionId 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.
    tier0Path String
    Tier-0 gateway object path

    Supporting Types

    PolicyGatewayConnectionTag, PolicyGatewayConnectionTagArgs

    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