/AWS1/IF_FRM=>SETTYPECONFIGURATION()

About SetTypeConfiguration

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.

For more information about setting the configuration data for resource types, see Defining the account-level configuration of an extension in the CloudFormation Command Line Interface (CLI) User Guide. For more information about setting the configuration data for Hooks, see the CloudFormation Hooks User Guide.

Method Signature

METHODS /AWS1/IF_FRM~SETTYPECONFIGURATION
  IMPORTING
    !IV_TYPEARN TYPE /AWS1/FRMTYPEARN OPTIONAL
    !IV_CONFIGURATION TYPE /AWS1/FRMTYPECONFIGURATION OPTIONAL
    !IV_CONFIGURATIONALIAS TYPE /AWS1/FRMTYPECONFALIAS OPTIONAL
    !IV_TYPENAME TYPE /AWS1/FRMTYPENAME OPTIONAL
    !IV_TYPE TYPE /AWS1/FRMTHIRDPARTYTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmsettypeconfoutput
  RAISING
    /AWS1/CX_FRMCFNREGISTRYEX
    /AWS1/CX_FRMTYPENOTFOUNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_configuration TYPE /AWS1/FRMTYPECONFIGURATION /AWS1/FRMTYPECONFIGURATION

The configuration data for the extension in this account and Region.

The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

Optional arguments:

iv_typearn TYPE /AWS1/FRMTYPEARN /AWS1/FRMTYPEARN

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

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

iv_configurationalias TYPE /AWS1/FRMTYPECONFALIAS /AWS1/FRMTYPECONFALIAS

An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

iv_typename TYPE /AWS1/FRMTYPENAME /AWS1/FRMTYPENAME

The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

iv_type TYPE /AWS1/FRMTHIRDPARTYTYPE /AWS1/FRMTHIRDPARTYTYPE

The type of extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmsettypeconfoutput /AWS1/CL_FRMSETTYPECONFOUTPUT

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->settypeconfiguration(
  iv_configuration = |string|
  iv_configurationalias = |string|
  iv_type = |string|
  iv_typearn = |string|
  iv_typename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_typeconfigurationarn = lo_result->get_configurationarn( ).
ENDIF.