CapacityReservation

• Implements: ICapacityReservation

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CapacityReservation.

Initializers

import com.aliyun.ros.cdk.ecs.CapacityReservation;
CapacityReservation.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceAmount(java.lang.Number)
    .instanceAmount(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .endTime(java.lang.String)
//  .endTime(IResolvable)
//  .endTimeType(java.lang.String)
//  .endTimeType(IResolvable)
//  .privatePoolOptions(IResolvable)
//  .privatePoolOptions(PrivatePoolOptionsProperty)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

instanceAmount^Required

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

Property instanceAmount: The total number of instances for which to reserve capacity of an instance type.

instanceType^Required

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

Property instanceType: The instance type.

A capacity reservation can be created to reserve the capacity of only a single instance type. You can call the DescribeInstanceTypes operation to query the instance types provided by ECS.

zoneId^Required

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

Property zoneId: The ID of zone N within the region in which to create the capacity reservation.

A capacity reservation can reserve resources within only a single zone.

description^Optional

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

Property description: The description of the capacity reservation.

The description must be 2 to 256 characters in length and cannot start with http:// or https://. This parameter is empty by default.

endTime^Optional

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

Property endTime: The time when the capacity reservation expires.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For more information, see ISO 8601.

endTimeType^Optional

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

Property endTimeType: The release mode of the capacity reservation.

Valid values: Limited: The capacity reservation is automatically released at the specified time. If you specify this parameter, you must also specify the EndTime parameter. Unlimited: The capacity reservation must be manually released. You can release it anytime.

privatePoolOptions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty

Property privatePoolOptions:.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group to which to assign the capacity reservation.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags:.

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.ecs.CapacityReservation;
CapacityReservation.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

attrPrivatePoolOptionsId^Required

public java.lang.Object getAttrPrivatePoolOptionsId();

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

Attribute PrivatePoolOptionsId: The ID of the capacity reservation.

props^Required

public CapacityReservationProps getProps();

• Type: CapacityReservationProps