/AWS1/IF_FRM=>CREATEGENERATEDTEMPLATE()

About CreateGeneratedTemplate

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.

Method Signature

METHODS /AWS1/IF_FRM~CREATEGENERATEDTEMPLATE
  IMPORTING
    !IT_RESOURCES TYPE /AWS1/CL_FRMRESOURCEDEFINITION=>TT_RESOURCEDEFINITIONS OPTIONAL
    !IV_GENERATEDTEMPLATENAME TYPE /AWS1/FRMGENERATEDTEMPLATENAME OPTIONAL
    !IV_STACKNAME TYPE /AWS1/FRMSTACKNAME OPTIONAL
    !IO_TEMPLATECONFIGURATION TYPE REF TO /AWS1/CL_FRMTEMPLATECONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmcregeneratedtmpl01
  RAISING
    /AWS1/CX_FRMALREADYEXISTSEX
    /AWS1/CX_FRMCONCURRENTRESRCS00
    /AWS1/CX_FRMLIMITEXCEEDEDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_generatedtemplatename TYPE /AWS1/FRMGENERATEDTEMPLATENAME /AWS1/FRMGENERATEDTEMPLATENAME

The name assigned to the generated template.

Optional arguments:

it_resources TYPE /AWS1/CL_FRMRESOURCEDEFINITION=>TT_RESOURCEDEFINITIONS TT_RESOURCEDEFINITIONS

An optional list of resources to be included in the generated template.

If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.

iv_stackname TYPE /AWS1/FRMSTACKNAME /AWS1/FRMSTACKNAME

An optional name or ARN of a stack to use as the base stack for the generated template.

io_templateconfiguration TYPE REF TO /AWS1/CL_FRMTEMPLATECONF /AWS1/CL_FRMTEMPLATECONF

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmcregeneratedtmpl01 /AWS1/CL_FRMCREGENERATEDTMPL01

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->creategeneratedtemplate(
  io_templateconfiguration = new /aws1/cl_frmtemplateconf(
    iv_deletionpolicy = |string|
    iv_updatereplacepolicy = |string|
  )
  it_resources = VALUE /aws1/cl_frmresourcedefinition=>tt_resourcedefinitions(
    (
      new /aws1/cl_frmresourcedefinition(
        it_resourceidentifier = VALUE /aws1/cl_frmresourceidprps_w=>tt_resourceidproperties(
          (
            VALUE /aws1/cl_frmresourceidprps_w=>ts_resourceidproperties_maprow(
              key = |string|
              value = new /aws1/cl_frmresourceidprps_w( |string| )
            )
          )
        )
        iv_logicalresourceid = |string|
        iv_resourcetype = |string|
      )
    )
  )
  iv_generatedtemplatename = |string|
  iv_stackname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_generatedtemplateid = lo_result->get_generatedtemplateid( ).
ENDIF.

To create a generated template

This example creates a generated template with a resources file.

DATA(lo_result) = lo_client->creategeneratedtemplate(
  it_resources = VALUE /aws1/cl_frmresourcedefinition=>tt_resourcedefinitions(
    (
      new /aws1/cl_frmresourcedefinition(
        it_resourceidentifier = VALUE /aws1/cl_frmresourceidprps_w=>tt_resourceidproperties(
          (
            VALUE /aws1/cl_frmresourceidprps_w=>ts_resourceidproperties_maprow(
              key = |BucketName|
              value = new /aws1/cl_frmresourceidprps_w( |jazz-bucket| )
            )
          )
        )
        iv_resourcetype = |AWS::S3::Bucket|
      )
    )
    (
      new /aws1/cl_frmresourcedefinition(
        it_resourceidentifier = VALUE /aws1/cl_frmresourceidprps_w=>tt_resourceidproperties(
          (
            VALUE /aws1/cl_frmresourceidprps_w=>ts_resourceidproperties_maprow(
              key = |DhcpOptionsId|
              value = new /aws1/cl_frmresourceidprps_w( |random-id123| )
            )
          )
        )
        iv_resourcetype = |AWS::EC2::DHCPOptions|
      )
    )
  )
  iv_generatedtemplatename = |JazzyTemplate|
).