Package io.github.cdklabs.cdk.ecs.codedeploy

Class EcsDeployment.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<EcsDeployment>
    Enclosing class:
    EcsDeployment
    @Stability(Experimental)
public static final class EcsDeployment.Builder
extends Object
implements software.amazon.jsii.Builder<EcsDeployment>
    (experimental) A fluent builder for EcsDeployment.

    • Method Detail

      • deploymentGroup

        @Stability(Experimental)
public EcsDeployment.Builder deploymentGroup​(software.amazon.awscdk.services.codedeploy.IEcsDeploymentGroup deploymentGroup)
        (experimental) The deployment group to target for this deployment.

        Parameters:
        deploymentGroup - The deployment group to target for this deployment. This parameter is required.
        Returns:
        this

      • targetService

        @Stability(Experimental)
public EcsDeployment.Builder targetService​(TargetService targetService)
        (experimental) 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

        Parameters:
        targetService - The ECS service to target for the deployment. This parameter is required.
        Returns:
        this

      • autoRollback

        @Stability(Experimental)
public EcsDeployment.Builder autoRollback​(software.amazon.awscdk.services.codedeploy.AutoRollbackConfig autoRollback)
        (experimental) The configuration for rollback in the event that a deployment fails.

        Default: : no automatic rollback triggered

        Parameters:
        autoRollback - The configuration for rollback in the event that a deployment fails. This parameter is required.
        Returns:
        this

      • description

        @Stability(Experimental)
public EcsDeployment.Builder description​(String description)
        (experimental) The description for the deployment.

        Default: no description

        Parameters:
        description - The description for the deployment. This parameter is required.
        Returns:
        this

      • hooks

        @Stability(Experimental)
public EcsDeployment.Builder hooks​(AppSpecHooks hooks)
        (experimental) Optional lifecycle hooks.

        Default: - no lifecycle hooks

        Parameters:
        hooks - Optional lifecycle hooks. This parameter is required.
        Returns:
        this

      • timeout

        @Stability(Experimental)
public EcsDeployment.Builder timeout​(software.amazon.awscdk.Duration timeout)
        (experimental) The timeout for the deployment.

        If the timeout is reached, it will trigger a rollback of the stack.

        Default: 30 minutes

        Parameters:
        timeout - The timeout for the deployment. This parameter is required.
        Returns:
        this