BaseDeploymentConfig

class aws_cdk.aws_codedeploy.BaseDeploymentConfig(scope, id, *, compute_platform=None, minimum_healthy_hosts=None, traffic_routing=None, zonal_config=None, deployment_config_name=None)

Bases: Resource

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

Resource:

AWS::CodeDeploy::DeploymentConfig

Parameters:

  • scope (Construct) –

  • id (str) –

  • compute_platform (Optional[ComputePlatform]) – The destination compute platform for the deployment. Default: ComputePlatform.Server

  • minimum_healthy_hosts (Optional[MinimumHealthyHosts]) – Minimum number of healthy hosts. Default: None

  • traffic_routing (Optional[TrafficRouting]) – The configuration that specifies how traffic is shifted during a deployment. Only applicable to ECS and Lambda deployments, and must not be specified for Server deployments. Default: None

  • zonal_config (Union[ZonalConfig, Dict[str, Any], None]) – Configure CodeDeploy to deploy your application to one Availability Zone at a time within an AWS Region. Default: - deploy your application to a random selection of hosts across a Region

  • deployment_config_name (Optional[str]) – The physical, human-readable name of the Deployment Configuration. Default: - automatically generated name

Methods

apply_removal_policy(policy)

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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

deployment_config_arn

The arn of the deployment config.

Attribute:

true

deployment_config_name

The name of the deployment config.

Attribute:

true

env

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

The tree node.

stack

The stack in which this resource is defined.

Static Methods

classmethod from_deployment_config_name(scope, id, deployment_config_name)

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

Parameters:

  • scope (Construct) – the parent Construct for this new Construct.

  • id (str) – the logical ID of this new Construct.

  • deployment_config_name (str) – the name of the referenced custom Deployment Configuration.

Return type:

IBaseDeploymentConfig

Returns:

a Construct representing a reference to an existing custom Deployment Configuration

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool