Skip to content

Activation

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

Initializers

import com.aliyun.ros.cdk.ecs.Activation;
Activation.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .instanceCount(java.lang.Number)
//  .instanceCount(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .ipAddressRange(java.lang.String)
//  .ipAddressRange(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeToLiveInHours(java.lang.Number)
//  .timeToLiveInHours(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.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the activation code.
instanceCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property instanceCount: The maximum number of times that you can use the activation code to register managed instances.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The default instance name prefix.
ipAddressRange java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipAddressRange: The IP addresses of hosts that are allowed to use the activation code.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
timeToLiveInHours java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeToLiveInHours: The validity period of the activation code.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

descriptionOptional

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

Property description: The description of the activation code.

It must be 1 to 100 characters in length.


instanceCountOptional

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

Property instanceCount: The maximum number of times that you can use the activation code to register managed instances.

Valid values: 1 to 1000.Default value: 10.


instanceNameOptional

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

Property instanceName: The default instance name prefix.

The instance name prefix must be 2 to 50 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, periods (.), underscores (_), hyphens (-), and colons (:). If you use the activation code that is created by calling this operation (CreateActivation) to register managed instances, the instances are assigned sequential names that are prefixed by the value of this parameter. You can also specify a new instance name to replace the assigned sequential name when you register a managed instance.If you specify InstanceName when you register a managed instance, an instance name in theformat of - is generated. The number of digits in the value isdetermined by that in the InstanceCount value. Example: 001. If you do not specify InstanceName, the hostname (Hostname) is used as the instance name.


ipAddressRangeOptional

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

Property ipAddressRange: The IP addresses of hosts that are allowed to use the activation code.

The value can be IPv4 addresses, IPv6 addresses, or CIDR blocks.


resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.


tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


timeToLiveInHoursOptional

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

Property timeToLiveInHours: The validity period of the activation code.

The activation code can no longer be used to register instances after the period ends. Unit: hours. Valid values: 1 to 876576, which represents a range of time from 1 hour to 100 years.Default value: 4.


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.Activation;
Activation.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.
attrActivationCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ActivationCode: Activation code.
attrActivationId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ActivationId: Activation code ID.
attrArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrDeregisteredCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DeregisteredCount: The number of instances that have been logged out.
attrRegisteredCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RegisteredCount: The number of registered instances.
props ActivationProps 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

attrActivationCodeRequired

public java.lang.Object getAttrActivationCode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ActivationCode: Activation code.


attrActivationIdRequired

public java.lang.Object getAttrActivationId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ActivationId: Activation code ID.


attrArnRequired

public java.lang.Object getAttrArn();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


attrDeregisteredCountRequired

public java.lang.Object getAttrDeregisteredCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DeregisteredCount: The number of instances that have been logged out.


attrRegisteredCountRequired

public java.lang.Object getAttrRegisteredCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RegisteredCount: The number of registered instances.


propsRequired

public ActivationProps getProps();