aws-cdk-lib.aws_codedeploy.ServerDeploymentConfig

class ServerDeploymentConfig (construct)

LanguageType name
.NETAmazon.CDK.AWS.CodeDeploy.ServerDeploymentConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#ServerDeploymentConfig
Javasoftware.amazon.awscdk.services.codedeploy.ServerDeploymentConfig
Pythonaws_cdk.aws_codedeploy.ServerDeploymentConfig
TypeScript (source)aws-cdk-lib » aws_codedeploy » ServerDeploymentConfig

Implements IConstruct, IDependable, IResource, IBaseDeploymentConfig, 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

NameTypeDescription
minimumHealthyHostsMinimumHealthyHostsMinimum number of healthy hosts.
deploymentConfigName?stringThe physical, human-readable name of the Deployment Configuration.

minimumHealthyHosts

Type: MinimumHealthyHosts

Minimum number of healthy hosts.


deploymentConfigName?

Type: string (optional, default: automatically generated name)

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

Properties

NameTypeDescription
deploymentConfigArnstringThe arn of the deployment config.
deploymentConfigNamestringThe name of the deployment config.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
static ALL_AT_ONCEIServerDeploymentConfigThe CodeDeployDefault.AllAtOnce predefined deployment configuration for EC2/on-premises compute platform.
static HALF_AT_A_TIMEIServerDeploymentConfigThe CodeDeployDefault.HalfAtATime predefined deployment configuration for EC2/on-premises compute platform.
static ONE_AT_A_TIMEIServerDeploymentConfigThe CodeDeployDefault.OneAtATime predefined deployment configuration for EC2/on-premises compute platform.

deploymentConfigArn

Type: string

The arn of the deployment config.


deploymentConfigName

Type: string

The name of the deployment config.


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: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


static ALL_AT_ONCE

Type: IServerDeploymentConfig

The CodeDeployDefault.AllAtOnce predefined deployment configuration for EC2/on-premises compute platform.

See also: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html#deployment-configuration-server


static HALF_AT_A_TIME

Type: IServerDeploymentConfig

The CodeDeployDefault.HalfAtATime predefined deployment configuration for EC2/on-premises compute platform.

See also: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html#deployment-configuration-server


static ONE_AT_A_TIME

Type: IServerDeploymentConfig

The CodeDeployDefault.OneAtATime predefined deployment configuration for EC2/on-premises compute platform.

See also: https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html#deployment-configuration-server

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this 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.


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.