class ServerDeploymentConfig (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CodeDeploy.ServerDeploymentConfig
Java	software.amazon.awscdk.services.codedeploy.ServerDeploymentConfig
Python	aws_cdk.aws_codedeploy.ServerDeploymentConfig
TypeScript (source)	@aws-cdk/aws-codedeploy » ServerDeploymentConfig

Implements IConstruct, IConstruct, IDependable, IResource, IServerDeploymentConfig

A custom Deployment Configuration for an EC2/on-premise Deployment Group.

Example

const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'CodeDeployDeploymentGroup', {
  deploymentConfig: codedeploy.ServerDeploymentConfig.ALL_AT_ONCE,
});

Initializer

new ServerDeploymentConfig(scope: Construct, id: string, props: ServerDeploymentConfigProps)

Parameters

• scope Construct
• id string
• props ServerDeploymentConfigProps

Construct Props

Name	Type	Description
minimumHealthyHosts	MinimumHealthyHosts	Minimum number of healthy hosts.
deploymentConfigName?	string	The physical, human-readable name of the Deployment Configuration.

---

minimumHealthyHosts

Type: MinimumHealthyHosts

Minimum number of healthy hosts.

---

deploymentConfigName?

Type: string (optional, default: a name will be auto-generated)

The physical, human-readable name of the Deployment Configuration.

Properties

Name	Type	Description
deploymentConfigArn	string
deploymentConfigName	string
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
static ALL_AT_ONCE	IServerDeploymentConfig
static HALF_AT_A_TIME	IServerDeploymentConfig
static ONE_AT_A_TIME	IServerDeploymentConfig

---

deploymentConfigArn

Type: string

---

deploymentConfigName

Type: string

---

env

Type: ResourceEnvironment

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.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

static ALL_AT_ONCE

Type: IServerDeploymentConfig

---

static HALF_AT_A_TIME

Type: IServerDeploymentConfig

---

static ONE_AT_A_TIME

Type: IServerDeploymentConfig

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
protected validate()	Validate the current construct.
static fromServerDeploymentConfigName(scope, id, serverDeploymentConfigName)	Import a custom Deployment Configuration for an EC2/on-premise Deployment Group defined either outside the CDK app, or in a different region.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected validate()

protected validate(): string[]

Returns

• string[]

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

---

static fromServerDeploymentConfigName(scope, id, serverDeploymentConfigName)

public static fromServerDeploymentConfigName(scope: Construct, id: string, serverDeploymentConfigName: string): IServerDeploymentConfig

Parameters

• scope Construct — the parent Construct for this new Construct.
• id string — the logical ID of this new Construct.
• serverDeploymentConfigName string — the properties of the referenced custom Deployment Configuration.

Returns

• IServerDeploymentConfig

Import a custom Deployment Configuration for an EC2/on-premise Deployment Group defined either outside the CDK app, or in a different region.