@cdklabs/cdk-ecs-codedeploy/lib/ecs-deployment/index.d.ts

CDK Constructs for performing ECS Deployments with CodeDeploy

import * as cdk from 'aws-cdk-lib';
import * as codedeploy from 'aws-cdk-lib/aws-codedeploy';
import { Construct } from 'constructs';
import { AppSpecHooks, TargetService } from '../ecs-appspec';
/**
 * Construction properties of EcsDeployment.
 */
export interface EcsDeploymentProps {
    /**
     * The deployment group to target for this deployment.
     */
    readonly deploymentGroup: codedeploy.IEcsDeploymentGroup;
    /**
     * The ECS service to target for the deployment.
     *
     * see: https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-resources.html#reference-appspec-file-structure-resources-ecs
     */
    readonly targetService: TargetService;
    /**
     * The configuration for rollback in the event that a deployment fails.
     *
     * @default: no automatic rollback triggered
     */
    readonly autoRollback?: codedeploy.AutoRollbackConfig;
    /**
     * The description for the deployment.
     *
     * @default no description
     */
    readonly description?: string;
    /**
     * The timeout for the deployment. If the timeout is reached, it will trigger a rollback of the stack.
     *
     * @default 30 minutes
     */
    readonly timeout?: cdk.Duration;
    /**
     * Optional lifecycle hooks
     *
     * @default - no lifecycle hooks
     */
    readonly hooks?: AppSpecHooks;
}
/**
 * A CodeDeploy Deployment for a Amazon ECS service DeploymentGroup. An EcsDeploymentGroup
 * must only have 1 EcsDeployment. This limit is enforced by removing the scope and id
 * from the constructor. The scope will always be set to the EcsDeploymentGroup
 * and the id will always be set to the string 'Deployment' to force an error if mulitiple
 * EcsDeployment constructs are created for a single EcsDeploymentGroup.
 */
export declare class EcsDeployment extends Construct {
    /**
     * The id of the deployment that was created.
     */
    deploymentId: string;
    constructor(props: EcsDeploymentProps);
}