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

nsxt.PolicyGatewayQosProfile

Explore with Pulumi AI

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

    Create PolicyGatewayQosProfile Resource

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

    Constructor syntax

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

@overload
def PolicyGatewayQosProfile(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            burst_size: Optional[float] = None,
                            committed_bandwidth: Optional[float] = None,
                            description: Optional[str] = None,
                            excess_action: Optional[str] = None,
                            nsx_id: Optional[str] = None,
                            policy_gateway_qos_profile_id: Optional[str] = None,
                            tags: Optional[Sequence[PolicyGatewayQosProfileTagArgs]] = None)
    func NewPolicyGatewayQosProfile(ctx *Context, name string, args PolicyGatewayQosProfileArgs, opts ...ResourceOption) (*PolicyGatewayQosProfile, error)
    public PolicyGatewayQosProfile(string name, PolicyGatewayQosProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyGatewayQosProfile(String name, PolicyGatewayQosProfileArgs args)
public PolicyGatewayQosProfile(String name, PolicyGatewayQosProfileArgs args, CustomResourceOptions options)

    type: nsxt:PolicyGatewayQosProfile
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 PolicyGatewayQosProfileArgs
    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 PolicyGatewayQosProfileArgs
    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 PolicyGatewayQosProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyGatewayQosProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyGatewayQosProfileArgs
    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 policyGatewayQosProfileResource = new Nsxt.PolicyGatewayQosProfile("policyGatewayQosProfileResource", new()
{
    DisplayName = "string",
    BurstSize = 0,
    CommittedBandwidth = 0,
    Description = "string",
    ExcessAction = "string",
    NsxId = "string",
    PolicyGatewayQosProfileId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyGatewayQosProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyGatewayQosProfile(ctx, "policyGatewayQosProfileResource", &nsxt.PolicyGatewayQosProfileArgs{
	DisplayName:               pulumi.String("string"),
	BurstSize:                 pulumi.Float64(0),
	CommittedBandwidth:        pulumi.Float64(0),
	Description:               pulumi.String("string"),
	ExcessAction:              pulumi.String("string"),
	NsxId:                     pulumi.String("string"),
	PolicyGatewayQosProfileId: pulumi.String("string"),
	Tags: nsxt.PolicyGatewayQosProfileTagArray{
		&nsxt.PolicyGatewayQosProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyGatewayQosProfileResource = new PolicyGatewayQosProfile("policyGatewayQosProfileResource", PolicyGatewayQosProfileArgs.builder()
    .displayName("string")
    .burstSize(0)
    .committedBandwidth(0)
    .description("string")
    .excessAction("string")
    .nsxId("string")
    .policyGatewayQosProfileId("string")
    .tags(PolicyGatewayQosProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_gateway_qos_profile_resource = nsxt.PolicyGatewayQosProfile("policyGatewayQosProfileResource",
    display_name="string",
    burst_size=0,
    committed_bandwidth=0,
    description="string",
    excess_action="string",
    nsx_id="string",
    policy_gateway_qos_profile_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyGatewayQosProfileResource = new nsxt.PolicyGatewayQosProfile("policyGatewayQosProfileResource", {
    displayName: "string",
    burstSize: 0,
    committedBandwidth: 0,
    description: "string",
    excessAction: "string",
    nsxId: "string",
    policyGatewayQosProfileId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyGatewayQosProfile
properties:
    burstSize: 0
    committedBandwidth: 0
    description: string
    displayName: string
    excessAction: string
    nsxId: string
    policyGatewayQosProfileId: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    BurstSize double
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    CommittedBandwidth double
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    Description string
    Description of the resource.
    ExcessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyGatewayQosProfileId string
    ID of the resource.
    Tags List<PolicyGatewayQosProfileTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    BurstSize float64
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    CommittedBandwidth float64
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    Description string
    Description of the resource.
    ExcessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyGatewayQosProfileId string
    ID of the resource.
    Tags []PolicyGatewayQosProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    burstSize Double
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth Double
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description String
    Description of the resource.
    excessAction String
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyGatewayQosProfileId String
    ID of the resource.
    tags List<PolicyGatewayQosProfileTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    burstSize number
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth number
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description string
    Description of the resource.
    excessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyGatewayQosProfileId string
    ID of the resource.
    tags PolicyGatewayQosProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    burst_size float
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committed_bandwidth float
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description str
    Description of the resource.
    excess_action str
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_gateway_qos_profile_id str
    ID of the resource.
    tags Sequence[PolicyGatewayQosProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    burstSize Number
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth Number
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description String
    Description of the resource.
    excessAction String
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyGatewayQosProfileId 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 PolicyGatewayQosProfile 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 PolicyGatewayQosProfile Resource

    Get an existing PolicyGatewayQosProfile 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?: PolicyGatewayQosProfileState, opts?: CustomResourceOptions): PolicyGatewayQosProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        burst_size: Optional[float] = None,
        committed_bandwidth: Optional[float] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        excess_action: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_gateway_qos_profile_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyGatewayQosProfileTagArgs]] = None) -> PolicyGatewayQosProfile
    func GetPolicyGatewayQosProfile(ctx *Context, name string, id IDInput, state *PolicyGatewayQosProfileState, opts ...ResourceOption) (*PolicyGatewayQosProfile, error)
    public static PolicyGatewayQosProfile Get(string name, Input<string> id, PolicyGatewayQosProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyGatewayQosProfile get(String name, Output<String> id, PolicyGatewayQosProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyGatewayQosProfile    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:
    BurstSize double
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    CommittedBandwidth double
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    ExcessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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.
    PolicyGatewayQosProfileId 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<PolicyGatewayQosProfileTag>
    A list of scope + tag pairs to associate with this resource.
    BurstSize float64
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    CommittedBandwidth float64
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    ExcessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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.
    PolicyGatewayQosProfileId 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 []PolicyGatewayQosProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    burstSize Double
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth Double
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    excessAction String
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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.
    policyGatewayQosProfileId 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<PolicyGatewayQosProfileTag>
    A list of scope + tag pairs to associate with this resource.
    burstSize number
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth number
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    excessAction string
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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.
    policyGatewayQosProfileId 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 PolicyGatewayQosProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    burst_size float
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committed_bandwidth float
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    excess_action str
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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_qos_profile_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[PolicyGatewayQosProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    burstSize Number
    Maximum amount of traffic that can be transmitted at peak bandwidth rate (bytes)
    committedBandwidth Number
    Bandwidth is limited to line rate when the value configured is greater than line rate (mbps)
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    excessAction String
    Action on traffic exceeding bandwidth. Currently only DROP is supported.
    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.
    policyGatewayQosProfileId 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

    PolicyGatewayQosProfileTag, PolicyGatewayQosProfileTagArgs

    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