1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. ApplianceTrafficShaping
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.networks.ApplianceTrafficShaping

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

    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.meraki.networks.ApplianceTrafficShaping;
    import com.pulumi.meraki.networks.ApplianceTrafficShapingArgs;
    import com.pulumi.meraki.networks.inputs.ApplianceTrafficShapingGlobalBandwidthLimitsArgs;
    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 ApplianceTrafficShaping("example", ApplianceTrafficShapingArgs.builder()
                .globalBandwidthLimits(ApplianceTrafficShapingGlobalBandwidthLimitsArgs.builder()
                    .limit_down(5120)
                    .limit_up(2048)
                    .build())
                .networkId("string")
                .build());
    
            ctx.export("merakiNetworksApplianceTrafficShapingExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:networks:ApplianceTrafficShaping
        properties:
          globalBandwidthLimits:
            limit_down: 5120
            limit_up: 2048
          networkId: string
    outputs:
      merakiNetworksApplianceTrafficShapingExample: ${example}
    

    Create ApplianceTrafficShaping Resource

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

    Constructor syntax

    new ApplianceTrafficShaping(name: string, args: ApplianceTrafficShapingArgs, opts?: CustomResourceOptions);
    @overload
    def ApplianceTrafficShaping(resource_name: str,
                                args: ApplianceTrafficShapingArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApplianceTrafficShaping(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                network_id: Optional[str] = None,
                                global_bandwidth_limits: Optional[ApplianceTrafficShapingGlobalBandwidthLimitsArgs] = None)
    func NewApplianceTrafficShaping(ctx *Context, name string, args ApplianceTrafficShapingArgs, opts ...ResourceOption) (*ApplianceTrafficShaping, error)
    public ApplianceTrafficShaping(string name, ApplianceTrafficShapingArgs args, CustomResourceOptions? opts = null)
    public ApplianceTrafficShaping(String name, ApplianceTrafficShapingArgs args)
    public ApplianceTrafficShaping(String name, ApplianceTrafficShapingArgs args, CustomResourceOptions options)
    
    type: meraki:networks:ApplianceTrafficShaping
    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 ApplianceTrafficShapingArgs
    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 ApplianceTrafficShapingArgs
    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 ApplianceTrafficShapingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplianceTrafficShapingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplianceTrafficShapingArgs
    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 applianceTrafficShapingResource = new Meraki.Networks.ApplianceTrafficShaping("applianceTrafficShapingResource", new()
    {
        NetworkId = "string",
        GlobalBandwidthLimits = new Meraki.Networks.Inputs.ApplianceTrafficShapingGlobalBandwidthLimitsArgs
        {
            LimitDown = 0,
            LimitUp = 0,
        },
    });
    
    example, err := networks.NewApplianceTrafficShaping(ctx, "applianceTrafficShapingResource", &networks.ApplianceTrafficShapingArgs{
    	NetworkId: pulumi.String("string"),
    	GlobalBandwidthLimits: &networks.ApplianceTrafficShapingGlobalBandwidthLimitsArgs{
    		LimitDown: pulumi.Int(0),
    		LimitUp:   pulumi.Int(0),
    	},
    })
    
    var applianceTrafficShapingResource = new ApplianceTrafficShaping("applianceTrafficShapingResource", ApplianceTrafficShapingArgs.builder()
        .networkId("string")
        .globalBandwidthLimits(ApplianceTrafficShapingGlobalBandwidthLimitsArgs.builder()
            .limitDown(0)
            .limitUp(0)
            .build())
        .build());
    
    appliance_traffic_shaping_resource = meraki.networks.ApplianceTrafficShaping("applianceTrafficShapingResource",
        network_id="string",
        global_bandwidth_limits=meraki.networks.ApplianceTrafficShapingGlobalBandwidthLimitsArgs(
            limit_down=0,
            limit_up=0,
        ))
    
    const applianceTrafficShapingResource = new meraki.networks.ApplianceTrafficShaping("applianceTrafficShapingResource", {
        networkId: "string",
        globalBandwidthLimits: {
            limitDown: 0,
            limitUp: 0,
        },
    });
    
    type: meraki:networks:ApplianceTrafficShaping
    properties:
        globalBandwidthLimits:
            limitDown: 0
            limitUp: 0
        networkId: string
    

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

    NetworkId string
    networkId path parameter. Network ID
    GlobalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    NetworkId string
    networkId path parameter. Network ID
    GlobalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimitsArgs
    Global per-client bandwidth limit
    networkId String
    networkId path parameter. Network ID
    globalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    networkId string
    networkId path parameter. Network ID
    globalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    network_id str
    networkId path parameter. Network ID
    global_bandwidth_limits ApplianceTrafficShapingGlobalBandwidthLimitsArgs
    Global per-client bandwidth limit
    networkId String
    networkId path parameter. Network ID
    globalBandwidthLimits Property Map
    Global per-client bandwidth limit

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApplianceTrafficShaping 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 ApplianceTrafficShaping Resource

    Get an existing ApplianceTrafficShaping 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?: ApplianceTrafficShapingState, opts?: CustomResourceOptions): ApplianceTrafficShaping
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            global_bandwidth_limits: Optional[ApplianceTrafficShapingGlobalBandwidthLimitsArgs] = None,
            network_id: Optional[str] = None) -> ApplianceTrafficShaping
    func GetApplianceTrafficShaping(ctx *Context, name string, id IDInput, state *ApplianceTrafficShapingState, opts ...ResourceOption) (*ApplianceTrafficShaping, error)
    public static ApplianceTrafficShaping Get(string name, Input<string> id, ApplianceTrafficShapingState? state, CustomResourceOptions? opts = null)
    public static ApplianceTrafficShaping get(String name, Output<String> id, ApplianceTrafficShapingState 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:
    GlobalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    NetworkId string
    networkId path parameter. Network ID
    GlobalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimitsArgs
    Global per-client bandwidth limit
    NetworkId string
    networkId path parameter. Network ID
    globalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    networkId String
    networkId path parameter. Network ID
    globalBandwidthLimits ApplianceTrafficShapingGlobalBandwidthLimits
    Global per-client bandwidth limit
    networkId string
    networkId path parameter. Network ID
    global_bandwidth_limits ApplianceTrafficShapingGlobalBandwidthLimitsArgs
    Global per-client bandwidth limit
    network_id str
    networkId path parameter. Network ID
    globalBandwidthLimits Property Map
    Global per-client bandwidth limit
    networkId String
    networkId path parameter. Network ID

    Supporting Types

    ApplianceTrafficShapingGlobalBandwidthLimits, ApplianceTrafficShapingGlobalBandwidthLimitsArgs

    LimitDown int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    LimitUp int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    LimitDown int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    LimitUp int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    limitDown Integer
    The download bandwidth limit in Kbps. (0 represents no limit.)
    limitUp Integer
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    limitDown number
    The download bandwidth limit in Kbps. (0 represents no limit.)
    limitUp number
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    limit_down int
    The download bandwidth limit in Kbps. (0 represents no limit.)
    limit_up int
    The upload bandwidth limit in Kbps. (0 represents no limit.)
    limitDown Number
    The download bandwidth limit in Kbps. (0 represents no limit.)
    limitUp Number
    The upload bandwidth limit in Kbps. (0 represents no limit.)

    Import

    $ pulumi import meraki:networks/applianceTrafficShaping:ApplianceTrafficShaping example "network_id"
    

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi