Skip to content

/AWS1/CL_FRMCHANGESETHOOK

Specifies the resource, the Hook, and the Hook version to be invoked.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_invocationpoint TYPE /AWS1/FRMHOOKINVOCATIONPOINT /AWS1/FRMHOOKINVOCATIONPOINT

The specific point in the provisioning process where the Hook is invoked.

iv_failuremode TYPE /AWS1/FRMHOOKFAILUREMODE /AWS1/FRMHOOKFAILUREMODE

Specify the Hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

iv_typename TYPE /AWS1/FRMHOOKTYPENAME /AWS1/FRMHOOKTYPENAME

The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your Hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

iv_typeversionid TYPE /AWS1/FRMHOOKTYPEVERSIONID /AWS1/FRMHOOKTYPEVERSIONID

The version ID of the type specified.

iv_typeconfversionid TYPE /AWS1/FRMHOOKTYPECONFVERSIONID /AWS1/FRMHOOKTYPECONFVERSIONID

The version ID of the type configuration.

io_targetdetails TYPE REF TO /AWS1/CL_FRMCHANGESETHOOKTGT00 /AWS1/CL_FRMCHANGESETHOOKTGT00

Specifies details about the target that the Hook will run against.

Queryable Attributes

InvocationPoint

The specific point in the provisioning process where the Hook is invoked.

Accessible with the following methods

Method Description
GET_INVOCATIONPOINT() Getter for INVOCATIONPOINT, with configurable default
ASK_INVOCATIONPOINT() Getter for INVOCATIONPOINT w/ exceptions if field has no val
HAS_INVOCATIONPOINT() Determine if INVOCATIONPOINT has a value

FailureMode

Specify the Hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.

Accessible with the following methods

Method Description
GET_FAILUREMODE() Getter for FAILUREMODE, with configurable default
ASK_FAILUREMODE() Getter for FAILUREMODE w/ exceptions if field has no value
HAS_FAILUREMODE() Determine if FAILUREMODE has a value

TypeName

The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your Hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

Accessible with the following methods

Method Description
GET_TYPENAME() Getter for TYPENAME, with configurable default
ASK_TYPENAME() Getter for TYPENAME w/ exceptions if field has no value
HAS_TYPENAME() Determine if TYPENAME has a value

TypeVersionId

The version ID of the type specified.

Accessible with the following methods

Method Description
GET_TYPEVERSIONID() Getter for TYPEVERSIONID, with configurable default
ASK_TYPEVERSIONID() Getter for TYPEVERSIONID w/ exceptions if field has no value
HAS_TYPEVERSIONID() Determine if TYPEVERSIONID has a value

TypeConfigurationVersionId

The version ID of the type configuration.

Accessible with the following methods

Method Description
GET_TYPECONFVERSIONID() Getter for TYPECONFIGURATIONVERSIONID, with configurable def
ASK_TYPECONFVERSIONID() Getter for TYPECONFIGURATIONVERSIONID w/ exceptions if field
HAS_TYPECONFVERSIONID() Determine if TYPECONFIGURATIONVERSIONID has a value

TargetDetails

Specifies details about the target that the Hook will run against.

Accessible with the following methods

Method Description
GET_TARGETDETAILS() Getter for TARGETDETAILS

Public Local Types In This Class

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

TT_CHANGESETHOOKS

TYPES TT_CHANGESETHOOKS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FRMCHANGESETHOOK WITH DEFAULT KEY
.