Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cisco Catalyst SD-WAN
  3. API Docs
  4. PolicyObjectPolicer
Cisco Catalyst SD-WAN v0.2.0 published on Friday, Nov 1, 2024 by Pulumi
pulumi/pulumi-sdwan

sdwan.PolicyObjectPolicer

Explore with Pulumi AI

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

    This resource can manage a Policy Object Policer Policy_object.

    • Minimum SD-WAN Manager version: 20.12.0

    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.PolicyObjectPolicer;
import com.pulumi.sdwan.PolicyObjectPolicerArgs;
import com.pulumi.sdwan.inputs.PolicyObjectPolicerEntryArgs;
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 PolicyObjectPolicer("example", PolicyObjectPolicerArgs.builder()
            .name("Example")
            .description("My Example")
            .featureProfileId("f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac")
            .entries(PolicyObjectPolicerEntryArgs.builder()
                .burst_bytes(56500)
                .exceed_action("remark")
                .rate_bps(60000)
                .build())
            .build());

    }
}

    resources:
  example:
    type: sdwan:PolicyObjectPolicer
    properties:
      name: Example
      description: My Example
      featureProfileId: f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac
      entries:
        - burst_bytes: 56500
          exceed_action: remark
          rate_bps: 60000

    Create PolicyObjectPolicer Resource

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

    Constructor syntax

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

@overload
def PolicyObjectPolicer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        entries: Optional[Sequence[PolicyObjectPolicerEntryArgs]] = None,
                        feature_profile_id: Optional[str] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None)
    func NewPolicyObjectPolicer(ctx *Context, name string, args PolicyObjectPolicerArgs, opts ...ResourceOption) (*PolicyObjectPolicer, error)
    public PolicyObjectPolicer(string name, PolicyObjectPolicerArgs args, CustomResourceOptions? opts = null)
    public PolicyObjectPolicer(String name, PolicyObjectPolicerArgs args)
