Gateway2
- Implements: IGateway2
This class encapsulates and extends the ROS resource type ALIYUN::MSE::Gateway2.
Initializers
import com.aliyun.ros.cdk.mse.Gateway2;
Gateway2.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.vpcId(java.lang.String)
.vpcId(IResolvable)
// .acceptLanguage(java.lang.String)
// .acceptLanguage(IResolvable)
// .chargeType(java.lang.String)
// .chargeType(IResolvable)
// .clbNetworkType(java.lang.String)
// .clbNetworkType(IResolvable)
// .enableHardwareAcceleration(java.lang.Boolean)
// .enableHardwareAcceleration(IResolvable)
// .enableSls(java.lang.Boolean)
// .enableSls(IResolvable)
// .enableXtrace(java.lang.Boolean)
// .enableXtrace(IResolvable)
// .enterpriseSecurityGroup(java.lang.Boolean)
// .enterpriseSecurityGroup(IResolvable)
// .internetSlb(java.lang.String)
// .internetSlb(IResolvable)
// .managedEntryNetworkType(java.lang.String)
// .managedEntryNetworkType(IResolvable)
// .mserVersion(java.lang.String)
// .mserVersion(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .nlbNetworkType(java.lang.String)
// .nlbNetworkType(IResolvable)
// .period(java.lang.Number)
// .period(IResolvable)
// .periodUnit(java.lang.String)
// .periodUnit(IResolvable)
// .replica(java.lang.Number)
// .replica(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .slbSpec(java.lang.String)
// .slbSpec(IResolvable)
// .spec(java.lang.String)
// .spec(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .vSwitchId(java.lang.String)
// .vSwitchId(IResolvable)
// .vSwitchId2(java.lang.String)
// .vSwitchId2(IResolvable)
// .xtraceRatio(java.lang.Number)
// .xtraceRatio(IResolvable)
// .zoneInfo(IResolvable)
// .zoneInfo(java.util.List<IResolvable)
// .zoneInfo(ZoneInfoProperty>)
.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. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the vpc. |
acceptLanguage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property acceptLanguage: The language of the response. |
chargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property chargeType: The billing method you specify when you purchase an normal instance. |
clbNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clbNetworkType: The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs. |
enableHardwareAcceleration | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableHardwareAcceleration: Specifies whether to enable hardware acceleration. |
enableSls | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableSls: Specifies whether to activate Log Service. |
enableXtrace | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableXtrace: Whether to activate Tracing Analysis. |
enterpriseSecurityGroup | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enterpriseSecurityGroup: Specifies whether to use an Enterprise Security Group. |
internetSlb | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property internetSlb: Public network SLB specifications (for normal instances). |
managedEntryNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property managedEntryNetworkType: Gateway entrance type (applicable to the mse_premium instance) pubnet: public network privatenet: privatenet privatepubnet: public + private network. |
mserVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property mserVersion: The edition of the gateway. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the created gateway. |
nlbNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property nlbNetworkType: The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance. |
period | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property period: Prepaid time period. |
periodUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property periodUnit: Charge period for created instances. |
replica | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property replica: The number of nodes you specify when you purchase an normal instance. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group. |
slbSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property slbSpec: Private network SLB specifications (for normal instances). |
spec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property spec: The node specifications you specify when you purchase an normal instance. |
tags | java.util.List<TagsProperty> | Property tags: The list of tags in the form of key\/value pairs. |
vSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vSwitchId: The primary VSwitch ID. |
vSwitchId2 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vSwitchId2: The secondary VSwitch ID. |
xtraceRatio | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property xtraceRatio: The sampling rate of Tracing Analysis. |
zoneInfo | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property zoneInfo: The info details of the available zone. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the vpc.
acceptLanguageOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property acceptLanguage: The language of the response.
Valid values: zh: Chinese en: English
chargeTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property chargeType: The billing method you specify when you purchase an normal instance.
Valid values: PREPAY: subscription POSTPAY: pay-as-you-go
clbNetworkTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clbNetworkType: The network type of the purchased Classic Load Balancer (CLB) instance that is billed based on LCUs.
pubnet: Internet privatenet: private network privatepubnet: Internet and private network
enableHardwareAccelerationOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableHardwareAcceleration: Specifies whether to enable hardware acceleration.
enableSlsOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableSls: Specifies whether to activate Log Service.
enableXtraceOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableXtrace: Whether to activate Tracing Analysis.
enterpriseSecurityGroupOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enterpriseSecurityGroup: Specifies whether to use an Enterprise Security Group.
internetSlbOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property internetSlb: Public network SLB specifications (for normal instances).
Simple type (slb.s1.small) Standard type 1 (slb.s2.smal) Standard type I(slb.s2.medium) Advanced Type 1 (slb.s3.small) Advanced I(slb.s3.medium) Super strong type I (slb.s3.large) Description Traditional example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU, and CLB specifications. Serverless example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU
managedEntryNetworkTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property managedEntryNetworkType: Gateway entrance type (applicable to the mse_premium instance) pubnet: public network privatenet: privatenet privatepubnet: public + private network.
mserVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property mserVersion: The edition of the gateway.
mse_premium: Professional Editionmse_pro: Standard Editionmse_serverless: Serverless Edition
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the created gateway.
nlbNetworkTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property nlbNetworkType: The network type of the Network Load Balancer (NLB) instance you specify when you purchase a serverless instance.
pubnet: Internet privatenet: private network privatepubnet: Internet and private network
periodOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: Prepaid time period.
While choose by pay by month, it could be from 1 to 9. While choose pay by year, it could be from 1 to 3. This parameter is Only valid when updating from postpaid instance to prepaid instance.
periodUnitOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property periodUnit: Charge period for created instances.
This parameter is only valid when updating from postpaid instance to prepaid instance.
replicaOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property replica: The number of nodes you specify when you purchase an normal instance.
For high availability, the value for this param is recommended to be greater than 2.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
slbSpecOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property slbSpec: Private network SLB specifications (for normal instances).
Simple type (slb.s1.small) Standard type 1 (slb.s2.small) Standard type I(slb.s2.medium) Advanced Type 1 (slb.s3.small) Advanced I(slb.s3.medium) Super strong type I (slb.s3.large) Description Traditional example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU, and CLB specifications. Serverless example: When creating, you can only choose one purchasing agent in NLB, CLB billed by LCU
specOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property spec: The node specifications you specify when you purchase an normal instance.
Valid values: MSE_GTW_16_32_200_c(16C32G) MSE_GTW_2_4_200_c(2C4G) MSE_GTW_4_8_200_c(4C8G) MSE_GTW_8_16_200_c(8C16G)
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: The list of tags in the form of key\/value pairs.
You can define a maximum of 20 tags.
vSwitchIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The primary VSwitch ID.
vSwitchId2Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId2: The secondary VSwitch ID.
xtraceRatioOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property xtraceRatio: The sampling rate of Tracing Analysis.
Valid values: [1,100]
zoneInfoOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
ZoneInfoProperty>
Property zoneInfo: The info details of the available zone.
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.mse.Gateway2;
Gateway2.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. |
attrGatewayUniqueId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GatewayUniqueId: The unique ID of the gateway. |
props | Gateway2Props | 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
attrGatewayUniqueIdRequired
public java.lang.Object getAttrGatewayUniqueId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GatewayUniqueId: The unique ID of the gateway.
propsRequired
public Gateway2Props getProps();
- Type: Gateway2Props