aws-cdk-lib.aws_codedeploy.BaseDeploymentConfig

class BaseDeploymentConfig

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

Implements IConstruct, IDependable, IResource, IBaseDeploymentConfig

Extends Resource

Implemented by EcsDeploymentConfig, LambdaDeploymentConfig, ServerDeploymentConfig

The base class for ServerDeploymentConfig, EcsDeploymentConfig, and LambdaDeploymentConfig deployment configurations.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const baseDeploymentConfig = codedeploy.BaseDeploymentConfig.fromDeploymentConfigName(this, 'MyBaseDeploymentConfig', 'deploymentConfigName');

Initializer

new BaseDeploymentConfig(scope: Construct, id: string, props?: BaseDeploymentConfigProps)

Parameters

  • scope Construct
  • id string
  • props BaseDeploymentConfigProps

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.

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.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
protected static fromDeploymentConfigName(scope, id, deploymentConfigName)Import a custom Deployment Configuration for a Deployment Group defined outside the CDK.

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 static fromDeploymentConfigName(scope, id, deploymentConfigName)

protected static fromDeploymentConfigName(scope: Construct, id: string, deploymentConfigName: string): IBaseDeploymentConfig

Parameters

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

Returns

  • IBaseDeploymentConfig

Import a custom Deployment Configuration for a Deployment Group defined outside the CDK.