public PolicyObjectPolicer(String name, PolicyObjectPolicerArgs args, CustomResourceOptions options)

    type: sdwan:PolicyObjectPolicer
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 PolicyObjectPolicerArgs
    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 PolicyObjectPolicerArgs
    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 PolicyObjectPolicerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyObjectPolicerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyObjectPolicerArgs
    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 policyObjectPolicerResource = new Sdwan.PolicyObjectPolicer("policyObjectPolicerResource", new()
{
    Entries = new[]
    {
        new Sdwan.Inputs.PolicyObjectPolicerEntryArgs
        {
            BurstBytes = 0,
            ExceedAction = "string",
            RateBps = 0,
        },
    },
    FeatureProfileId = "string",
    Description = "string",
    Name = "string",
});

    example, err := sdwan.NewPolicyObjectPolicer(ctx, "policyObjectPolicerResource", &sdwan.PolicyObjectPolicerArgs{
	Entries: sdwan.PolicyObjectPolicerEntryArray{
		&sdwan.PolicyObjectPolicerEntryArgs{
			BurstBytes:   pulumi.Int(0),
			ExceedAction: pulumi.String("string"),
			RateBps:      pulumi.Int(0),
		},
	},
	FeatureProfileId: pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var policyObjectPolicerResource = new PolicyObjectPolicer("policyObjectPolicerResource", PolicyObjectPolicerArgs.builder()
    .entries(PolicyObjectPolicerEntryArgs.builder()
        .burstBytes(0)
        .exceedAction("string")
        .rateBps(0)
        .build())
    .featureProfileId("string")
    .description("string")
    .name("string")
    .build());

    policy_object_policer_resource = sdwan.PolicyObjectPolicer("policyObjectPolicerResource",
    entries=[{
        "burst_bytes": 0,
        "exceed_action": "string",
        "rate_bps": 0,
    }],
    feature_profile_id="string",
    description="string",
    name="string")

    const policyObjectPolicerResource = new sdwan.PolicyObjectPolicer("policyObjectPolicerResource", {
    entries: [{
        burstBytes: 0,
        exceedAction: "string",
        rateBps: 0,
    }],
    featureProfileId: "string",
    description: "string",
    name: "string",
});

    type: sdwan:PolicyObjectPolicer
properties:
    description: string
    entries:
        - burstBytes: 0
          exceedAction: string
          rateBps: 0
    featureProfileId: string
    name: string

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

    Entries List<PolicyObjectPolicerEntry>
    Policer Entries
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    Entries []PolicyObjectPolicerEntryArgs
    Policer Entries
    FeatureProfileId string
    Feature Profile ID
    Description string
    The description of the Policy_object
    Name string
    The name of the Policy_object
    entries List<PolicyObjectPolicerEntry>
    Policer Entries
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object
    entries PolicyObjectPolicerEntry[]
    Policer Entries
    featureProfileId string
    Feature Profile ID
    description string
    The description of the Policy_object
    name string
    The name of the Policy_object
    entries Sequence[PolicyObjectPolicerEntryArgs]
    Policer Entries
    feature_profile_id str
    Feature Profile ID
    description str
    The description of the Policy_object
    name str
    The name of the Policy_object
    entries List<Property Map>
    Policer Entries
    featureProfileId String
    Feature Profile ID
    description String
    The description of the Policy_object
    name String
    The name of the Policy_object

    Outputs

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

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

    Look up Existing PolicyObjectPolicer Resource

    Get an existing PolicyObjectPolicer 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?: PolicyObjectPolicerState, opts?: CustomResourceOptions): PolicyObjectPolicer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        entries: Optional[Sequence[PolicyObjectPolicerEntryArgs]] = None,
        feature_profile_id: Optional[str] = None,
        name: Optional[str] = None,
        version: Optional[int] = None) -> PolicyObjectPolicer
    func GetPolicyObjectPolicer(ctx *Context, name string, id IDInput, state *PolicyObjectPolicerState, opts ...ResourceOption) (*PolicyObjectPolicer, error)
    public static PolicyObjectPolicer Get(string name, Input<string> id, PolicyObjectPolicerState? state, CustomResourceOptions? opts = null)
    public static PolicyObjectPolicer get(String name, Output<String> id, PolicyObjectPolicerState 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_object
    Entries List<PolicyObjectPolicerEntry>
    Policer Entries
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    Description string
    The description of the Policy_object
    Entries []PolicyObjectPolicerEntryArgs
    Policer Entries
    FeatureProfileId string
    Feature Profile ID
    Name string
    The name of the Policy_object
    Version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<PolicyObjectPolicerEntry>
    Policer Entries
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Integer
    The version of the Policy_object
    description string
    The description of the Policy_object
    entries PolicyObjectPolicerEntry[]
    Policer Entries
    featureProfileId string
    Feature Profile ID
    name string
    The name of the Policy_object
    version number
    The version of the Policy_object
    description str
    The description of the Policy_object
    entries Sequence[PolicyObjectPolicerEntryArgs]
    Policer Entries
    feature_profile_id str
    Feature Profile ID
    name str
    The name of the Policy_object
    version int
    The version of the Policy_object
    description String
    The description of the Policy_object
    entries List<Property Map>
    Policer Entries
    featureProfileId String
    Feature Profile ID
    name String
    The name of the Policy_object
    version Number
    The version of the Policy_object

    Supporting Types

    PolicyObjectPolicerEntry, PolicyObjectPolicerEntryArgs

    BurstBytes int
    Burst (Bytes)

    • Range: 15000-10000000
    ExceedAction string
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    RateBps int
    Rate (bps)

    • Range: 8-100000000000
    BurstBytes int
    Burst (Bytes)

    • Range: 15000-10000000
    ExceedAction string
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    RateBps int
    Rate (bps)

    • Range: 8-100000000000
    burstBytes Integer
    Burst (Bytes)

    • Range: 15000-10000000
    exceedAction String
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    rateBps Integer
    Rate (bps)

    • Range: 8-100000000000
    burstBytes number
    Burst (Bytes)

    • Range: 15000-10000000
    exceedAction string
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    rateBps number
    Rate (bps)

    • Range: 8-100000000000
    burst_bytes int
    Burst (Bytes)

    • Range: 15000-10000000
    exceed_action str
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    rate_bps int
    Rate (bps)

    • Range: 8-100000000000
    burstBytes Number
    Burst (Bytes)

    • Range: 15000-10000000
    exceedAction String
    Exceed options such as Drop or Remark

    • Choices: drop, remark
    rateBps Number
    Rate (bps)

    • Range: 8-100000000000

    Import

    Expected import identifier with the format: “policy_object_policer_id,feature_profile_id”

    $ pulumi import sdwan:index/policyObjectPolicer:PolicyObjectPolicer example "f6b2c44c-693c-4763-b010-895aa3d236bd,f6dd22c8-0b4f-496c-9a0b-6813d1f8b8ac"

    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
    pulumi/pulumi-sdwan