QosProfile resource
Create QosProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new QosProfile(name: string, args?: QosProfileArgs, opts?: CustomResourceOptions);@overload
def QosProfile(resource_name: str,
args: Optional[QosProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def QosProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
aggregate_bandwidth: Optional[QosProfileAggregateBandwidthArgs] = None,
class_bandwidth_type: Optional[QosProfileClassBandwidthTypeArgs] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None)func NewQosProfile(ctx *Context, name string, args *QosProfileArgs, opts ...ResourceOption) (*QosProfile, error)public QosProfile(string name, QosProfileArgs? args = null, CustomResourceOptions? opts = null)
public QosProfile(String name, QosProfileArgs args)
public QosProfile(String name, QosProfileArgs args, CustomResourceOptions options)
type: scm:QosProfile
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 QosProfileArgs
- 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 QosProfileArgs
- 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 QosProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args QosProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args QosProfileArgs
- 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 qosProfileResource = new Scm.QosProfile("qosProfileResource", new()
{
AggregateBandwidth = new Scm.Inputs.QosProfileAggregateBandwidthArgs
{
EgressGuaranteed = 0,
EgressMax = 0,
},
ClassBandwidthType = new Scm.Inputs.QosProfileClassBandwidthTypeArgs
{
Mbps = new Scm.Inputs.QosProfileClassBandwidthTypeMbpsArgs
{
Classes = new[]
{
new Scm.Inputs.QosProfileClassBandwidthTypeMbpsClassArgs
{
ClassBandwidth = new Scm.Inputs.QosProfileClassBandwidthTypeMbpsClassClassBandwidthArgs
{
EgressGuaranteed = 0,
EgressMax = 0,
},
Name = "string",
Priority = "string",
},
},
},
Percentage = new Scm.Inputs.QosProfileClassBandwidthTypePercentageArgs
{
Classes = new[]
{
new Scm.Inputs.QosProfileClassBandwidthTypePercentageClassArgs
{
ClassBandwidth = new Scm.Inputs.QosProfileClassBandwidthTypePercentageClassClassBandwidthArgs
{
EgressGuaranteed = 0,
EgressMax = 0,
},
Name = "string",
Priority = "string",
},
},
},
},
Device = "string",
Folder = "string",
Name = "string",
Snippet = "string",
});
example, err := scm.NewQosProfile(ctx, "qosProfileResource", &scm.QosProfileArgs{
AggregateBandwidth: &scm.QosProfileAggregateBandwidthArgs{
EgressGuaranteed: pulumi.Int(0),
EgressMax: pulumi.Int(0),
},
ClassBandwidthType: &scm.QosProfileClassBandwidthTypeArgs{
Mbps: &scm.QosProfileClassBandwidthTypeMbpsArgs{
Classes: scm.QosProfileClassBandwidthTypeMbpsClassArray{
&scm.QosProfileClassBandwidthTypeMbpsClassArgs{
ClassBandwidth: &scm.QosProfileClassBandwidthTypeMbpsClassClassBandwidthArgs{
EgressGuaranteed: pulumi.Int(0),
EgressMax: pulumi.Int(0),
},
Name: pulumi.String("string"),
Priority: pulumi.String("string"),
},
},
},
Percentage: &scm.QosProfileClassBandwidthTypePercentageArgs{
Classes: scm.QosProfileClassBandwidthTypePercentageClassArray{
&scm.QosProfileClassBandwidthTypePercentageClassArgs{
ClassBandwidth: &scm.QosProfileClassBandwidthTypePercentageClassClassBandwidthArgs{
EgressGuaranteed: pulumi.Int(0),
EgressMax: pulumi.Int(0),
},
Name: pulumi.String("string"),
Priority: pulumi.String("string"),
},
},
},
},
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Name: pulumi.String("string"),
Snippet: pulumi.String("string"),
})
var qosProfileResource = new QosProfile("qosProfileResource", QosProfileArgs.builder()
.aggregateBandwidth(QosProfileAggregateBandwidthArgs.builder()
.egressGuaranteed(0)
.egressMax(0)
.build())
.classBandwidthType(QosProfileClassBandwidthTypeArgs.builder()
.mbps(QosProfileClassBandwidthTypeMbpsArgs.builder()
.classes(QosProfileClassBandwidthTypeMbpsClassArgs.builder()
.classBandwidth(QosProfileClassBandwidthTypeMbpsClassClassBandwidthArgs.builder()
.egressGuaranteed(0)
.egressMax(0)
.build())
.name("string")
.priority("string")
.build())
.build())
.percentage(QosProfileClassBandwidthTypePercentageArgs.builder()
.classes(QosProfileClassBandwidthTypePercentageClassArgs.builder()
.classBandwidth(QosProfileClassBandwidthTypePercentageClassClassBandwidthArgs.builder()
.egressGuaranteed(0)
.egressMax(0)
.build())
.name("string")
.priority("string")
.build())
.build())
.build())
.device("string")
.folder("string")
.name("string")
.snippet("string")
.build());
qos_profile_resource = scm.QosProfile("qosProfileResource",
aggregate_bandwidth={
"egress_guaranteed": 0,
"egress_max": 0,
},
class_bandwidth_type={
"mbps": {
"classes": [{
"class_bandwidth": {
"egress_guaranteed": 0,
"egress_max": 0,
},
"name": "string",
"priority": "string",
}],
},
"percentage": {
"classes": [{
"class_bandwidth": {
"egress_guaranteed": 0,
"egress_max": 0,
},
"name": "string",
"priority": "string",
}],
},
},
device="string",
folder="string",
name="string",
snippet="string")
const qosProfileResource = new scm.QosProfile("qosProfileResource", {
aggregateBandwidth: {
egressGuaranteed: 0,
egressMax: 0,
},
classBandwidthType: {
mbps: {
classes: [{
classBandwidth: {
egressGuaranteed: 0,
egressMax: 0,
},
name: "string",
priority: "string",
}],
},
percentage: {
classes: [{
classBandwidth: {
egressGuaranteed: 0,
egressMax: 0,
},
name: "string",
priority: "string",
}],
},
},
device: "string",
folder: "string",
name: "string",
snippet: "string",
});
type: scm:QosProfile
properties:
aggregateBandwidth:
egressGuaranteed: 0
egressMax: 0
classBandwidthType:
mbps:
classes:
- classBandwidth:
egressGuaranteed: 0
egressMax: 0
name: string
priority: string
percentage:
classes:
- classBandwidth:
egressGuaranteed: 0
egressMax: 0
name: string
priority: string
device: string
folder: string
name: string
snippet: string
QosProfile 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 QosProfile resource accepts the following input properties:
- Aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- Class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- Snippet string
- The snippet in which the resource is defined
- Aggregate
Bandwidth QosProfile Aggregate Bandwidth Args - Aggregate bandwidth
- Class
Bandwidth QosType Profile Class Bandwidth Type Args - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- Snippet string
- The snippet in which the resource is defined
- aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet String
- The snippet in which the resource is defined
- aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet string
- The snippet in which the resource is defined
- aggregate_
bandwidth QosProfile Aggregate Bandwidth Args - Aggregate bandwidth
- class_
bandwidth_ Qostype Profile Class Bandwidth Type Args - Class bandwidth type
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet str
- The snippet in which the resource is defined
- aggregate
Bandwidth Property Map - Aggregate bandwidth
- class
Bandwidth Property MapType - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet String
- The snippet in which the resource is defined
Outputs
All input properties are implicitly available as output properties. Additionally, the QosProfile resource produces the following output properties:
Look up Existing QosProfile Resource
Get an existing QosProfile 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?: QosProfileState, opts?: CustomResourceOptions): QosProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aggregate_bandwidth: Optional[QosProfileAggregateBandwidthArgs] = None,
class_bandwidth_type: Optional[QosProfileClassBandwidthTypeArgs] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
tfid: Optional[str] = None) -> QosProfilefunc GetQosProfile(ctx *Context, name string, id IDInput, state *QosProfileState, opts ...ResourceOption) (*QosProfile, error)public static QosProfile Get(string name, Input<string> id, QosProfileState? state, CustomResourceOptions? opts = null)public static QosProfile get(String name, Output<String> id, QosProfileState state, CustomResourceOptions options)resources: _: type: scm:QosProfile get: id: ${id}- 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.
- Aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- Class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- Aggregate
Bandwidth QosProfile Aggregate Bandwidth Args - Aggregate bandwidth
- Class
Bandwidth QosType Profile Class Bandwidth Type Args - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder in which the resource is defined
- Name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- Snippet string
- The snippet in which the resource is defined
- Tfid string
- aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet String
- The snippet in which the resource is defined
- tfid String
- aggregate
Bandwidth QosProfile Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth QosType Profile Class Bandwidth Type - Class bandwidth type
- device string
- The device in which the resource is defined
- folder string
- The folder in which the resource is defined
- name string
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet string
- The snippet in which the resource is defined
- tfid string
- aggregate_
bandwidth QosProfile Aggregate Bandwidth Args - Aggregate bandwidth
- class_
bandwidth_ Qostype Profile Class Bandwidth Type Args - Class bandwidth type
- device str
- The device in which the resource is defined
- folder str
- The folder in which the resource is defined
- name str
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet str
- The snippet in which the resource is defined
- tfid str
- aggregate
Bandwidth Property Map - Aggregate bandwidth
- class
Bandwidth Property MapType - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder in which the resource is defined
- name String
- Alphanumeric string begin with letter: [0-9a-zA-Z._-]
- snippet String
- The snippet in which the resource is defined
- tfid String
Supporting Types
QosProfileAggregateBandwidth, QosProfileAggregateBandwidthArgs
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- egress
Guaranteed Integer - guaranteed sending bandwidth in mbps
- egress
Max Integer - max sending bandwidth in mbps
- egress
Guaranteed number - guaranteed sending bandwidth in mbps
- egress
Max number - max sending bandwidth in mbps
- egress_
guaranteed int - guaranteed sending bandwidth in mbps
- egress_
max int - max sending bandwidth in mbps
- egress
Guaranteed Number - guaranteed sending bandwidth in mbps
- egress
Max Number - max sending bandwidth in mbps
QosProfileClassBandwidthType, QosProfileClassBandwidthTypeArgs
- mbps Property Map
- Mbps
- percentage Property Map
- Percentage
QosProfileClassBandwidthTypeMbps, QosProfileClassBandwidthTypeMbpsArgs
- Classes
List<Qos
Profile Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- Classes
[]Qos
Profile Class Bandwidth Type Mbps Class - QoS setting for traffic classes
- classes
List<Qos
Profile Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- classes
Qos
Profile Class Bandwidth Type Mbps Class[] - QoS setting for traffic classes
- classes
Sequence[Qos
Profile Class Bandwidth Type Mbps Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
QosProfileClassBandwidthTypeMbpsClass, QosProfileClassBandwidthTypeMbpsClassArgs
- Class
Bandwidth QosProfile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth QosProfile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth QosProfile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth QosProfile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth QosProfile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name str
- Traffic class
- priority str
- traffic class priority
- class
Bandwidth Property Map - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
QosProfileClassBandwidthTypeMbpsClassClassBandwidth, QosProfileClassBandwidthTypeMbpsClassClassBandwidthArgs
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- egress
Guaranteed Integer - guaranteed sending bandwidth in mbps
- egress
Max Integer - max sending bandwidth in mbps
- egress
Guaranteed number - guaranteed sending bandwidth in mbps
- egress
Max number - max sending bandwidth in mbps
- egress_
guaranteed int - guaranteed sending bandwidth in mbps
- egress_
max int - max sending bandwidth in mbps
- egress
Guaranteed Number - guaranteed sending bandwidth in mbps
- egress
Max Number - max sending bandwidth in mbps
QosProfileClassBandwidthTypePercentage, QosProfileClassBandwidthTypePercentageArgs
- Classes
List<Qos
Profile Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- Classes
[]Qos
Profile Class Bandwidth Type Percentage Class - QoS setting for traffic classes
- classes
List<Qos
Profile Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- classes
Qos
Profile Class Bandwidth Type Percentage Class[] - QoS setting for traffic classes
- classes
Sequence[Qos
Profile Class Bandwidth Type Percentage Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
QosProfileClassBandwidthTypePercentageClass, QosProfileClassBandwidthTypePercentageClassArgs
- Class
Bandwidth QosProfile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth QosProfile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth QosProfile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth QosProfile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth QosProfile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name str
- Traffic class
- priority str
- traffic class priority
- class
Bandwidth Property Map - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
QosProfileClassBandwidthTypePercentageClassClassBandwidth, QosProfileClassBandwidthTypePercentageClassClassBandwidthArgs
- Egress
Guaranteed int - guaranteed sending bandwidth in percentage
- Egress
Max int - max sending bandwidth in percentage
- Egress
Guaranteed int - guaranteed sending bandwidth in percentage
- Egress
Max int - max sending bandwidth in percentage
- egress
Guaranteed Integer - guaranteed sending bandwidth in percentage
- egress
Max Integer - max sending bandwidth in percentage
- egress
Guaranteed number - guaranteed sending bandwidth in percentage
- egress
Max number - max sending bandwidth in percentage
- egress_
guaranteed int - guaranteed sending bandwidth in percentage
- egress_
max int - max sending bandwidth in percentage
- egress
Guaranteed Number - guaranteed sending bandwidth in percentage
- egress
Max Number - max sending bandwidth in percentage
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
