java.lang.Object
- software.amazon.awssdk.services.ecs.model.DeploymentLifecycleHook

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>
```
@Generated("software.amazon.awssdk:codegen")
public final class DeploymentLifecycleHook
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DeploymentLifecycleHook.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DeploymentLifecycleHook.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLifecycleStages()`	For responses, this returns true if the service returned a value for the LifecycleStages property.
`Document`	`hookDetails()`	Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
`String`	`hookTargetArn()`	The Amazon Resource Name (ARN) of the hook target.
`List<DeploymentLifecycleHookStage>`	`lifecycleStages()`	The lifecycle stages at which to run the hook.
`List<String>`	`lifecycleStagesAsStrings()`	The lifecycle stages at which to run the hook.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon ECS permission to call Lambda functions on your behalf.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeploymentLifecycleHook.Builder>`	`serializableBuilderClass()`
`DeploymentLifecycleHook.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hookTargetArn
```
public final String 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:
    
    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.
  - roleArn
```
public final String 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:
    
    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.
  - lifecycleStages
```
public final List<DeploymentLifecycleHookStage> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLifecycleStages() method.
    Returns:
    
    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.
  - hasLifecycleStages
```
public final boolean hasLifecycleStages()
```
    For responses, this returns true if the service returned a value for the LifecycleStages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - lifecycleStagesAsStrings
```
public final List<String> lifecycleStagesAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLifecycleStages() method.
    Returns:
    
    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.
  - hookDetails
```
public final Document hookDetails()
```
    Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
    
    Returns:
    
    Use this field to specify custom parameters that Amazon ECS will pass to your hook target invocations (such as a Lambda function).
  - toBuilder
```
public DeploymentLifecycleHook.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeploymentLifecycleHook.Builder,DeploymentLifecycleHook>
  - builder
```
public static DeploymentLifecycleHook.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentLifecycleHook.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DeploymentLifecycleHook

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hookTargetArn

roleArn

lifecycleStages

hasLifecycleStages

lifecycleStagesAsStrings

hookDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField