Skip to content

ElasticityAssurance

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

Initializers

import com.aliyun.ros.cdk.ecs.ElasticityAssurance;
ElasticityAssurance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .instanceAmount(java.lang.Number)
    .instanceAmount(IResolvable)
    .instanceTypes(IResolvable)
    .instanceTypes(java.util.List<java.lang.String)
    .instanceTypes(IResolvable>)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .instanceCpuCoreCount(java.lang.Number)
//  .instanceCpuCoreCount(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privatePoolOptions(IResolvable)
//  .privatePoolOptions(PrivatePoolOptionsProperty)
//  .recurrenceRules(IResolvable)
//  .recurrenceRules(java.util.List<IResolvable)
//  .recurrenceRules(RecurrenceRulesProperty>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .startTime(java.lang.String)
//  .startTime(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.
instanceTypes com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property instanceTypes: Instance type.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The zone ID of the elasticity assurance.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal for the elasticity assurance.
autoRenewPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property autoRenewPeriod: The auto-renewal period.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the elasticity assurance.
instanceCpuCoreCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceCpuCoreCount: > This parameter is no longer used.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The validity period of the elasticity assurance.
periodUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodUnit: The unit of the validity period of the elasticity assurance.
privatePoolOptions com.aliyun.ros.cdk.core.IResolvable OR PrivatePoolOptionsProperty Property privatePoolOptions:.
recurrenceRules com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRecurrenceRulesProperty> Property recurrenceRules: The assurance schedules based on which the capacity reservation takes effect.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which to assign the elasticity assurance.
startTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property startTime: The time when the elasticity assurance takes effect.
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.

Valid values: 1 to 1000.


instanceTypesRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property instanceTypes: Instance type.

Currently, an elasticity assurance can be created to reserve the capacity of a single instance type.


zoneIdRequired

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

Property zoneId: The zone ID of the elasticity assurance.

Currently, an elasticity assurance can be used to reserve resources within a single zone.


autoRenewOptional

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

Property autoRenew: Specifies whether to enable auto-renewal for the elasticity assurance.

Valid values:

  • true
  • false Default value: false.

autoRenewPeriodOptional

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

Property autoRenewPeriod: The auto-renewal period.

Unit: month. Valid values: 1, 2, 3, 6, 12, 24, and 36.

  • Default value when PeriodUnit is set to Month: 1.
  • Default value when PeriodUnit is set to Year: 12.

If you set AutoRenew to true, you must specify this parameter.


descriptionOptional

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

Property description: The description of the elasticity assurance.

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


instanceCpuCoreCountOptional

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

Property instanceCpuCoreCount: > This parameter is no longer used.


periodOptional

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

Property period: The validity period of the elasticity assurance.

The unit of the validity period is determined by the value of PeriodUnit. Specifies whether to check the image used by the instance supports hot migration. Valid values:

  • When the value of PeriodUnit is Month, the valid values are 1, 2, 3, 4, 5, 6, 7, 8, and 9.
  • When the value of PeriodUnit is Year, the valid values are 1, 2, 3, 4, and

1.

  • When the value of PeriodUnit is Day, the valid values are 1 to 365. Default value: 1

periodUnitOptional

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

Property periodUnit: The unit of the validity period of the elasticity assurance.

Valid values:

  • Month
  • Year
  • Day ** Note If you set PeriodUnit to Day, you must specify RecurrenceRules to create a time-segmented elasticity assurance. Default value: Year.

privatePoolOptionsOptional

Property privatePoolOptions:.


recurrenceRulesOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRecurrenceRulesProperty>

Property recurrenceRules: The assurance schedules based on which the capacity reservation takes effect.

Time-segmented elasticity assurances are available only in specific regions and to specific users. To use time-segmented elasticity assurances, submit a ticket.


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 elasticity assurance.


startTimeOptional

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

Property startTime: The time when the elasticity assurance takes effect.

The default value is the time when the CreateElasticityAssurance operation is called to create the elasticity assurance. 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.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.ElasticityAssurance;
ElasticityAssurance.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrivatePoolOptionsId: The ID of the elasticity assurance.
props ElasticityAssuranceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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 java.lang.Object getAttrPrivatePoolOptionsId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrivatePoolOptionsId: The ID of the elasticity assurance.


propsRequired

public ElasticityAssuranceProps getProps();