OpenStack v3.12.1, Mar 23 23

openstack.networking.QosBandwidthLimitRule

Manages a V2 Neutron QoS bandwidth limit rule resource within OpenStack.

Example Usage

Create a QoS Policy with some bandwidth limit rule

using System.Collections.Generic;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var qosPolicy1 = new OpenStack.Networking.QosPolicy("qosPolicy1", new()
    {
        Description = "bw_limit",
    });

    var bwLimitRule1 = new OpenStack.Networking.QosBandwidthLimitRule("bwLimitRule1", new()
    {
        Direction = "egress",
        MaxBurstKbps = 300,
        MaxKbps = 3000,
        QosPolicyId = qosPolicy1.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		qosPolicy1, err := networking.NewQosPolicy(ctx, "qosPolicy1", &networking.QosPolicyArgs{
			Description: pulumi.String("bw_limit"),
		})
		if err != nil {
			return err
		}
		_, err = networking.NewQosBandwidthLimitRule(ctx, "bwLimitRule1", &networking.QosBandwidthLimitRuleArgs{
			Direction:    pulumi.String("egress"),
			MaxBurstKbps: pulumi.Int(300),
			MaxKbps:      pulumi.Int(3000),
			QosPolicyId:  qosPolicy1.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.QosPolicy;
import com.pulumi.openstack.networking.QosPolicyArgs;
import com.pulumi.openstack.networking.QosBandwidthLimitRule;
import com.pulumi.openstack.networking.QosBandwidthLimitRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var qosPolicy1 = new QosPolicy("qosPolicy1", QosPolicyArgs.builder()        
            .description("bw_limit")
            .build());

        var bwLimitRule1 = new QosBandwidthLimitRule("bwLimitRule1", QosBandwidthLimitRuleArgs.builder()        
            .direction("egress")
            .maxBurstKbps(300)
            .maxKbps(3000)
            .qosPolicyId(qosPolicy1.id())
            .build());

    }
}

import pulumi
import pulumi_openstack as openstack

qos_policy1 = openstack.networking.QosPolicy("qosPolicy1", description="bw_limit")
bw_limit_rule1 = openstack.networking.QosBandwidthLimitRule("bwLimitRule1",
    direction="egress",
    max_burst_kbps=300,
    max_kbps=3000,
    qos_policy_id=qos_policy1.id)

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const qosPolicy1 = new openstack.networking.QosPolicy("qosPolicy1", {description: "bw_limit"});
const bwLimitRule1 = new openstack.networking.QosBandwidthLimitRule("bwLimitRule1", {
    direction: "egress",
    maxBurstKbps: 300,
    maxKbps: 3000,
    qosPolicyId: qosPolicy1.id,
});

resources:
  qosPolicy1:
    type: openstack:networking:QosPolicy
    properties:
      description: bw_limit
  bwLimitRule1:
    type: openstack:networking:QosBandwidthLimitRule
    properties:
      direction: egress
      maxBurstKbps: 300
      maxKbps: 3000
      qosPolicyId: ${qosPolicy1.id}

Create QosBandwidthLimitRule Resource

new QosBandwidthLimitRule(name: string, args: QosBandwidthLimitRuleArgs, opts?: CustomResourceOptions);

@overload
def QosBandwidthLimitRule(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          direction: Optional[str] = None,
                          max_burst_kbps: Optional[int] = None,
                          max_kbps: Optional[int] = None,
                          qos_policy_id: Optional[str] = None,
                          region: Optional[str] = None)
@overload
def QosBandwidthLimitRule(resource_name: str,
                          args: QosBandwidthLimitRuleArgs,
                          opts: Optional[ResourceOptions] = None)

func NewQosBandwidthLimitRule(ctx *Context, name string, args QosBandwidthLimitRuleArgs, opts ...ResourceOption) (*QosBandwidthLimitRule, error)

public QosBandwidthLimitRule(string name, QosBandwidthLimitRuleArgs args, CustomResourceOptions? opts = null)

public QosBandwidthLimitRule(String name, QosBandwidthLimitRuleArgs args)
public QosBandwidthLimitRule(String name, QosBandwidthLimitRuleArgs args, CustomResourceOptions options)

type: openstack:networking:QosBandwidthLimitRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QosBandwidthLimitRuleArgs: 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 QosBandwidthLimitRuleArgs: 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 QosBandwidthLimitRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QosBandwidthLimitRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args QosBandwidthLimitRuleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

QosBandwidthLimitRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The QosBandwidthLimitRule resource accepts the following input properties:

MaxKbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
QosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
Direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
MaxBurstKbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

MaxKbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
QosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
Direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
MaxBurstKbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

maxKbps Integer: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId String: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
direction String: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps Integer: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

maxKbps number: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps number: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

max_kbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qos_policy_id str: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
direction str: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
max_burst_kbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

maxKbps Number: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId String: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
direction String: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps Number: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the QosBandwidthLimitRule resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing QosBandwidthLimitRule Resource

Get an existing QosBandwidthLimitRule 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?: QosBandwidthLimitRuleState, opts?: CustomResourceOptions): QosBandwidthLimitRule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        direction: Optional[str] = None,
        max_burst_kbps: Optional[int] = None,
        max_kbps: Optional[int] = None,
        qos_policy_id: Optional[str] = None,
        region: Optional[str] = None) -> QosBandwidthLimitRule

func GetQosBandwidthLimitRule(ctx *Context, name string, id IDInput, state *QosBandwidthLimitRuleState, opts ...ResourceOption) (*QosBandwidthLimitRule, error)

public static QosBandwidthLimitRule Get(string name, Input<string> id, QosBandwidthLimitRuleState? state, CustomResourceOptions? opts = null)

public static QosBandwidthLimitRule get(String name, Output<String> id, QosBandwidthLimitRuleState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

Direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
MaxBurstKbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
MaxKbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
QosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

Direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
MaxBurstKbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
MaxKbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
QosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

direction String: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps Integer: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
maxKbps Integer: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId String: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

direction string: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps number: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
maxKbps number: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId string: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

direction str: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
max_burst_kbps int: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
max_kbps int: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qos_policy_id str: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

direction String: The direction of traffic. Defaults to "egress". Changing this updates the direction of the existing QoS bandwidth limit rule.
maxBurstKbps Number: The maximum burst size in kilobits of a QoS bandwidth limit rule. Changing this updates the maximum burst size in kilobits of the existing QoS bandwidth limit rule.
maxKbps Number: The maximum kilobits per second of a QoS bandwidth limit rule. Changing this updates the maximum kilobits per second of the existing QoS bandwidth limit rule.
qosPolicyId String: The QoS policy reference. Changing this creates a new QoS bandwidth limit rule.
region String: The region in which to obtain the V2 Networking client. A Networking client is needed to create a Neutron QoS bandwidth limit rule. If omitted, the region argument of the provider is used. Changing this creates a new QoS bandwidth limit rule.

Import

QoS bandwidth limit rules can be imported using the qos_policy_id/bandwidth_limit_rule format, e.g.

 $ pulumi import openstack:networking/qosBandwidthLimitRule:QosBandwidthLimitRule bw_limit_rule_1 d6ae28ce-fcb5-4180-aa62-d260a27e09ae/46dfb556-b92f-48ce-94c5-9a9e2140de94

Package Details

Repository: OpenStack pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.