Package software.amazon.awscdk.services.ecs

Interface CfnService.DeploymentLifecycleHookProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.DeploymentLifecycleHookProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.DeploymentLifecycleHookProperty
extends software.amazon.jsii.JsiiSerializable

A deployment lifecycle hook runs custom logic at specific stages of the deployment process.

Currently, you can use Lambda functions as hook targets.

For more information, see Lifecycle hooks for Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 DeploymentLifecycleHookProperty deploymentLifecycleHookProperty = DeploymentLifecycleHookProperty.builder()
         .hookTargetArn("hookTargetArn")
         .lifecycleStages(List.of("lifecycleStages"))
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.DeploymentLifecycleHookProperty.Builder	builder()
String	getHookTargetArn()	The Amazon Resource Name (ARN) of the hook target.
List<String>	getLifecycleStages()	The lifecycle stages at which to run the hook.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHookTargetArn

@Stability(Stable)
@NotNull
String getHookTargetArn()

The Amazon Resource Name (ARN) of the hook target. Currently, only Lambda function ARNs are supported.

You must provide this parameter when configuring a deployment lifecycle hook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-hooktargetarn

getLifecycleStages

@Stability(Stable)
@NotNull
List<String> getLifecycleStages()

The lifecycle stages at which to run the hook. Choose from these valid values:.

• RECONCILE_SERVICE

The reconciliation stage that only happens when you start a new service deployment with more than 1 service revision in an ACTIVE state.

You can use a lifecycle hook for this stage.

• PRE_SCALE_UP

The green service revision has not started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

You can use a lifecycle hook for this stage.

• POST_SCALE_UP

The green service revision has started. The blue service revision is handling 100% of the production traffic. There is no test traffic.

You can use a lifecycle hook for this stage.

• TEST_TRAFFIC_SHIFT

The blue and green service revisions are running. The blue service revision handles 100% of the production traffic. The green service revision is migrating from 0% to 100% of test traffic.

You can use a lifecycle hook for this stage.

• POST_TEST_TRAFFIC_SHIFT

The test traffic shift is complete. The green service revision handles 100% of the test traffic.

You can use a lifecycle hook for this stage.

• PRODUCTION_TRAFFIC_SHIFT

Production traffic is shifting to the green service revision. The green service revision is migrating from 0% to 100% of production traffic.

You can use a lifecycle hook for this stage.

• POST_PRODUCTION_TRAFFIC_SHIFT

The production traffic shift is complete.

You can use a lifecycle hook for this stage.

You must provide this parameter when configuring a deployment lifecycle hook.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-lifecyclestages

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.

For more information, see Permissions required for Lambda functions in Amazon ECS blue/green deployments in the Amazon Elastic Container Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentlifecyclehook.html#cfn-ecs-service-deploymentlifecyclehook-rolearn

builder

@Stability(Stable)
static CfnService.DeploymentLifecycleHookProperty.Builder builder()

Returns:

a CfnService.DeploymentLifecycleHookProperty.Builder of CfnService.DeploymentLifecycleHookProperty