/AWS1/CL_ECSDEPLOYLCHOOKDETAIL

The details of a deployment lifecycle hook that is active during a service deployment.

You can view lifecycle hook details by calling DescribeServiceDeployments.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_hookid TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment.

iv_targettype TYPE /AWS1/ECSDEPLOYLCHOOKTGTTYPE /AWS1/ECSDEPLOYLCHOOKTGTTYPE

The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.

iv_targetarn TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set.

iv_status TYPE /AWS1/ECSDEPLOYLCHOOKSTATUS /AWS1/ECSDEPLOYLCHOOKSTATUS

The status of the lifecycle hook. Valid values depend on the hook type:

• For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

• For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

iv_expiresat TYPE /AWS1/ECSTIMESTAMP /AWS1/ECSTIMESTAMP

The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.

iv_timeoutaction TYPE /AWS1/ECSDEPLOYLCHOOKACTION /AWS1/ECSDEPLOYLCHOOKACTION

The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.

---

Queryable Attributes

hookId

The ID of the lifecycle hook. Use this value when calling ContinueServiceDeployment to continue or roll back a paused deployment.

Accessible with the following methods

Method	Description
GET_HOOKID()	Getter for HOOKID, with configurable default
ASK_HOOKID()	Getter for HOOKID w/ exceptions if field has no value
HAS_HOOKID()	Determine if HOOKID has a value

targetType

The type of action the lifecycle hook performs, such as AWS_LAMBDA or PAUSE.

Accessible with the following methods

Method	Description
GET_TARGETTYPE()	Getter for TARGETTYPE, with configurable default
ASK_TARGETTYPE()	Getter for TARGETTYPE w/ exceptions if field has no value
HAS_TARGETTYPE()	Determine if TARGETTYPE has a value

targetArn

The Amazon Resource Name (ARN) of the hook target. For AWS_LAMBDA hooks, this is the Lambda function ARN. For PAUSE hooks, this field is not set.

Accessible with the following methods

Method	Description
GET_TARGETARN()	Getter for TARGETARN, with configurable default
ASK_TARGETARN()	Getter for TARGETARN w/ exceptions if field has no value
HAS_TARGETARN()	Determine if TARGETARN has a value

status

The status of the lifecycle hook. Valid values depend on the hook type:

• For AWS_LAMBDA hooks: IN_PROGRESS, SUCCEEDED, FAILED, and TIMED_OUT.

• For PAUSE hooks: AWAITING_ACTION, SUCCEEDED, FAILED, and TIMED_OUT.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

expiresAt

The time when the lifecycle hook times out. If the hook has not been completed by this time, Amazon ECS takes the timeout action.

Accessible with the following methods

Method	Description
GET_EXPIRESAT()	Getter for EXPIRESAT, with configurable default
ASK_EXPIRESAT()	Getter for EXPIRESAT w/ exceptions if field has no value
HAS_EXPIRESAT()	Determine if EXPIRESAT has a value

timeoutAction

The action Amazon ECS takes when the lifecycle hook times out. Valid values are CONTINUE and ROLLBACK.

Accessible with the following methods

Method	Description
GET_TIMEOUTACTION()	Getter for TIMEOUTACTION, with configurable default
ASK_TIMEOUTACTION()	Getter for TIMEOUTACTION w/ exceptions if field has no value
HAS_TIMEOUTACTION()	Determine if TIMEOUTACTION has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_DEPLOYLCHOOKDETAILLIST

TYPES TT_DEPLOYLCHOOKDETAILLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSDEPLOYLCHOOKDETAIL WITH DEFAULT KEY
.