/AWS1/IF_FRM=>CREATESTACK()

About CreateStack

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.

For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.

Method Signature

METHODS /AWS1/IF_FRM~CREATESTACK
  IMPORTING
    !IV_STACKNAME TYPE /AWS1/FRMSTACKNAME OPTIONAL
    !IV_TEMPLATEBODY TYPE /AWS1/FRMTEMPLATEBODY OPTIONAL
    !IV_TEMPLATEURL TYPE /AWS1/FRMTEMPLATEURL OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS OPTIONAL
    !IV_DISABLEROLLBACK TYPE /AWS1/FRMDISABLEROLLBACK OPTIONAL
    !IO_ROLLBACKCONFIGURATION TYPE REF TO /AWS1/CL_FRMROLLBACKCONF OPTIONAL
    !IV_TIMEOUTINMINUTES TYPE /AWS1/FRMTIMEOUTMINUTES OPTIONAL
    !IT_NOTIFICATIONARNS TYPE /AWS1/CL_FRMNOTIFICATIONARNS_W=>TT_NOTIFICATIONARNS OPTIONAL
    !IT_CAPABILITIES TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES OPTIONAL
    !IT_RESOURCETYPES TYPE /AWS1/CL_FRMRESOURCETYPES_W=>TT_RESOURCETYPES OPTIONAL
    !IV_ROLEARN TYPE /AWS1/FRMROLEARN OPTIONAL
    !IV_ONFAILURE TYPE /AWS1/FRMONFAILURE OPTIONAL
    !IV_STACKPOLICYBODY TYPE /AWS1/FRMSTACKPOLICYBODY OPTIONAL
    !IV_STACKPOLICYURL TYPE /AWS1/FRMSTACKPOLICYURL OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FRMTAG=>TT_TAGS OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/FRMCLIENTREQUESTTOKEN OPTIONAL
    !IV_ENBTERMINATIONPROTECTION TYPE /AWS1/FRMENBTERMINATIONPROTE00 OPTIONAL
    !IV_RETAINEXCEPTONCREATE TYPE /AWS1/FRMRETAINEXCEPTONCREATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmcreatestackoutput
  RAISING
    /AWS1/CX_FRMALREADYEXISTSEX
    /AWS1/CX_FRMINSUFFICIENTCAPA00
    /AWS1/CX_FRMLIMITEXCEEDEDEX
    /AWS1/CX_FRMTOKENALRDYEXISTSEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_stackname TYPE /AWS1/FRMSTACKNAME /AWS1/FRMSTACKNAME

The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.

Optional arguments:

iv_templatebody TYPE /AWS1/FRMTEMPLATEBODY /AWS1/FRMTEMPLATEBODY

Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

Conditional: You must specify either TemplateBody or TemplateURL, but not both.

iv_templateurl TYPE /AWS1/FRMTEMPLATEURL /AWS1/FRMTEMPLATEURL

The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

it_parameters TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

iv_disablerollback TYPE /AWS1/FRMDISABLEROLLBACK /AWS1/FRMDISABLEROLLBACK

Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

Default: false

io_rollbackconfiguration TYPE REF TO /AWS1/CL_FRMROLLBACKCONF /AWS1/CL_FRMROLLBACKCONF

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

iv_timeoutinminutes TYPE /AWS1/FRMTIMEOUTMINUTES /AWS1/FRMTIMEOUTMINUTES

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

it_notificationarns TYPE /AWS1/CL_FRMNOTIFICATIONARNS_W=>TT_NOTIFICATIONARNS TT_NOTIFICATIONARNS

The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

it_capabilities TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES TT_CAPABILITIES

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

• CAPABILITY_IAM and CAPABILITY_NAMED_IAM

  Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

  • If you have IAM resources, you can specify either capability.

  • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

  • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

  • AWS::IAM::AccessKey

  • AWS::IAM::Group

  • AWS::IAM::InstanceProfile

  • AWS::IAM::ManagedPolicy

  • AWS::IAM::Policy

  • AWS::IAM::Role

  • AWS::IAM::User

  • AWS::IAM::UserToGroupAddition

  For more information, see Acknowledging IAM resources in CloudFormation templates.

• CAPABILITY_AUTO_EXPAND

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

  If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

  You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

  Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

  For more information, see Perform custom processing on CloudFormation templates with template macros.

Only one of the Capabilities and ResourceType parameters can be specified.

it_resourcetypes TYPE /AWS1/CL_FRMRESOURCETYPES_W=>TT_RESOURCETYPES TT_RESOURCETYPES

Specifies which resource types you can work with, such as AWS::EC2::Instance or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control CloudFormation access with Identity and Access Management.

Only one of the Capabilities and ResourceType parameters can be specified.

iv_rolearn TYPE /AWS1/FRMROLEARN /AWS1/FRMROLEARN

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.

iv_onfailure TYPE /AWS1/FRMONFAILURE /AWS1/FRMONFAILURE

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

Although the default setting is ROLLBACK, there is one exception. This exception occurs when a StackSet attempts to deploy a stack instance and the stack instance fails to create successfully. In this case, the CreateStack call overrides the default setting and sets the value of OnFailure to DELETE.

Default: ROLLBACK

iv_stackpolicybody TYPE /AWS1/FRMSTACKPOLICYBODY /AWS1/FRMSTACKPOLICYBODY

Structure that contains the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

iv_stackpolicyurl TYPE /AWS1/FRMSTACKPOLICYURL /AWS1/FRMSTACKPOLICYURL

Location of a file that contains the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

it_tags TYPE /AWS1/CL_FRMTAG=>TT_TAGS TT_TAGS

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

iv_clientrequesttoken TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that CloudFormation successfully received them.

All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

iv_enbterminationprotection TYPE /AWS1/FRMENBTERMINATIONPROTE00 /AWS1/FRMENBTERMINATIONPROTE00

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect CloudFormation stacks from being deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.

iv_retainexceptoncreate TYPE /AWS1/FRMRETAINEXCEPTONCREATE /AWS1/FRMRETAINEXCEPTONCREATE

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

RETURNING

oo_output TYPE REF TO /aws1/cl_frmcreatestackoutput /AWS1/CL_FRMCREATESTACKOUTPUT

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->createstack(
  io_rollbackconfiguration = new /aws1/cl_frmrollbackconf(
    it_rollbacktriggers = VALUE /aws1/cl_frmrollbacktrigger=>tt_rollbacktriggers(
      (
        new /aws1/cl_frmrollbacktrigger(
          iv_arn = |string|
          iv_type = |string|
        )
      )
    )
    iv_monitoringtimeinminutes = 123
  )
  it_capabilities = VALUE /aws1/cl_frmcapabilities_w=>tt_capabilities(
    ( new /aws1/cl_frmcapabilities_w( |string| ) )
  )
  it_notificationarns = VALUE /aws1/cl_frmnotificationarns_w=>tt_notificationarns(
    ( new /aws1/cl_frmnotificationarns_w( |string| ) )
  )
  it_parameters = VALUE /aws1/cl_frmparameter=>tt_parameters(
    (
      new /aws1/cl_frmparameter(
        iv_parameterkey = |string|
        iv_parametervalue = |string|
        iv_resolvedvalue = |string|
        iv_usepreviousvalue = ABAP_TRUE
      )
    )
  )
  it_resourcetypes = VALUE /aws1/cl_frmresourcetypes_w=>tt_resourcetypes(
    ( new /aws1/cl_frmresourcetypes_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_frmtag=>tt_tags(
    (
      new /aws1/cl_frmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_disablerollback = ABAP_TRUE
  iv_enbterminationprotection = ABAP_TRUE
  iv_onfailure = |string|
  iv_retainexceptoncreate = ABAP_TRUE
  iv_rolearn = |string|
  iv_stackname = |string|
  iv_stackpolicybody = |string|
  iv_stackpolicyurl = |string|
  iv_templatebody = |string|
  iv_templateurl = |string|
  iv_timeoutinminutes = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_stackid = lo_result->get_stackid( ).
ENDIF.