Skip to content

RosTrafficQosRule

This class is a base encapsulation around the ROS resource type ALIYUN::VPC::TrafficQosRule.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Vpc;
new RosTrafficQosRule(Construct Scope, string Id, RosTrafficQosRuleProps Props, bool EnableResourcePropertyConstraint);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct - scope in which this resource is defined.
Id string - scoped id of the resource.
Props RosTrafficQosRuleProps - resource properties.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.


IdRequired

  • Type: string

scoped id of the resource.


PropsRequired

resource properties.


EnableResourcePropertyConstraintRequired

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
FetchCondition No description.
FetchDesc No description.
FetchRosDependency No description.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

SessionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • Type: string

The path of the value to delete.


AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

TargetRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

PathRequired

  • Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


ValueRequired

  • Type: object

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPathRequired

  • Type: string

The path to the property.


AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

PolicyOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

OptionsOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

FetchCondition

private RosCondition FetchCondition()

FetchDesc

private string FetchDesc()

FetchRosDependency

private string[] FetchRosDependency()

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeNameRequired

  • Type: string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Vpc;
RosTrafficQosRule.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Vpc;
RosTrafficQosRule.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

XRequired

  • Type: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Vpc;
RosTrafficQosRule.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
CreationStack string[] No description.
LogicalId string The logical ID for this stack element.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this element is defined.
Ref string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType string ROS resource type.
AttrDstCidr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDstIpv6Cidr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrDstPortRange AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMatchDscp AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPriority AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrProtocol AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrQosId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrQueueId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrRemarkingDscp AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrRuleDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrRuleId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrRuleName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSrcCidr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSrcIpv6Cidr AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSrcPortRange AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
EnableResourcePropertyConstraint bool No description.
Priority object No description.
Protocol object No description.
QosId object No description.
QueueId object No description.
DstCidr object No description.
DstIpv6Cidr object No description.
DstPortRange object No description.
MatchDscp object No description.
RemarkingDscp object No description.
RuleDescription object No description.
RuleName object No description.
SrcCidr object No description.
SrcIpv6Cidr object No description.
SrcPortRange object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

public string LogicalId { get; }
  • Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

public string Ref { get; }
  • Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


RosOptionsRequired

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrDstCidrRequired

public IResolvable AttrDstCidr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDstIpv6CidrRequired

public IResolvable AttrDstIpv6Cidr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrDstPortRangeRequired

public IResolvable AttrDstPortRange { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMatchDscpRequired

public IResolvable AttrMatchDscp { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPriorityRequired

public IResolvable AttrPriority { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrProtocolRequired

public IResolvable AttrProtocol { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrQosIdRequired

public IResolvable AttrQosId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrQueueIdRequired

public IResolvable AttrQueueId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRemarkingDscpRequired

public IResolvable AttrRemarkingDscp { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRuleDescriptionRequired

public IResolvable AttrRuleDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRuleIdRequired

public IResolvable AttrRuleId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrRuleNameRequired

public IResolvable AttrRuleName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSrcCidrRequired

public IResolvable AttrSrcCidr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSrcIpv6CidrRequired

public IResolvable AttrSrcIpv6Cidr { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSrcPortRangeRequired

public IResolvable AttrSrcPortRange { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

PriorityRequired

public object Priority { get; }
  • Type: object

ProtocolRequired

public object Protocol { get; }
  • Type: object

QosIdRequired

public object QosId { get; }
  • Type: object

QueueIdRequired

public object QueueId { get; }
  • Type: object

DstCidrOptional

public object DstCidr { get; }
  • Type: object

DstIpv6CidrOptional

public object DstIpv6Cidr { get; }
  • Type: object

DstPortRangeOptional

public object DstPortRange { get; }
  • Type: object

MatchDscpOptional

public object MatchDscp { get; }
  • Type: object

RemarkingDscpOptional

public object RemarkingDscp { get; }
  • Type: object

RuleDescriptionOptional

public object RuleDescription { get; }
  • Type: object

RuleNameOptional

public object RuleName { get; }
  • Type: object

SrcCidrOptional

public object SrcCidr { get; }
  • Type: object

SrcIpv6CidrOptional

public object SrcIpv6Cidr { get; }
  • Type: object

SrcPortRangeOptional

public object SrcPortRange { get; }
  • Type: object

Constants

Name Type Description
RosResourceTypeName string The resource type name for this resource class.

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.