ResourcePackage

• Implements: IResourcePackage

This class encapsulates and extends the ROS resource type ALIYUN::BSS::ResourcePackage.

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)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .autoRenewPeriodUnit(java.lang.String)
//  .autoRenewPeriodUnit(IResolvable)
//  .effectiveDate(java.lang.String)
//  .effectiveDate(IResolvable)
//  .pricingCycle(java.lang.String)
//  .pricingCycle(IResolvable)
    .build();

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.

autoRenew^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Whether to automatically renew the resource package.

The value is true or false. Default value: false.

autoRenewPeriod^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: Duration of resource packs renewals.

Valid values:

• When AutoRenewPeriodUnit is Year: 1, 2, 3.
• When AutoRenewPeriodUnit is Month: 1, 2, 3, 6. Default is 1.

autoRenewPeriodUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriodUnit: Unit of resource pack renewals.

Valid values: Month, Year. Default is Month.

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

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.bss.ResourcePackage;
ResourcePackage.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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 java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the specified instance.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The ID of the specified order.

props^Required

public ResourcePackageProps getProps();

• Type: ResourcePackageProps