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

Interface EcsDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcsDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:19.069Z")
@Stability(Experimental)
public interface EcsDeploymentProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties of EcsDeployment.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EcsDeploymentProps.Builder	A builder for EcsDeploymentProps
static class	EcsDeploymentProps.Jsii$Proxy	An implementation for EcsDeploymentProps

Method Summary

Modifier and Type	Method	Description
static EcsDeploymentProps.Builder	builder()
default software.amazon.awscdk.services.codedeploy.AutoRollbackConfig	getAutoRollback()	(experimental) The configuration for rollback in the event that a deployment fails.
software.amazon.awscdk.services.codedeploy.IEcsDeploymentGroup	getDeploymentGroup()	(experimental) The deployment group to target for this deployment.
default String	getDescription()	(experimental) The description for the deployment.
default AppSpecHooks	getHooks()	(experimental) Optional lifecycle hooks.
TargetService	getTargetService()	(experimental) The ECS service to target for the deployment.
default software.amazon.awscdk.Duration	getTimeout()	(experimental) The timeout for the deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeploymentGroup

@Stability(Experimental)
@NotNull
software.amazon.awscdk.services.codedeploy.IEcsDeploymentGroup getDeploymentGroup()

(experimental) The deployment group to target for this deployment.

getTargetService

@Stability(Experimental)
@NotNull
TargetService getTargetService()

(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

getAutoRollback

@Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.codedeploy.AutoRollbackConfig getAutoRollback()

(experimental) The configuration for rollback in the event that a deployment fails.

Default: : no automatic rollback triggered

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) The description for the deployment.

Default: no description

getHooks

@Stability(Experimental)
@Nullable
default AppSpecHooks getHooks()

(experimental) Optional lifecycle hooks.

Default: - no lifecycle hooks

getTimeout

@Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getTimeout()

(experimental) The timeout for the deployment.

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

Default: 30 minutes

builder

@Stability(Experimental)
static EcsDeploymentProps.Builder builder()

Returns:

a EcsDeploymentProps.Builder of EcsDeploymentProps