Skip to content

DeploymentSet

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

Initializers

import com.aliyun.ros.cdk.ecs.DeploymentSet;
DeploymentSet.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .deploymentSetName(java.lang.String)
//  .deploymentSetName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .groupCount(java.lang.Number)
//  .groupCount(IResolvable)
//  .onUnableToRedeployFailedInstance(java.lang.String)
//  .onUnableToRedeployFailedInstance(IResolvable)
//  .strategy(java.lang.String)
//  .strategy(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.
deploymentSetName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property deploymentSetName: The name of the deployment set.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the deployment set.
groupCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property groupCount: Set the number of groups for the deployment set group high availability policy.
onUnableToRedeployFailedInstance java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property onUnableToRedeployFailedInstance: The policy to use when an instance fails over but cannot be redeployed due to insufficient resources.
strategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property strategy: The deployment strategy.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

deploymentSetNameOptional

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

Property deploymentSetName: The name of the deployment set.

It must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).


descriptionOptional

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

Property description: The description of the deployment set.

It must be 2 to 256 characters in length. It cannot start with http:// or https://.


groupCountOptional

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

Property groupCount: Set the number of groups for the deployment set group high availability policy.

Value range: 1~7. Default value: 3. This parameter only takes effect when Strategy=AvailabilityGroup.


onUnableToRedeployFailedInstanceOptional

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

Property onUnableToRedeployFailedInstance: The policy to use when an instance fails over but cannot be redeployed due to insufficient resources.

Valid values:

  • CancelMembershipAndStart: Removes the instance from the deployment set and starts the instance immediately after failover.
  • KeepStopped: Keeps the instance's deployment set membership and leaves it in the Stopped state. Default value: CancelMembershipAndStart.

strategyOptional

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

Property strategy: The deployment strategy.

Valid values:

  • Availability: A high availability strategy.
  • AvailabilityGroup: A high availability strategy for a deployment set group.
  • LowLatency: A low-latency strategy. Default value: Availability.

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.DeploymentSet;
DeploymentSet.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.
attrDeploymentSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DeploymentSetId: The ID of the deployment set.
props DeploymentSetProps 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

attrDeploymentSetIdRequired

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

Attribute DeploymentSetId: The ID of the deployment set.


propsRequired

public DeploymentSetProps getProps();