1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. QosMapPolicyDefinition
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

sdwan.QosMapPolicyDefinition

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi

    This resource can manage a QoS Map Policy Definition .

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.sdwan.QosMapPolicyDefinition;
    import com.pulumi.sdwan.QosMapPolicyDefinitionArgs;
    import com.pulumi.sdwan.inputs.QosMapPolicyDefinitionQosSchedulerArgs;
    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 example = new QosMapPolicyDefinition("example", QosMapPolicyDefinitionArgs.builder()
                .name("Example")
                .description("My description")
                .qosSchedulers(QosMapPolicyDefinitionQosSchedulerArgs.builder()
                    .queue(6)
                    .class_map_id("2081c2f4-3f9f-4fee-8078-dcc8904e368d")
                    .bandwidth_percent(10)
                    .buffer_percent(10)
                    .burst(100000)
                    .drop_type("red-drop")
                    .scheduling_type("wrr")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: sdwan:QosMapPolicyDefinition
        properties:
          name: Example
          description: My description
          qosSchedulers:
            - queue: 6
              class_map_id: 2081c2f4-3f9f-4fee-8078-dcc8904e368d
              bandwidth_percent: 10
              buffer_percent: 10
              burst: 100000
              drop_type: red-drop
              scheduling_type: wrr
    

    Create QosMapPolicyDefinition Resource

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

    Constructor syntax

    new QosMapPolicyDefinition(name: string, args: QosMapPolicyDefinitionArgs, opts?: CustomResourceOptions);
    @overload
    def QosMapPolicyDefinition(resource_name: str,
                               args: QosMapPolicyDefinitionArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def QosMapPolicyDefinition(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               description: Optional[str] = None,
                               qos_schedulers: Optional[Sequence[QosMapPolicyDefinitionQosSchedulerArgs]] = None,
                               name: Optional[str] = None)
    func NewQosMapPolicyDefinition(ctx *Context, name string, args QosMapPolicyDefinitionArgs, opts ...ResourceOption) (*QosMapPolicyDefinition, error)
    public QosMapPolicyDefinition(string name, QosMapPolicyDefinitionArgs args, CustomResourceOptions? opts = null)
    public QosMapPolicyDefinition(String name, QosMapPolicyDefinitionArgs args)
    public QosMapPolicyDefinition(String name, QosMapPolicyDefinitionArgs args, CustomResourceOptions options)
    
    type: sdwan:QosMapPolicyDefinition
    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 QosMapPolicyDefinitionArgs
    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 QosMapPolicyDefinitionArgs
    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 QosMapPolicyDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QosMapPolicyDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QosMapPolicyDefinitionArgs
    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 qosMapPolicyDefinitionResource = new Sdwan.QosMapPolicyDefinition("qosMapPolicyDefinitionResource", new()
    {
        Description = "string",
        QosSchedulers = new[]
        {
            new Sdwan.Inputs.QosMapPolicyDefinitionQosSchedulerArgs
            {
                BandwidthPercent = 0,
                BufferPercent = 0,
                ClassMapId = "string",
                DropType = "string",
                Queue = 0,
                SchedulingType = "string",
                Burst = 0,
                ClassMapVersion = 0,
            },
        },
        Name = "string",
    });
    
    example, err := sdwan.NewQosMapPolicyDefinition(ctx, "qosMapPolicyDefinitionResource", &sdwan.QosMapPolicyDefinitionArgs{
    	Description: pulumi.String("string"),
    	QosSchedulers: sdwan.QosMapPolicyDefinitionQosSchedulerArray{
    		&sdwan.QosMapPolicyDefinitionQosSchedulerArgs{
    			BandwidthPercent: pulumi.Int(0),
    			BufferPercent:    pulumi.Int(0),
    			ClassMapId:       pulumi.String("string"),
    			DropType:         pulumi.String("string"),
    			Queue:            pulumi.Int(0),
    			SchedulingType:   pulumi.String("string"),
    			Burst:            pulumi.Int(0),
    			ClassMapVersion:  pulumi.Int(0),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var qosMapPolicyDefinitionResource = new QosMapPolicyDefinition("qosMapPolicyDefinitionResource", QosMapPolicyDefinitionArgs.builder()
        .description("string")
        .qosSchedulers(QosMapPolicyDefinitionQosSchedulerArgs.builder()
            .bandwidthPercent(0)
            .bufferPercent(0)
            .classMapId("string")
            .dropType("string")
            .queue(0)
            .schedulingType("string")
            .burst(0)
            .classMapVersion(0)
            .build())
        .name("string")
        .build());
    
    qos_map_policy_definition_resource = sdwan.QosMapPolicyDefinition("qosMapPolicyDefinitionResource",
        description="string",
        qos_schedulers=[{
            "bandwidth_percent": 0,
            "buffer_percent": 0,
            "class_map_id": "string",
            "drop_type": "string",
            "queue": 0,
            "scheduling_type": "string",
            "burst": 0,
            "class_map_version": 0,
        }],
        name="string")
    
    const qosMapPolicyDefinitionResource = new sdwan.QosMapPolicyDefinition("qosMapPolicyDefinitionResource", {
        description: "string",
        qosSchedulers: [{
            bandwidthPercent: 0,
            bufferPercent: 0,
            classMapId: "string",
            dropType: "string",
            queue: 0,
            schedulingType: "string",
            burst: 0,
            classMapVersion: 0,
        }],
        name: "string",
    });
    
    type: sdwan:QosMapPolicyDefinition
    properties:
        description: string
        name: string
        qosSchedulers:
            - bandwidthPercent: 0
              bufferPercent: 0
              burst: 0
              classMapId: string
              classMapVersion: 0
              dropType: string
              queue: 0
              schedulingType: string
    

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

    Description string
    The description of the policy definition
    QosSchedulers List<QosMapPolicyDefinitionQosScheduler>
    List of QoS schedulers
    Name string
    The name of the policy definition
    Description string
    The description of the policy definition
    QosSchedulers []QosMapPolicyDefinitionQosSchedulerArgs
    List of QoS schedulers
    Name string
    The name of the policy definition
    description String
    The description of the policy definition
    qosSchedulers List<QosMapPolicyDefinitionQosScheduler>
    List of QoS schedulers
    name String
    The name of the policy definition
    description string
    The description of the policy definition
    qosSchedulers QosMapPolicyDefinitionQosScheduler[]
    List of QoS schedulers
    name string
    The name of the policy definition
    description str
    The description of the policy definition
    qos_schedulers Sequence[QosMapPolicyDefinitionQosSchedulerArgs]
    List of QoS schedulers
    name str
    The name of the policy definition
    description String
    The description of the policy definition
    qosSchedulers List<Property Map>
    List of QoS schedulers
    name String
    The name of the policy definition

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type
    Version int
    The version of the object
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type
    Version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type
    version Integer
    The version of the object
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Type
    version number
    The version of the object
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Type
    version int
    The version of the object
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type
    version Number
    The version of the object

    Look up Existing QosMapPolicyDefinition Resource

    Get an existing QosMapPolicyDefinition 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?: QosMapPolicyDefinitionState, opts?: CustomResourceOptions): QosMapPolicyDefinition
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            qos_schedulers: Optional[Sequence[QosMapPolicyDefinitionQosSchedulerArgs]] = None,
            type: Optional[str] = None,
            version: Optional[int] = None) -> QosMapPolicyDefinition
    func GetQosMapPolicyDefinition(ctx *Context, name string, id IDInput, state *QosMapPolicyDefinitionState, opts ...ResourceOption) (*QosMapPolicyDefinition, error)
    public static QosMapPolicyDefinition Get(string name, Input<string> id, QosMapPolicyDefinitionState? state, CustomResourceOptions? opts = null)
    public static QosMapPolicyDefinition get(String name, Output<String> id, QosMapPolicyDefinitionState 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:
    Description string
    The description of the policy definition
    Name string
    The name of the policy definition
    QosSchedulers List<QosMapPolicyDefinitionQosScheduler>
    List of QoS schedulers
    Type string
    Type
    Version int
    The version of the object
    Description string
    The description of the policy definition
    Name string
    The name of the policy definition
    QosSchedulers []QosMapPolicyDefinitionQosSchedulerArgs
    List of QoS schedulers
    Type string
    Type
    Version int
    The version of the object
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    qosSchedulers List<QosMapPolicyDefinitionQosScheduler>
    List of QoS schedulers
    type String
    Type
    version Integer
    The version of the object
    description string
    The description of the policy definition
    name string
    The name of the policy definition
    qosSchedulers QosMapPolicyDefinitionQosScheduler[]
    List of QoS schedulers
    type string
    Type
    version number
    The version of the object
    description str
    The description of the policy definition
    name str
    The name of the policy definition
    qos_schedulers Sequence[QosMapPolicyDefinitionQosSchedulerArgs]
    List of QoS schedulers
    type str
    Type
    version int
    The version of the object
    description String
    The description of the policy definition
    name String
    The name of the policy definition
    qosSchedulers List<Property Map>
    List of QoS schedulers
    type String
    Type
    version Number
    The version of the object

    Supporting Types

    QosMapPolicyDefinitionQosScheduler, QosMapPolicyDefinitionQosSchedulerArgs

    BandwidthPercent int
    Bandwidth percent

    • Range: 0-100
    BufferPercent int
    Buffer percent

    • Range: 0-100
    ClassMapId string
    Class map ID
    DropType string
    Drop type

    • Choices: tail-drop, red-drop
    Queue int
    Queue number

    • Range: 0-7
    SchedulingType string
    Scheduling type

    • Choices: llq, wrr
    Burst int
    Burst size

    • Range: 5000-10000000
    ClassMapVersion int
    Class map version
    BandwidthPercent int
    Bandwidth percent

    • Range: 0-100
    BufferPercent int
    Buffer percent

    • Range: 0-100
    ClassMapId string
    Class map ID
    DropType string
    Drop type

    • Choices: tail-drop, red-drop
    Queue int
    Queue number

    • Range: 0-7
    SchedulingType string
    Scheduling type

    • Choices: llq, wrr
    Burst int
    Burst size

    • Range: 5000-10000000
    ClassMapVersion int
    Class map version
    bandwidthPercent Integer
    Bandwidth percent

    • Range: 0-100
    bufferPercent Integer
    Buffer percent

    • Range: 0-100
    classMapId String
    Class map ID
    dropType String
    Drop type

    • Choices: tail-drop, red-drop
    queue Integer
    Queue number

    • Range: 0-7
    schedulingType String
    Scheduling type

    • Choices: llq, wrr
    burst Integer
    Burst size

    • Range: 5000-10000000
    classMapVersion Integer
    Class map version
    bandwidthPercent number
    Bandwidth percent

    • Range: 0-100
    bufferPercent number
    Buffer percent

    • Range: 0-100
    classMapId string
    Class map ID
    dropType string
    Drop type

    • Choices: tail-drop, red-drop
    queue number
    Queue number

    • Range: 0-7
    schedulingType string
    Scheduling type

    • Choices: llq, wrr
    burst number
    Burst size

    • Range: 5000-10000000
    classMapVersion number
    Class map version
    bandwidth_percent int
    Bandwidth percent

    • Range: 0-100
    buffer_percent int
    Buffer percent

    • Range: 0-100
    class_map_id str
    Class map ID
    drop_type str
    Drop type

    • Choices: tail-drop, red-drop
    queue int
    Queue number

    • Range: 0-7
    scheduling_type str
    Scheduling type

    • Choices: llq, wrr
    burst int
    Burst size

    • Range: 5000-10000000
    class_map_version int
    Class map version
    bandwidthPercent Number
    Bandwidth percent

    • Range: 0-100
    bufferPercent Number
    Buffer percent

    • Range: 0-100
    classMapId String
    Class map ID
    dropType String
    Drop type

    • Choices: tail-drop, red-drop
    queue Number
    Queue number

    • Range: 0-7
    schedulingType String
    Scheduling type

    • Choices: llq, wrr
    burst Number
    Burst size

    • Range: 5000-10000000
    classMapVersion Number
    Class map version

    Import

    $ pulumi import sdwan:index/qosMapPolicyDefinition:QosMapPolicyDefinition example "f6b2c44c-693c-4763-b010-895aa3d236bd"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    sdwan pulumi/pulumi-sdwan
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdwan Terraform Provider.
    sdwan logo
    Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi