Skip to content

/AWS1/IF_SAR=>CRECLOUDFORMATIONCHANGESET()

About CreateCloudFormationChangeSet

Creates an AWS CloudFormation change set for the given application.

Method Signature

METHODS /AWS1/IF_SAR~CRECLOUDFORMATIONCHANGESET
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/SAR__STRING OPTIONAL
    !IT_CAPABILITIES TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING OPTIONAL
    !IV_CHANGESETNAME TYPE /AWS1/SAR__STRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/SAR__STRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SAR__STRING OPTIONAL
    !IT_NOTIFICATIONARNS TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING OPTIONAL
    !IT_PARAMETEROVERRIDES TYPE /AWS1/CL_SARPARAMETERVALUE=>TT___LISTOFPARAMETERVALUE OPTIONAL
    !IT_RESOURCETYPES TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING OPTIONAL
    !IO_ROLLBACKCONFIGURATION TYPE REF TO /AWS1/CL_SARROLLBACKCONF OPTIONAL
    !IV_SEMANTICVERSION TYPE /AWS1/SAR__STRING OPTIONAL
    !IV_STACKNAME TYPE /AWS1/SAR__STRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SARTAG=>TT___LISTOFTAG OPTIONAL
    !IV_TEMPLATEID TYPE /AWS1/SAR__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sarcrecloudfmtionch01
  RAISING
    /AWS1/CX_SARBADREQUESTEX
    /AWS1/CX_SARFORBIDDENEXCEPTION
    /AWS1/CX_SARINTERNALSERVERER00
    /AWS1/CX_SARTOOMANYREQUESTSEX
    /AWS1/CX_SARCLIENTEXC
    /AWS1/CX_SARSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

The Amazon Resource Name (ARN) of the application.

iv_stackname TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

Optional arguments:

it_capabilities TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

iv_changesetname TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

iv_clienttoken TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

iv_description TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

it_notificationarns TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

it_parameteroverrides TYPE /AWS1/CL_SARPARAMETERVALUE=>TT___LISTOFPARAMETERVALUE TT___LISTOFPARAMETERVALUE

A list of parameter values for the parameters of the application.

it_resourcetypes TYPE /AWS1/CL_SAR__LISTOF__STRING_W=>TT___LISTOF__STRING TT___LISTOF__STRING

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

io_rollbackconfiguration TYPE REF TO /AWS1/CL_SARROLLBACKCONF /AWS1/CL_SARROLLBACKCONF

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

iv_semanticversion TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

The semantic version of the application:

https://semver.org/

it_tags TYPE /AWS1/CL_SARTAG=>TT___LISTOFTAG TT___LISTOFTAG

This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet API.

iv_templateid TYPE /AWS1/SAR__STRING /AWS1/SAR__STRING

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

RETURNING

oo_output TYPE REF TO /aws1/cl_sarcrecloudfmtionch01 /AWS1/CL_SARCRECLOUDFMTIONCH01

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->crecloudformationchangeset(
  io_rollbackconfiguration = new /aws1/cl_sarrollbackconf(
    it_rollbacktriggers = VALUE /aws1/cl_sarrollbacktrigger=>tt___listofrollbacktrigger(
      (
        new /aws1/cl_sarrollbacktrigger(
          iv_arn = |string|
          iv_type = |string|
        )
      )
    )
    iv_monitoringtimeinminutes = 123
  )
  it_capabilities = VALUE /aws1/cl_sar__listof__string_w=>tt___listof__string(
    ( new /aws1/cl_sar__listof__string_w( |string| ) )
  )
  it_notificationarns = VALUE /aws1/cl_sar__listof__string_w=>tt___listof__string(
    ( new /aws1/cl_sar__listof__string_w( |string| ) )
  )
  it_parameteroverrides = VALUE /aws1/cl_sarparametervalue=>tt___listofparametervalue(
    (
      new /aws1/cl_sarparametervalue(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  it_resourcetypes = VALUE /aws1/cl_sar__listof__string_w=>tt___listof__string(
    ( new /aws1/cl_sar__listof__string_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_sartag=>tt___listoftag(
    (
      new /aws1/cl_sartag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_applicationid = |string|
  iv_changesetname = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_semanticversion = |string|
  iv_stackname = |string|
  iv_templateid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv___string = lo_result->get_applicationid( ).
  lv___string = lo_result->get_changesetid( ).
  lv___string = lo_result->get_semanticversion( ).
  lv___string = lo_result->get_stackid( ).
ENDIF.