Skip to content

/AWS1/IF_FRM=>CREATESTACKSET()

About CreateStackSet

Creates a StackSet.

Method Signature

METHODS /AWS1/IF_FRM~CREATESTACKSET
  IMPORTING
    !IV_STACKSETNAME TYPE /AWS1/FRMSTACKSETNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/FRMDESCRIPTION OPTIONAL
    !IV_TEMPLATEBODY TYPE /AWS1/FRMTEMPLATEBODY OPTIONAL
    !IV_TEMPLATEURL TYPE /AWS1/FRMTEMPLATEURL OPTIONAL
    !IV_STACKID TYPE /AWS1/FRMSTACKID OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS OPTIONAL
    !IT_CAPABILITIES TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FRMTAG=>TT_TAGS OPTIONAL
    !IV_ADMINISTRATIONROLEARN TYPE /AWS1/FRMROLEARN OPTIONAL
    !IV_EXECUTIONROLENAME TYPE /AWS1/FRMEXECUTIONROLENAME OPTIONAL
    !IV_PERMISSIONMODEL TYPE /AWS1/FRMPERMISSIONMODELS OPTIONAL
    !IO_AUTODEPLOYMENT TYPE REF TO /AWS1/CL_FRMAUTODEPLOYMENT OPTIONAL
    !IV_CALLAS TYPE /AWS1/FRMCALLAS OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/FRMCLIENTREQUESTTOKEN OPTIONAL
    !IO_MANAGEDEXECUTION TYPE REF TO /AWS1/CL_FRMMANAGEDEXECUTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmcreatestacksetout
  RAISING
    /AWS1/CX_FRMCREATEDBUTMODDEDEX
    /AWS1/CX_FRMLIMITEXCEEDEDEX
    /AWS1/CX_FRMNAMEALRDYEXISTSEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAME /AWS1/FRMSTACKSETNAME

The name to associate with the StackSet. The name must be unique in the Region where you create your StackSet.

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

Optional arguments:

iv_description TYPE /AWS1/FRMDESCRIPTION /AWS1/FRMDESCRIPTION

A description of the StackSet. You can use the description to identify the StackSet's purpose or other important information.

iv_templatebody TYPE /AWS1/FRMTEMPLATEBODY /AWS1/FRMTEMPLATEBODY

The 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 the TemplateBody or the TemplateURL parameter, 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 (maximum 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://. S3 static website URLs are not supported.

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

iv_stackid TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID

The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN) of the stack.

it_parameters TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS

The input parameters for the StackSet template.

it_capabilities TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES TT_CAPABILITIES

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

  • 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 StackSets, 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.

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

  • CAPABILITY_AUTO_EXPAND

    Some templates reference macros. If your StackSet template references one or more macros, you must create the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To create the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros.

    StackSets with service-managed permissions don't currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.

it_tags TYPE /AWS1/CL_FRMTAG=>TT_TAGS TT_TAGS

The key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the StackSet is not created.

iv_administrationrolearn TYPE /AWS1/FRMROLEARN /AWS1/FRMROLEARN

The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

Valid only if the permissions model is SELF_MANAGED.

iv_executionrolename TYPE /AWS1/FRMEXECUTIONROLENAME /AWS1/FRMEXECUTIONROLENAME

The name of the IAM execution role to use to create the StackSet. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.

Valid only if the permissions model is SELF_MANAGED.

iv_permissionmodel TYPE /AWS1/FRMPERMISSIONMODELS /AWS1/FRMPERMISSIONMODELS

Describes how the IAM roles required for StackSet operations are created. By default, SELF-MANAGED is specified.

io_autodeployment TYPE REF TO /AWS1/CL_FRMAUTODEPLOYMENT /AWS1/CL_FRMAUTODEPLOYMENT

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

Required if the permissions model is SERVICE_MANAGED. (Not used with self-managed permissions.)

iv_callas TYPE /AWS1/FRMCALLAS /AWS1/FRMCALLAS

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • To create a StackSet with service-managed permissions while signed in to the management account, specify SELF.

  • To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.

Valid only if the permissions model is SERVICE_MANAGED.

iv_clientrequesttoken TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

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

If you don't specify an operation ID, the SDK generates one automatically.

io_managedexecution TYPE REF TO /AWS1/CL_FRMMANAGEDEXECUTION /AWS1/CL_FRMMANAGEDEXECUTION

Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.

RETURNING

oo_output TYPE REF TO /aws1/cl_frmcreatestacksetout /AWS1/CL_FRMCREATESTACKSETOUT

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->createstackset(
  io_autodeployment = new /aws1/cl_frmautodeployment(
    iv_enabled = ABAP_TRUE
    iv_retainstacksonacctremoval = ABAP_TRUE
  )
  io_managedexecution = new /aws1/cl_frmmanagedexecution( ABAP_TRUE )
  it_capabilities = VALUE /aws1/cl_frmcapabilities_w=>tt_capabilities(
    ( new /aws1/cl_frmcapabilities_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_tags = VALUE /aws1/cl_frmtag=>tt_tags(
    (
      new /aws1/cl_frmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_administrationrolearn = |string|
  iv_callas = |string|
  iv_clientrequesttoken = |string|
  iv_description = |string|
  iv_executionrolename = |string|
  iv_permissionmodel = |string|
  iv_stackid = |string|
  iv_stacksetname = |string|
  iv_templatebody = |string|
  iv_templateurl = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_stacksetid = lo_result->get_stacksetid( ).
ENDIF.