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

nsxt.PolicyGatewayCommunityList

Explore with Pulumi AI

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

    Create PolicyGatewayCommunityList Resource

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

    Constructor syntax

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

@overload
def PolicyGatewayCommunityList(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               communities: Optional[Sequence[str]] = None,
                               display_name: Optional[str] = None,
                               gateway_path: Optional[str] = None,
                               description: Optional[str] = None,
                               nsx_id: Optional[str] = None,
                               policy_gateway_community_list_id: Optional[str] = None,
                               tags: Optional[Sequence[PolicyGatewayCommunityListTagArgs]] = None)
    func NewPolicyGatewayCommunityList(ctx *Context, name string, args PolicyGatewayCommunityListArgs, opts ...ResourceOption) (*PolicyGatewayCommunityList, error)
    public PolicyGatewayCommunityList(string name, PolicyGatewayCommunityListArgs args, CustomResourceOptions? opts = null)
    public PolicyGatewayCommunityList(String name, PolicyGatewayCommunityListArgs args)
public PolicyGatewayCommunityList(String name, PolicyGatewayCommunityListArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGatewayCommunityList
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 PolicyGatewayCommunityListArgs
    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 PolicyGatewayCommunityListArgs
    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 PolicyGatewayCommunityListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGatewayCommunityListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGatewayCommunityListArgs
    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 policyGatewayCommunityListResource = new Nsxt.PolicyGatewayCommunityList("policyGatewayCommunityListResource", new()
{
    Communities = new[]
    {
        "string",
    },
    DisplayName = "string",
    GatewayPath = "string",
    Description = "string",
    NsxId = "string",
    PolicyGatewayCommunityListId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyGatewayCommunityListTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyGatewayCommunityList(ctx, "policyGatewayCommunityListResource", &nsxt.PolicyGatewayCommunityListArgs{
	Communities: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName:                  pulumi.String("string"),
	GatewayPath:                  pulumi.String("string"),
	Description:                  pulumi.String("string"),
	NsxId:                        pulumi.String("string"),
	PolicyGatewayCommunityListId: pulumi.String("string"),
	Tags: nsxt.PolicyGatewayCommunityListTagArray{
		&nsxt.PolicyGatewayCommunityListTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyGatewayCommunityListResource = new PolicyGatewayCommunityList("policyGatewayCommunityListResource", PolicyGatewayCommunityListArgs.builder()
    .communities("string")
    .displayName("string")
    .gatewayPath("string")
    .description("string")
    .nsxId("string")
    .policyGatewayCommunityListId("string")
    .tags(PolicyGatewayCommunityListTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_gateway_community_list_resource = nsxt.PolicyGatewayCommunityList("policyGatewayCommunityListResource",
    communities=["string"],
    display_name="string",
    gateway_path="string",
    description="string",
    nsx_id="string",
    policy_gateway_community_list_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyGatewayCommunityListResource = new nsxt.PolicyGatewayCommunityList("policyGatewayCommunityListResource", {
    communities: ["string"],
    displayName: "string",
    gatewayPath: "string",
    description: "string",
    nsxId: "string",
    policyGatewayCommunityListId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyGatewayCommunityList
properties:
    communities:
        - string
    description: string
    displayName: string
    gatewayPath: string
    nsxId: string
    policyGatewayCommunityListId: string
    tags:
        - scope: string
          tag: string

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

    Communities List<string>
    List of BGP community entries
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path of relevant Tier0 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.
    PolicyGatewayCommunityListId string
    ID of the resource.
    Tags List<PolicyGatewayCommunityListTag>
    A list of scope + tag pairs to associate with this resource.
    Communities []string
    List of BGP community entries
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path of relevant Tier0 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.
    PolicyGatewayCommunityListId string
    ID of the resource.
    Tags []PolicyGatewayCommunityListTagArgs
    A list of scope + tag pairs to associate with this resource.
    communities List<String>
    List of BGP community entries
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path of relevant Tier0 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.
    policyGatewayCommunityListId String
    ID of the resource.
    tags List<PolicyGatewayCommunityListTag>
    A list of scope + tag pairs to associate with this resource.
    communities string[]
    List of BGP community entries
    displayName string
    Display name of the resource.
    gatewayPath string
    Policy path of relevant Tier0 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.
    policyGatewayCommunityListId string
    ID of the resource.
    tags PolicyGatewayCommunityListTag[]
    A list of scope + tag pairs to associate with this resource.
    communities Sequence[str]
    List of BGP community entries
    display_name str
    Display name of the resource.
    gateway_path str
    Policy path of relevant Tier0 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_community_list_id str
    ID of the resource.
    tags Sequence[PolicyGatewayCommunityListTagArgs]
    A list of scope + tag pairs to associate with this resource.
    communities List<String>
    List of BGP community entries
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path of relevant Tier0 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.
    policyGatewayCommunityListId 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 PolicyGatewayCommunityList 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 PolicyGatewayCommunityList Resource

    Get an existing PolicyGatewayCommunityList 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?: PolicyGatewayCommunityListState, opts?: CustomResourceOptions): PolicyGatewayCommunityList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        communities: Optional[Sequence[str]] = 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_community_list_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyGatewayCommunityListTagArgs]] = None) -> PolicyGatewayCommunityList
    func GetPolicyGatewayCommunityList(ctx *Context, name string, id IDInput, state *PolicyGatewayCommunityListState, opts ...ResourceOption) (*PolicyGatewayCommunityList, error)
    public static PolicyGatewayCommunityList Get(string name, Input<string> id, PolicyGatewayCommunityListState? state, CustomResourceOptions? opts = null)
    public static PolicyGatewayCommunityList get(String name, Output<String> id, PolicyGatewayCommunityListState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGatewayCommunityList    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:
    Communities List<string>
    List of BGP community entries
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path of relevant Tier0 Gateway.
    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.
    PolicyGatewayCommunityListId 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<PolicyGatewayCommunityListTag>
    A list of scope + tag pairs to associate with this resource.
    Communities []string
    List of BGP community entries
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GatewayPath string
    Policy path of relevant Tier0 Gateway.
    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.
    PolicyGatewayCommunityListId 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 []PolicyGatewayCommunityListTagArgs
    A list of scope + tag pairs to associate with this resource.
    communities List<String>
    List of BGP community entries
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path of relevant Tier0 Gateway.
    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.
    policyGatewayCommunityListId 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<PolicyGatewayCommunityListTag>
    A list of scope + tag pairs to associate with this resource.
    communities string[]
    List of BGP community entries
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    gatewayPath string
    Policy path of relevant Tier0 Gateway.
    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.
    policyGatewayCommunityListId 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 PolicyGatewayCommunityListTag[]
    A list of scope + tag pairs to associate with this resource.
    communities Sequence[str]
    List of BGP community entries
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    gateway_path str
    Policy path of relevant Tier0 Gateway.
    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_community_list_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[PolicyGatewayCommunityListTagArgs]
    A list of scope + tag pairs to associate with this resource.
    communities List<String>
    List of BGP community entries
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    gatewayPath String
    Policy path of relevant Tier0 Gateway.
    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.
    policyGatewayCommunityListId 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.

    Supporting Types

    PolicyGatewayCommunityListTag, PolicyGatewayCommunityListTagArgs

    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