Skip to content

/AWS1/IF_FRM=>DEACTIVATETYPE()

About DeactivateType

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.

Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use SetTypeConfiguration.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

To see which extensions are currently activated, use ListTypes.

Method Signature

METHODS /AWS1/IF_FRM~DEACTIVATETYPE
  IMPORTING
    !IV_TYPENAME TYPE /AWS1/FRMTYPENAME OPTIONAL
    !IV_TYPE TYPE /AWS1/FRMTHIRDPARTYTYPE OPTIONAL
    !IV_ARN TYPE /AWS1/FRMPRIVATETYPEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmdeactivatetypeout
  RAISING
    /AWS1/CX_FRMCFNREGISTRYEX
    /AWS1/CX_FRMTYPENOTFOUNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_typename TYPE /AWS1/FRMTYPENAME /AWS1/FRMTYPENAME

The type name of the extension in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.

Conditional: You must specify either Arn, or TypeName and Type.

iv_type TYPE /AWS1/FRMTHIRDPARTYTYPE /AWS1/FRMTHIRDPARTYTYPE

The extension type.

Conditional: You must specify either Arn, or TypeName and Type.

iv_arn TYPE /AWS1/FRMPRIVATETYPEARN /AWS1/FRMPRIVATETYPEARN

The Amazon Resource Name (ARN) for the extension in this account and Region.

Conditional: You must specify either Arn, or TypeName and Type.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmdeactivatetypeout /AWS1/CL_FRMDEACTIVATETYPEOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->deactivatetype(
  iv_arn = |string|
  iv_type = |string|
  iv_typename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.