Skip to content

CapacityReservation

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CapacityReservation, which is used to create a capacity reservation.

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
instanceAmount 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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The instance type.
zoneId 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.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the capacity reservation.
endTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endTime: The time when the capacity reservation expires.
endTimeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property endTimeType: The release mode of the capacity reservation.
privatePoolOptions com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty Property privatePoolOptions:.
resourceGroupId 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 java.util.List<TagsProperty> Property tags:.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

instanceAmountRequired

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

instanceTypeRequired

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

zoneIdRequired

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

descriptionOptional

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

endTimeOptional

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

endTimeTypeOptional

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

privatePoolOptionsOptional

Property privatePoolOptions:.

resourceGroupIdOptional

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

tagsOptional

Property tags:.

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.ecs.CapacityReservation;
CapacityReservation.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.
attrPrivatePoolOptionsId com.aliyun.ros.cdk.core.IResolvable Attribute PrivatePoolOptionsId: The ID of the capacity reservation.

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

attrPrivatePoolOptionsIdRequired 

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

Attribute PrivatePoolOptionsId: The ID of the capacity reservation.