Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyGatewayPrefixList
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyGatewayPrefixList

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyGatewayPrefixList Resource

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

    Constructor syntax

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

@overload
def PolicyGatewayPrefixList(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            gateway_path: Optional[str] = None,
                            prefixes: Optional[Sequence[PolicyGatewayPrefixListPrefixArgs]] = None,
                            description: Optional[str] = None,
                            nsx_id: Optional[str] = None,
                            policy_gateway_prefix_list_id: Optional[str] = None,
                            tags: Optional[Sequence[PolicyGatewayPrefixListTagArgs]] = None)
    func NewPolicyGatewayPrefixList(ctx *Context, name string, args PolicyGatewayPrefixListArgs, opts ...ResourceOption) (*PolicyGatewayPrefixList, error)
    public PolicyGatewayPrefixList(string name, PolicyGatewayPrefixListArgs args, CustomResourceOptions? opts = null)
    public PolicyGatewayPrefixList(String name, PolicyGatewayPrefixListArgs args)
public PolicyGatewayPrefixList(String name, PolicyGatewayPrefixListArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGatewayPrefixList
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 PolicyGatewayPrefixListArgs
    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 PolicyGatewayPrefixListArgs
    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 PolicyGatewayPrefixListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGatewayPrefixListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGatewayPrefixListArgs
    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 policyGatewayPrefixListResource = new Nsxt.PolicyGatewayPrefixList("policyGatewayPrefixListResource", new()
{
    DisplayName = "string",
    GatewayPath = "string",
    Prefixes = new[]
    {
        new Nsxt.Inputs.PolicyGatewayPrefixListPrefixArgs
        {
            Action = "string",
            Ge = 0,
            Le = 0,
            Network = "string",
        },
    },
    Description = "string",
    NsxId = "string",
    PolicyGatewayPrefixListId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyGatewayPrefixListTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyGatewayPrefixList(ctx, "policyGatewayPrefixListResource", &nsxt.PolicyGatewayPrefixListArgs{
	DisplayName: pulumi.String("string"),
	GatewayPath: pulumi.String("string"),
	Prefixes: nsxt.PolicyGatewayPrefixListPrefixArray{
		&nsxt.PolicyGatewayPrefixListPrefixArgs{
			Action:  pulumi.String("string"),
			Ge:      pulumi.Float64(0),
			Le:      pulumi.Float64(0),
			Network: pulumi.String("string"),
		},
	},
	Description:               pulumi.String("string"),
	NsxId:                     pulumi.String("string"),
	PolicyGatewayPrefixListId: pulumi.String("string"),
	Tags: nsxt.PolicyGatewayPrefixListTagArray{
		&nsxt.PolicyGatewayPrefixListTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyGatewayPrefixListResource = new PolicyGatewayPrefixList("policyGatewayPrefixListResource", PolicyGatewayPrefixListArgs.builder()
    .displayName("string")
    .gatewayPath("string")
    .prefixes(PolicyGatewayPrefixListPrefixArgs.builder()
        .action("string")
        .ge(0)
        .le(0)
        .network("string")
        .build())
    .description("string")
    .nsxId("string")
    .policyGatewayPrefixListId("string")
    .tags(PolicyGatewayPrefixListTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_gateway_prefix_list_resource = nsxt.PolicyGatewayPrefixList("policyGatewayPrefixListResource",
    display_name="string",
    gateway_path="string",
    prefixes=[{
        "action": "string",
        "ge": 0,
        "le": 0,
        "network": "string",
    }],
    description="string",
    nsx_id="string",
    policy_gateway_prefix_list_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyGatewayPrefixListResource = new nsxt.PolicyGatewayPrefixList("policyGatewayPrefixListResource", {
    displayName: "string",
    gatewayPath: "string",
    prefixes: [{
        action: "string",
        ge: 0,
        le: 0,
        network: "string",
    }],
    description: "string",
    nsxId: "string",
    policyGatewayPrefixListId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyGatewayPrefixList
properties:
    description: string
    displayName: string
    gatewayPath: string
    nsxId: string
    policyGatewayPrefixListId: string
    prefixes:
        - action: string
          ge: 0
          le: 0
          network: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    GatewayPath string
    Gateway where the prefix is defined.
    Prefixes List<PolicyGatewayPrefixListPrefix>
    A list of network prefixes.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyGatewayPrefixListId string
    ID of the resource.
    Tags List<PolicyGatewayPrefixListTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Gateway where the prefix is defined.
    Prefixes []PolicyGatewayPrefixListPrefixArgs
    A list of network prefixes.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyGatewayPrefixListId string
    ID of the resource.
    Tags []PolicyGatewayPrefixListTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Gateway where the prefix is defined.
    prefixes List<PolicyGatewayPrefixListPrefix>
    A list of network prefixes.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyGatewayPrefixListId String
    ID of the resource.
    tags List<PolicyGatewayPrefixListTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    gatewayPath string
    Gateway where the prefix is defined.
    prefixes PolicyGatewayPrefixListPrefix[]
    A list of network prefixes.
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyGatewayPrefixListId string
    ID of the resource.
    tags PolicyGatewayPrefixListTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    gateway_path str
    Gateway where the prefix is defined.
    prefixes Sequence[PolicyGatewayPrefixListPrefixArgs]
    A list of network prefixes.
    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 policy resource.
    policy_gateway_prefix_list_id str
    ID of the resource.
    tags Sequence[PolicyGatewayPrefixListTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Gateway where the prefix is defined.
    prefixes List<Property Map>
    A list of network prefixes.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyGatewayPrefixListId 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 PolicyGatewayPrefixList 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 PolicyGatewayPrefixList Resource

    Get an existing PolicyGatewayPrefixList 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?: PolicyGatewayPrefixListState, opts?: CustomResourceOptions): PolicyGatewayPrefixList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        gateway_path: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_gateway_prefix_list_id: Optional[str] = None,
        prefixes: Optional[Sequence[PolicyGatewayPrefixListPrefixArgs]] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyGatewayPrefixListTagArgs]] = None) -> PolicyGatewayPrefixList
    func GetPolicyGatewayPrefixList(ctx *Context, name string, id IDInput, state *PolicyGatewayPrefixListState, opts ...ResourceOption) (*PolicyGatewayPrefixList, error)
    public static PolicyGatewayPrefixList Get(string name, Input<string> id, PolicyGatewayPrefixListState? state, CustomResourceOptions? opts = null)
    public static PolicyGatewayPrefixList get(String name, Output<String> id, PolicyGatewayPrefixListState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGatewayPrefixList    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.
    GatewayPath string
    Gateway where the prefix is defined.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyGatewayPrefixListId string
    ID of the resource.
    Prefixes List<PolicyGatewayPrefixListPrefix>
    A list of network prefixes.
    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<PolicyGatewayPrefixListTag>
    A list of scope + tag pairs to associate with this resource.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Gateway where the prefix is defined.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyGatewayPrefixListId string
    ID of the resource.
    Prefixes []PolicyGatewayPrefixListPrefixArgs
    A list of network prefixes.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyGatewayPrefixListTagArgs
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Gateway where the prefix is defined.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyGatewayPrefixListId String
    ID of the resource.
    prefixes List<PolicyGatewayPrefixListPrefix>
    A list of network prefixes.
    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<PolicyGatewayPrefixListTag>
    A list of scope + tag pairs to associate with this resource.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    gatewayPath string
    Gateway where the prefix is defined.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path string
    The NSX path of the policy resource.
    policyGatewayPrefixListId string
    ID of the resource.
    prefixes PolicyGatewayPrefixListPrefix[]
    A list of network prefixes.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyGatewayPrefixListTag[]
    A list of scope + tag pairs to associate with this resource.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    gateway_path str
    Gateway where the prefix is defined.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path str
    The NSX path of the policy resource.
    policy_gateway_prefix_list_id str
    ID of the resource.
    prefixes Sequence[PolicyGatewayPrefixListPrefixArgs]
    A list of network prefixes.
    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[PolicyGatewayPrefixListTagArgs]
    A list of scope + tag pairs to associate with this resource.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Gateway where the prefix is defined.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyGatewayPrefixListId String
    ID of the resource.
    prefixes List<Property Map>
    A list of network prefixes.
    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.

    Supporting Types

    PolicyGatewayPrefixListPrefix, PolicyGatewayPrefixListPrefixArgs

    Action string
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    Ge double
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    Le double
    Prefix length less than or equal to, between 0-128. (0 means no value)
    Network string
    Network prefix in CIDR format. If not set it will match ANY network.
    Action string
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    Ge float64
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    Le float64
    Prefix length less than or equal to, between 0-128. (0 means no value)
    Network string
    Network prefix in CIDR format. If not set it will match ANY network.
    action String
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    ge Double
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    le Double
    Prefix length less than or equal to, between 0-128. (0 means no value)
    network String
    Network prefix in CIDR format. If not set it will match ANY network.
    action string
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    ge number
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    le number
    Prefix length less than or equal to, between 0-128. (0 means no value)
    network string
    Network prefix in CIDR format. If not set it will match ANY network.
    action str
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    ge float
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    le float
    Prefix length less than or equal to, between 0-128. (0 means no value)
    network str
    Network prefix in CIDR format. If not set it will match ANY network.
    action String
    PERMIT or DENY Action for the prefix list. The default value is PERMIT.
    ge Number
    Prefix length greater than or equal to, between 0-128. (0 means no value).
    le Number
    Prefix length less than or equal to, between 0-128. (0 means no value)
    network String
    Network prefix in CIDR format. If not set it will match ANY network.

    PolicyGatewayPrefixListTag, PolicyGatewayPrefixListTagArgs

    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.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt