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

Class EcsDeploymentProps.Builder

java.lang.Object

io.github.cdklabs.cdk.ecs.codedeploy.EcsDeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsDeploymentProps>

Enclosing interface:

EcsDeploymentProps

@Stability(Experimental)
public static final class EcsDeploymentProps.Builder
extends Object
implements software.amazon.jsii.Builder<EcsDeploymentProps>

A builder for EcsDeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsDeploymentProps.Builder	autoRollback(software.amazon.awscdk.services.codedeploy.AutoRollbackConfig autoRollback)	Sets the value of EcsDeploymentProps.getAutoRollback()
EcsDeploymentProps	build()	Builds the configured instance.
EcsDeploymentProps.Builder	deploymentGroup(software.amazon.awscdk.services.codedeploy.IEcsDeploymentGroup deploymentGroup)	Sets the value of EcsDeploymentProps.getDeploymentGroup()
EcsDeploymentProps.Builder	description(String description)	Sets the value of EcsDeploymentProps.getDescription()
EcsDeploymentProps.Builder	hooks(AppSpecHooks hooks)	Sets the value of EcsDeploymentProps.getHooks()
EcsDeploymentProps.Builder	targetService(TargetService targetService)	Sets the value of EcsDeploymentProps.getTargetService()
EcsDeploymentProps.Builder	timeout(software.amazon.awscdk.Duration timeout)	Sets the value of EcsDeploymentProps.getTimeout()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

deploymentGroup

@Stability(Experimental)
public EcsDeploymentProps.Builder deploymentGroup(software.amazon.awscdk.services.codedeploy.IEcsDeploymentGroup deploymentGroup)

Sets the value of EcsDeploymentProps.getDeploymentGroup()

Parameters:

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

Returns:

this

targetService

@Stability(Experimental)
public EcsDeploymentProps.Builder targetService(TargetService targetService)

Sets the value of EcsDeploymentProps.getTargetService()

Parameters:

targetService - The ECS service to target for the deployment. This parameter is required. see: https://docs.aws.amazon.com/codedeploy/latest/userguide/reference-appspec-file-structure-resources.html#reference-appspec-file-structure-resources-ecs

Returns:

this

autoRollback

@Stability(Experimental)
public EcsDeploymentProps.Builder autoRollback(software.amazon.awscdk.services.codedeploy.AutoRollbackConfig autoRollback)

Sets the value of EcsDeploymentProps.getAutoRollback()

Parameters:

autoRollback - The configuration for rollback in the event that a deployment fails.

Returns:

this

description

@Stability(Experimental)
public EcsDeploymentProps.Builder description(String description)

Sets the value of EcsDeploymentProps.getDescription()

Parameters:

description - The description for the deployment.

Returns:

this

hooks

@Stability(Experimental)
public EcsDeploymentProps.Builder hooks(AppSpecHooks hooks)

Sets the value of EcsDeploymentProps.getHooks()

Parameters:

hooks - Optional lifecycle hooks.

Returns:

this

timeout

@Stability(Experimental)
public EcsDeploymentProps.Builder timeout(software.amazon.awscdk.Duration timeout)

Sets the value of EcsDeploymentProps.getTimeout()

Parameters:

timeout - The timeout for the deployment. If the timeout is reached, it will trigger a rollback of the stack.

Returns:

this

build

@Stability(Experimental)
public EcsDeploymentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<EcsDeploymentProps>

Returns:

a new instance of EcsDeploymentProps

Throws:

NullPointerException - if any required attribute was not provided