App
This class encapsulates and extends the ROS resource type ALIYUN::SAG::App
, which is used to create a Smart Access Gateway (SAG) app instance.
Initializers
import com.aliyun.ros.cdk.sag.App;
App.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.autoPay(java.lang.Boolean)
.autoPay(IResolvable)
.dataPlan(java.lang.Number)
.dataPlan(IResolvable)
.period(java.lang.Number)
.period(IResolvable)
.userCount(java.lang.Number)
.userCount(IResolvable)
// .chargeType(java.lang.String)
// .chargeType(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. |
autoPay |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property autoPay: Specifies whether to automatically pay the bills of SAG APP instances. |
dataPlan |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property dataPlan: The quota of the traffic plan that the system allows each client account to use for free each month. |
period |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property period: The subscription period of the SAG APP instance. |
userCount |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property userCount: The quota of client accounts for the SAG APP instance. |
chargeType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property chargeType: The billing method of the SAG APP instance. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
autoPay
Required
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoPay: Specifies whether to automatically pay the bills of SAG APP instances.
Default value: false. Valid values: true: automatically pays the bills of SAG APP instances. false: does not automatically pay the bills of SAG APP instances. If you set the parameter to false, after you call this operation, go to Billing Management of the SAG console to complete the payment, the instance can be created.
dataPlan
Required
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property dataPlan: The quota of the traffic plan that the system allows each client account to use for free each month.
Unit: GB. Set the value to 5. Note The system allows each client account to use 5 GB traffic plan for free.
period
Required
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: The subscription period of the SAG APP instance.
Unit: months. Valid values: 1~9, 12, 24, and 36.
userCount
Required
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property userCount: The quota of client accounts for the SAG APP instance.
Note The quota must be a positive multiple of 5, for example, 5, 10, and 15.
chargeType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property chargeType: The billing method of the SAG APP instance.
Set the value to PREPAY. This value indicates that the SAG APP instance is a subscription resource.
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. |
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
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.sag.App;
App.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. |
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. |
attrOrderId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute OrderId: The ID of the order that you placed to subscribe to the SAG APP instance. |
attrSmartAgId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute SmartAGId: The ID of the SAG APP instance. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrOrderId
Required
public IResolvable getAttrOrderId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute OrderId: The ID of the order that you placed to subscribe to the SAG APP instance.
attrSmartAgId
Required
public IResolvable getAttrSmartAgId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute SmartAGId: The ID of the SAG APP instance.