Skip to content

DeploymentSet

This class encapsulates and extends the ROS resource type ALIYUN::ECS::DeploymentSet, which is used to create a deployment set in a region.

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 emergency solution to redeploy failed instances in the deployment set.
strategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property strategy: 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 emergency solution to redeploy failed instances in the deployment set.

Valid values: CancelMembershipAndStart: restarts the instances immediately after they are shut down and migrated to other deployment sets. This is the default value. KeepStopped: keeps the instances shut down and restarts them after the deployment set is replenished.

strategyOptional

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

Property strategy: Deployment strategy.

Ranges: Availability: High availability strategy. AvailabilityGroup: Deployment group high availability strategy. LowLatency: Network low latency strategy.

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.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.
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 com.aliyun.ros.cdk.core.IResolvable Attribute DeploymentSetId: The ID of the deployment set.

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

attrDeploymentSetIdRequired 

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

Attribute DeploymentSetId: The ID of the deployment set.