ResourcePackage
This class encapsulates and extends the ROS resource type ALIYUN::BSS::ResourcePackage
, which is used to create a resource plan.
Initializers
import com.aliyun.ros.cdk.bss.ResourcePackage;
ResourcePackage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.duration(java.lang.Number)
.duration(IResolvable)
.packageType(java.lang.String)
.packageType(IResolvable)
.productCode(java.lang.String)
.productCode(IResolvable)
.specification(java.lang.String)
.specification(IResolvable)
// .effectiveDate(java.lang.String)
// .effectiveDate(IResolvable)
// .pricingCycle(java.lang.String)
// .pricingCycle(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. |
duration |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property duration: The validity of the specified resource package. |
packageType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property packageType: The type of the specified resource package. |
productCode |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property productCode: The code of the specified product. |
specification |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property specification: The size of the specified resource package. |
effectiveDate |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property effectiveDate: The effective date of the specified resource package. |
pricingCycle |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property pricingCycle: The validity of the specified resource package. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
duration
Required
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property duration: The validity of the specified resource package.
The value is the same as the Value of AvailableDuration returned by DescribeResourcePackageProduct.
packageType
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property packageType: The type of the specified resource package.
The value is the same as the value of the Code value of the ResourcePackage object returned by DescribeResourcePackageProduct.
productCode
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property productCode: The code of the specified product.
The value is the same as the value of ProductType returned by QueryProductList.
specification
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property specification: The size of the specified resource package.
The value is the same as the Value of Specification returned by DescribeResourcePackageProduct.
effectiveDate
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property effectiveDate: The effective date of the specified resource package.
The resource package will take effect immediately if the effective date is unspecified. The date format follows the ISO8601 standard and uses UTC time. Format: yyyy-MM-ddTHH:mm:ssZ
pricingCycle
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pricingCycle: The validity of the specified resource package.
Default value: Month. Valid values: Month, Year
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.bss.ResourcePackage;
ResourcePackage.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. |
attrInstanceId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute InstanceId: The ID of the specified instance. |
attrOrderId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute OrderId: The ID of the specified order. |
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
attrInstanceId
Required
public IResolvable getAttrInstanceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the specified instance.
attrOrderId
Required
public IResolvable getAttrOrderId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute OrderId: The ID of the specified order.