class CustomLambdaDeploymentConfig (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeDeploy.CustomLambdaDeploymentConfig |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#CustomLambdaDeploymentConfig |
![]() | software.amazon.awscdk.services.codedeploy.CustomLambdaDeploymentConfig |
![]() | aws_cdk.aws_codedeploy.CustomLambdaDeploymentConfig |
![]() | aws-cdk-lib » aws_codedeploy » CustomLambdaDeploymentConfig |
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Implements
IConstruct
, IDependable
, IResource
, ILambda
, IBase
A custom Deployment Configuration for a Lambda Deployment Group.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const customLambdaDeploymentConfig = new codedeploy.CustomLambdaDeploymentConfig(this, 'MyCustomLambdaDeploymentConfig', {
interval: cdk.Duration.minutes(30),
percentage: 123,
type: codedeploy.CustomLambdaDeploymentConfigType.CANARY,
// the properties below are optional
deploymentConfigName: 'deploymentConfigName',
});
Initializer
new CustomLambdaDeploymentConfig(scope: Construct, id: string, props: CustomLambdaDeploymentConfigProps)
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Parameters
- scope
Construct
- id
string
- props
Custom
Lambda Deployment Config Props
Construct Props
Name | Type | Description |
---|---|---|
interval | Duration | The interval, in number of minutes: - For LINEAR, how frequently additional traffic is shifted - For CANARY, how long to shift traffic before the full deployment. |
percentage | number | The integer percentage of traffic to shift: - For LINEAR, the percentage to shift every interval - For CANARY, the percentage to shift until the interval passes, before the full deployment. |
type | Custom | The type of deployment config, either CANARY or LINEAR. |
deployment | string | The verbatim name of the deployment config. |
interval
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
Duration
The interval, in number of minutes: - For LINEAR, how frequently additional traffic is shifted - For CANARY, how long to shift traffic before the full deployment.
percentage
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
number
The integer percentage of traffic to shift: - For LINEAR, the percentage to shift every interval - For CANARY, the percentage to shift until the interval passes, before the full deployment.
type
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
Custom
The type of deployment config, either CANARY or LINEAR.
deploymentConfigName?
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
string
(optional, default: automatically generated name)
The verbatim name of the deployment config.
Must be unique per account/region. Other parameters cannot be updated if this name is provided.
Properties
Name | Type | Description |
---|---|---|
deployment | string | The arn of the deployment config. |
deployment | string | The name of the deployment config. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
deploymentConfigArn
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
string
The arn of the deployment config.
deploymentConfigName
⚠️ Deprecated: Use LambdaDeploymentConfig
Type:
string
The name of the deployment config.
env
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Type:
Resource
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
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Type:
Node
The tree node.
stack
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Parameters
- policy
Removal
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
).
toString()
public toString(): string
⚠️ Deprecated: CloudFormation now supports Lambda deployment configurations without custom resources. Use LambdaDeploymentConfig
.
Returns
string
Returns a string representation of this construct.