Package software.amazon.awscdk.cfnpropertymixins.services.ecs

Class CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServicePropsMixin.DeploymentLifecycleHookProperty>

Enclosing interface:

CfnServicePropsMixin.DeploymentLifecycleHookProperty

@Stability(Stable)
public static final class CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServicePropsMixin.DeploymentLifecycleHookProperty>

A builder for CfnServicePropsMixin.DeploymentLifecycleHookProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnServicePropsMixin.DeploymentLifecycleHookProperty	build()	Builds the configured instance.
CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder	hookDetails(Object hookDetails)	Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getHookDetails()
CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder	hookTargetArn(String hookTargetArn)	Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getHookTargetArn()
CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder	lifecycleStages(List<String> lifecycleStages)	Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getLifecycleStages()
CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder	roleArn(String roleArn)	Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getRoleArn()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

hookDetails

@Stability(Stable)
public CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder hookDetails(Object hookDetails)

Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getHookDetails()

Parameters:

hookDetails - Use this field to specify custom parameters that Amazon ECS passes to your hook target invocations (such as a Lambda function). This field must be a JSON object as a string.

Returns:

this

hookTargetArn

@Stability(Stable)
public CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder hookTargetArn(String hookTargetArn)

Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getHookTargetArn()

Parameters:

hookTargetArn - 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.

Returns:

this

lifecycleStages

@Stability(Stable)
public CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder lifecycleStages(List<String> lifecycleStages)

Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getLifecycleStages()

Parameters:

lifecycleStages - 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.

Returns:

this

roleArn

@Stability(Stable)
public CfnServicePropsMixin.DeploymentLifecycleHookProperty.Builder roleArn(String roleArn)

Sets the value of CfnServicePropsMixin.DeploymentLifecycleHookProperty.getRoleArn()

Parameters:

roleArn - 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 .

Returns:

this

build

@Stability(Stable)
public CfnServicePropsMixin.DeploymentLifecycleHookProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnServicePropsMixin.DeploymentLifecycleHookProperty>

Returns:

a new instance of CfnServicePropsMixin.DeploymentLifecycleHookProperty

Throws:

NullPointerException - if any required attribute was not provided