TrafficQosRule
- Implements: ITrafficQosRule
This class encapsulates and extends the ROS resource type ALIYUN::VPC::TrafficQosRule.
Initializers
import com.aliyun.ros.cdk.vpc.TrafficQosRule;
TrafficQosRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.priority(java.lang.Number)
.priority(IResolvable)
.protocol(java.lang.String)
.protocol(IResolvable)
.qosId(java.lang.String)
.qosId(IResolvable)
.queueId(java.lang.String)
.queueId(IResolvable)
// .dstCidr(java.lang.String)
// .dstCidr(IResolvable)
// .dstIpv6Cidr(java.lang.String)
// .dstIpv6Cidr(IResolvable)
// .dstPortRange(java.lang.String)
// .dstPortRange(IResolvable)
// .matchDscp(java.lang.Number)
// .matchDscp(IResolvable)
// .remarkingDscp(java.lang.Number)
// .remarkingDscp(IResolvable)
// .ruleDescription(java.lang.String)
// .ruleDescription(IResolvable)
// .ruleName(java.lang.String)
// .ruleName(IResolvable)
// .srcCidr(java.lang.String)
// .srcCidr(IResolvable)
// .srcIpv6Cidr(java.lang.String)
// .srcIpv6Cidr(IResolvable)
// .srcPortRange(java.lang.String)
// .srcPortRange(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
priority | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property priority: The priority of the QoS rule. |
protocol | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property protocol: QoS rule protocol type, value: - ALL - ICMP(IPv4) - ICMPv6(IPv6)* * - TCP - UDP - GRE - SSH - Telnet - HTTP - HTTPS - MS SQL - Oracle - MySql - RDP - PostgreSQL - Redis**. |
qosId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property qosId: The QoS policy ID. |
queueId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property queueId: The QoS queue ID. |
dstCidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic. |
dstIpv6Cidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment. |
dstPortRange | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dstPortRange: QoS rule traffic matches the destination port number range. |
matchDscp | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property matchDscp: The DSCP value that matches the QoS rule traffic. |
remarkingDscp | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property remarkingDscp: The new DSCP value. |
ruleDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ruleDescription: The description of the QoS rule. |
ruleName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ruleName: The name of the QoS rule. |
srcCidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property srcCidr: The source IPv4 CIDR block that matches the QoS rule traffic. |
srcIpv6Cidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property srcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment. |
srcPortRange | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property srcPortRange: The source port number of the QoS rule traffic matching. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
priorityRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property priority: The priority of the QoS rule.
Valid values: 1 to 9000. A larger value indicates a higher priority. The priority of each QoS rule must be unique in the same QoS policy.
protocolRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocol: QoS rule protocol type, value: - ALL - ICMP(IPv4) - ICMPv6(IPv6)* * - TCP - UDP - GRE - SSH - Telnet - HTTP - HTTPS - MS SQL - Oracle - MySql - RDP - PostgreSQL - Redis**.
qosIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property qosId: The QoS policy ID.
queueIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property queueId: The QoS queue ID.
dstCidrOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.
If this parameter is not supported, enter SrcIPv6Cidr or *DstIPv6Cidr * .
dstIpv6CidrOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.
If this parameter is not supported, enter SrcCidr or *DstCidr * .
dstPortRangeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dstPortRange: QoS rule traffic matches the destination port number range.
Value range: 0 to 65535. If not, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same. The corresponding destination port number range is fixed for different protocol types. The values are as follows:
- ALL:-1/-1, not editable.
- ICMP(IPv4):-1/-1, non-editable.
- ICMPv6(IPv6):-1/-1, non-editable.
- TCP:-1/-1, editable.
- UDP:-1/-1, editable.
- GRE:-1/-1, not editable.
- SSH:22/22, not editable.
- Telnet:23/23, not editable.
- HTTP:80/80, non-editable.
- HTTPS:443/443, which cannot be edited.
- MS SQL:1443/1443, which cannot be edited.
- Oracle:1521/1521, non-editable.
- MySql:3306/3306, non-editable.
- RDP:3389/3389, non-editable.
- PostgreSQL:5432/5432, non-editable.
- Redis:6379/6379, non-editable.
matchDscpOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property matchDscp: The DSCP value that matches the QoS rule traffic.
Valid values: 0 to 63. If no value is matched, the value is -1.
remarkingDscpOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property remarkingDscp: The new DSCP value.
Valid values: 0 to 63. If you do not change the value, set the value to -1.
ruleDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ruleDescription: The description of the QoS rule.
The length is 0 to 256 characters and cannot start with 'http:// 'or 'https.
ruleNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ruleName: The name of the QoS rule.
The length is 0 to 128 characters and cannot start with 'http:// 'or 'https.
srcCidrOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property srcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.
If this parameter is not supported, enter SrcIPv6Cidr or *DstIPv6Cidr * .
srcIpv6CidrOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property srcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.
If this parameter is not supported, enter SrcCidr or *DstCidr * .
srcPortRangeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property srcPortRange: The source port number of the QoS rule traffic matching.
The value range is 0 to 65535. If the traffic does not match, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vpc.TrafficQosRule;
TrafficQosRule.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrDstCidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic. |
attrDstIpv6Cidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment. |
attrDstPortRange | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DstPortRange: QoS rule traffic matches the destination port number range. |
attrMatchDscp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MatchDscp: The DSCP value of the traffic matched by the QoS rule. |
attrPriority | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Priority: QoS rule priority. |
attrProtocol | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Protocol: QoS rule protocol type. |
attrQosId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute QosId: The QoS policy ID. |
attrQueueId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute QueueId: The QoS queue ID. |
attrRemarkingDscp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RemarkingDscp: Modify The DSCP value in the flow. |
attrRuleDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RuleDescription: The description of the QoS rule. |
attrRuleId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RuleId: The ID of the QoS rule. |
attrRuleName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RuleName: The name of the QoS rule. |
attrSrcCidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SrcCidr: The source IPv4 CIDR block that matches the QoS rule traffic. |
attrSrcIpv6Cidr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SrcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment. |
attrSrcPortRange | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SrcPortRange: The source port number of the QoS rule traffic matching. |
props | TrafficQosRuleProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrDstCidrRequired
public java.lang.Object getAttrDstCidr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.
attrDstIpv6CidrRequired
public java.lang.Object getAttrDstIpv6Cidr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.
attrDstPortRangeRequired
public java.lang.Object getAttrDstPortRange();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DstPortRange: QoS rule traffic matches the destination port number range.
Value range: 0 to 65535. If not, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same. The corresponding destination port number range is fixed for different protocol types.
attrMatchDscpRequired
public java.lang.Object getAttrMatchDscp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MatchDscp: The DSCP value of the traffic matched by the QoS rule.
Value range: 0 to 63. If not, the value is -1.
attrPriorityRequired
public java.lang.Object getAttrPriority();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Priority: QoS rule priority.
Value range: 1 to 9000. The larger the number, the higher the priority. The priority of a QoS rule cannot be repeated in the same QoS policy.
attrProtocolRequired
public java.lang.Object getAttrProtocol();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Protocol: QoS rule protocol type.
attrQosIdRequired
public java.lang.Object getAttrQosId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute QosId: The QoS policy ID.
attrQueueIdRequired
public java.lang.Object getAttrQueueId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute QueueId: The QoS queue ID.
attrRemarkingDscpRequired
public java.lang.Object getAttrRemarkingDscp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RemarkingDscp: Modify The DSCP value in the flow.
Value range: 0 to 63. If the value is not modified, the value is -1.
attrRuleDescriptionRequired
public java.lang.Object getAttrRuleDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RuleDescription: The description of the QoS rule.
attrRuleIdRequired
public java.lang.Object getAttrRuleId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RuleId: The ID of the QoS rule.
attrRuleNameRequired
public java.lang.Object getAttrRuleName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RuleName: The name of the QoS rule.
attrSrcCidrRequired
public java.lang.Object getAttrSrcCidr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SrcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.
attrSrcIpv6CidrRequired
public java.lang.Object getAttrSrcIpv6Cidr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SrcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.
attrSrcPortRangeRequired
public java.lang.Object getAttrSrcPortRange();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SrcPortRange: The source port number of the QoS rule traffic matching.
The value range is 0 to 65535. If the traffic does not match, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same.
propsRequired
public TrafficQosRuleProps getProps();
- Type: TrafficQosRuleProps