Skip to content

ResourcePackage

This class encapsulates and extends the ROS resource type ALIYUN::BSS::ResourcePackage, which is used to create an instance that uses 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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

durationRequired

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


packageTypeRequired

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


productCodeRequired

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


specificationRequired

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


effectiveDateOptional

  • 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


pricingCycleOptional

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

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


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

attrInstanceIdRequired

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the specified instance.


attrOrderIdRequired

public IResolvable getAttrOrderId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: The ID of the specified order.