1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getBandwidthAllocation
Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi
scm logo
Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi

    BandwidthAllocation data source

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    // Look up an existing Bandwidth Allocation by name
    const example = scm.getBandwidthAllocation({
        name: "taiwan",
    });
    export const allocatedBandwidth = example.then(example => example.allocatedBandwidth);
    export const spnNameList = example.then(example => example.spnNameLists);
    export const qosProfile = example.then(example => example.qos?.profile);
    
    import pulumi
    import pulumi_scm as scm
    
    # Look up an existing Bandwidth Allocation by name
    example = scm.get_bandwidth_allocation(name="taiwan")
    pulumi.export("allocatedBandwidth", example.allocated_bandwidth)
    pulumi.export("spnNameList", example.spn_name_lists)
    pulumi.export("qosProfile", example.qos.profile)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Look up an existing Bandwidth Allocation by name
    		example, err := scm.LookupBandwidthAllocation(ctx, &scm.LookupBandwidthAllocationArgs{
    			Name: pulumi.StringRef("taiwan"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("allocatedBandwidth", example.AllocatedBandwidth)
    		ctx.Export("spnNameList", example.SpnNameLists)
    		ctx.Export("qosProfile", example.Qos.Profile)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        // Look up an existing Bandwidth Allocation by name
        var example = Scm.GetBandwidthAllocation.Invoke(new()
        {
            Name = "taiwan",
        });
    
        return new Dictionary<string, object?>
        {
            ["allocatedBandwidth"] = example.Apply(getBandwidthAllocationResult => getBandwidthAllocationResult.AllocatedBandwidth),
            ["spnNameList"] = example.Apply(getBandwidthAllocationResult => getBandwidthAllocationResult.SpnNameLists),
            ["qosProfile"] = example.Apply(getBandwidthAllocationResult => getBandwidthAllocationResult.Qos?.Profile),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetBandwidthAllocationArgs;
    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) {
            // Look up an existing Bandwidth Allocation by name
            final var example = ScmFunctions.getBandwidthAllocation(GetBandwidthAllocationArgs.builder()
                .name("taiwan")
                .build());
    
            ctx.export("allocatedBandwidth", example.allocatedBandwidth());
            ctx.export("spnNameList", example.spnNameLists());
            ctx.export("qosProfile", example.qos().profile());
        }
    }
    
    variables:
      # Look up an existing Bandwidth Allocation by name
      example:
        fn::invoke:
          function: scm:getBandwidthAllocation
          arguments:
            name: taiwan
    outputs:
      # Output the details retrieved from the API
      allocatedBandwidth: ${example.allocatedBandwidth}
      spnNameList: ${example.spnNameLists}
      qosProfile: ${example.qos.profile}
    

    Using getBandwidthAllocation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBandwidthAllocation(args: GetBandwidthAllocationArgs, opts?: InvokeOptions): Promise<GetBandwidthAllocationResult>
    function getBandwidthAllocationOutput(args: GetBandwidthAllocationOutputArgs, opts?: InvokeOptions): Output<GetBandwidthAllocationResult>
    def get_bandwidth_allocation(name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetBandwidthAllocationResult
    def get_bandwidth_allocation_output(name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetBandwidthAllocationResult]
    func LookupBandwidthAllocation(ctx *Context, args *LookupBandwidthAllocationArgs, opts ...InvokeOption) (*LookupBandwidthAllocationResult, error)
    func LookupBandwidthAllocationOutput(ctx *Context, args *LookupBandwidthAllocationOutputArgs, opts ...InvokeOption) LookupBandwidthAllocationResultOutput

    > Note: This function is named LookupBandwidthAllocation in the Go SDK.

    public static class GetBandwidthAllocation 
    {
        public static Task<GetBandwidthAllocationResult> InvokeAsync(GetBandwidthAllocationArgs args, InvokeOptions? opts = null)
        public static Output<GetBandwidthAllocationResult> Invoke(GetBandwidthAllocationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBandwidthAllocationResult> getBandwidthAllocation(GetBandwidthAllocationArgs args, InvokeOptions options)
    public static Output<GetBandwidthAllocationResult> getBandwidthAllocation(GetBandwidthAllocationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getBandwidthAllocation:getBandwidthAllocation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    name of the aggregated bandwidth region
    Name string
    name of the aggregated bandwidth region
    name String
    name of the aggregated bandwidth region
    name string
    name of the aggregated bandwidth region
    name str
    name of the aggregated bandwidth region
    name String
    name of the aggregated bandwidth region

    getBandwidthAllocation Result

    The following output properties are available:

    AllocatedBandwidth int
    bandwidth to allocate in Mbps
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    name of the aggregated bandwidth region
    Qos GetBandwidthAllocationQos
    Qos
    SpnNameLists List<string>
    Spn name list
    Tfid string
    AllocatedBandwidth int
    bandwidth to allocate in Mbps
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    name of the aggregated bandwidth region
    Qos GetBandwidthAllocationQos
    Qos
    SpnNameLists []string
    Spn name list
    Tfid string
    allocatedBandwidth Integer
    bandwidth to allocate in Mbps
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationQos
    Qos
    spnNameLists List<String>
    Spn name list
    tfid String
    allocatedBandwidth number
    bandwidth to allocate in Mbps
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationQos
    Qos
    spnNameLists string[]
    Spn name list
    tfid string
    allocated_bandwidth int
    bandwidth to allocate in Mbps
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationQos
    Qos
    spn_name_lists Sequence[str]
    Spn name list
    tfid str
    allocatedBandwidth Number
    bandwidth to allocate in Mbps
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    name of the aggregated bandwidth region
    qos Property Map
    Qos
    spnNameLists List<String>
    Spn name list
    tfid String

    Supporting Types

    GetBandwidthAllocationQos

    Customized bool
    Customized
    Enabled bool
    Enabled
    GuaranteedRatio double
    Guaranteed ratio
    Profile string
    Profile
    Customized bool
    Customized
    Enabled bool
    Enabled
    GuaranteedRatio float64
    Guaranteed ratio
    Profile string
    Profile
    customized Boolean
    Customized
    enabled Boolean
    Enabled
    guaranteedRatio Double
    Guaranteed ratio
    profile String
    Profile
    customized boolean
    Customized
    enabled boolean
    Enabled
    guaranteedRatio number
    Guaranteed ratio
    profile string
    Profile
    customized bool
    Customized
    enabled bool
    Enabled
    guaranteed_ratio float
    Guaranteed ratio
    profile str
    Profile
    customized Boolean
    Customized
    enabled Boolean
    Enabled
    guaranteedRatio Number
    Guaranteed ratio
    profile String
    Profile

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v1.0.3 published on Thursday, Jan 22, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate