Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. PolicerPolicyObject
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.PolicerPolicyObject

Explore with Pulumi AI

sdwan logo
Cisco Catalyst SD-WAN v0.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-sdwan

    This resource can manage a Policer Policy Object .

    Example Usage

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

const example = new sdwan.PolicerPolicyObject("example", {
    name: "Example",
    burst: 100000,
    exceedAction: "remark",
    rate: 100,
});

    import pulumi
import pulumi_sdwan as sdwan

example = sdwan.PolicerPolicyObject("example",
    name="Example",
    burst=100000,
    exceed_action="remark",
    rate=100)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdwan.NewPolicerPolicyObject(ctx, "example", &sdwan.PolicerPolicyObjectArgs{
			Name:         pulumi.String("Example"),
			Burst:        pulumi.Int(100000),
			ExceedAction: pulumi.String("remark"),
			Rate:         pulumi.Int(100),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdwan = Pulumi.Sdwan;

return await Deployment.RunAsync(() => 
{
    var example = new Sdwan.PolicerPolicyObject("example", new()
    {
        Name = "Example",
        Burst = 100000,
        ExceedAction = "remark",
        Rate = 100,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdwan.PolicerPolicyObject;
import com.pulumi.sdwan.PolicerPolicyObjectArgs;
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 PolicerPolicyObject("example", PolicerPolicyObjectArgs.builder()
            .name("Example")
            .burst(100000)
            .exceedAction("remark")
            .rate(100)
            .build());

    }
}

    resources:
  example:
    type: sdwan:PolicerPolicyObject
    properties:
      name: Example
      burst: 100000
      exceedAction: remark
      rate: 100

    Create PolicerPolicyObject Resource

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

    Constructor syntax

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

@overload
def PolicerPolicyObject(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        burst: Optional[int] = None,
                        exceed_action: Optional[str] = None,
                        rate: Optional[int] = None,
                        name: Optional[str] = None)
    func NewPolicerPolicyObject(ctx *Context, name string, args PolicerPolicyObjectArgs, opts ...ResourceOption) (*PolicerPolicyObject, error)
    public PolicerPolicyObject(string name, PolicerPolicyObjectArgs args, CustomResourceOptions? opts = null)
    public PolicerPolicyObject(String name, PolicerPolicyObjectArgs args)
public PolicerPolicyObject(String name, PolicerPolicyObjectArgs args, CustomResourceOptions options)

    type: sdwan:PolicerPolicyObject
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 PolicerPolicyObjectArgs
    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 PolicerPolicyObjectArgs
    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 PolicerPolicyObjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicerPolicyObjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicerPolicyObjectArgs
    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 policerPolicyObjectResource = new Sdwan.PolicerPolicyObject("policerPolicyObjectResource", new()
{
    Burst = 0,
    ExceedAction = "string",
    Rate = 0,
    Name = "string",
});

    example, err := sdwan.NewPolicerPolicyObject(ctx, "policerPolicyObjectResource", &sdwan.PolicerPolicyObjectArgs{
	Burst:        pulumi.Int(0),
	ExceedAction: pulumi.String("string"),
	Rate:         pulumi.Int(0),
	Name:         pulumi.String("string"),
})

    var policerPolicyObjectResource = new PolicerPolicyObject("policerPolicyObjectResource", PolicerPolicyObjectArgs.builder()
    .burst(0)
    .exceedAction("string")
    .rate(0)
    .name("string")
    .build());

    policer_policy_object_resource = sdwan.PolicerPolicyObject("policerPolicyObjectResource",
    burst=0,
    exceed_action="string",
    rate=0,
    name="string")

    const policerPolicyObjectResource = new sdwan.PolicerPolicyObject("policerPolicyObjectResource", {
    burst: 0,
    exceedAction: "string",
    rate: 0,
    name: "string",
});

    type: sdwan:PolicerPolicyObject
properties:
    burst: 0
    exceedAction: string
    name: string
    rate: 0

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

    Burst int
    Burst in bytes - Range: 15000-10000000
    ExceedAction string
    Exceed action - Choices: drop, remark
    Rate int
    Rate in bps - Range: 8-100000000000
    Name string
    The name of the policy object
    Burst int
    Burst in bytes - Range: 15000-10000000
    ExceedAction string
    Exceed action - Choices: drop, remark
    Rate int
    Rate in bps - Range: 8-100000000000
    Name string
    The name of the policy object
    burst Integer
    Burst in bytes - Range: 15000-10000000
    exceedAction String
    Exceed action - Choices: drop, remark
    rate Integer
    Rate in bps - Range: 8-100000000000
    name String
    The name of the policy object
    burst number
    Burst in bytes - Range: 15000-10000000
    exceedAction string
    Exceed action - Choices: drop, remark
    rate number
    Rate in bps - Range: 8-100000000000
    name string
    The name of the policy object
    burst int
    Burst in bytes - Range: 15000-10000000
    exceed_action str
    Exceed action - Choices: drop, remark
    rate int
    Rate in bps - Range: 8-100000000000
    name str
    The name of the policy object
    burst Number
    Burst in bytes - Range: 15000-10000000
    exceedAction String
    Exceed action - Choices: drop, remark
    rate Number
    Rate in bps - Range: 8-100000000000
    name String
    The name of the policy object

    Outputs

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

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

    Look up Existing PolicerPolicyObject Resource

    Get an existing PolicerPolicyObject 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?: PolicerPolicyObjectState, opts?: CustomResourceOptions): PolicerPolicyObject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        burst: Optional[int] = None,
        exceed_action: Optional[str] = None,
        name: Optional[str] = None,
        rate: Optional[int] = None,
        version: Optional[int] = None) -> PolicerPolicyObject
    func GetPolicerPolicyObject(ctx *Context, name string, id IDInput, state *PolicerPolicyObjectState, opts ...ResourceOption) (*PolicerPolicyObject, error)
    public static PolicerPolicyObject Get(string name, Input<string> id, PolicerPolicyObjectState? state, CustomResourceOptions? opts = null)
    public static PolicerPolicyObject get(String name, Output<String> id, PolicerPolicyObjectState 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:
    Burst int
    Burst in bytes - Range: 15000-10000000
    ExceedAction string
    Exceed action - Choices: drop, remark
    Name string
    The name of the policy object
    Rate int
    Rate in bps - Range: 8-100000000000
    Version int
    The version of the object
    Burst int
    Burst in bytes - Range: 15000-10000000
    ExceedAction string
    Exceed action - Choices: drop, remark
    Name string
    The name of the policy object
    Rate int
    Rate in bps - Range: 8-100000000000
    Version int
    The version of the object
    burst Integer
    Burst in bytes - Range: 15000-10000000
    exceedAction String
    Exceed action - Choices: drop, remark
    name String
    The name of the policy object
    rate Integer
    Rate in bps - Range: 8-100000000000
    version Integer
    The version of the object
    burst number
    Burst in bytes - Range: 15000-10000000
    exceedAction string
    Exceed action - Choices: drop, remark
    name string
    The name of the policy object
    rate number
    Rate in bps - Range: 8-100000000000
    version number
    The version of the object
    burst int
    Burst in bytes - Range: 15000-10000000
    exceed_action str
    Exceed action - Choices: drop, remark
    name str
    The name of the policy object
    rate int
    Rate in bps - Range: 8-100000000000
    version int
    The version of the object
    burst Number
    Burst in bytes - Range: 15000-10000000
    exceedAction String
    Exceed action - Choices: drop, remark
    name String
    The name of the policy object
    rate Number
    Rate in bps - Range: 8-100000000000
    version Number
    The version of the object

    Import

    $ pulumi import sdwan:index/policerPolicyObject:PolicerPolicyObject 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.1.3 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-sdwan