amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.CreateStackSet

Description

Creates a stack set.

Synopsis

Creating a Request

data CreateStackSet Source #

See: newCreateStackSet smart constructor.

Constructors

CreateStackSet' 

Fields

  • administrationRoleARN :: Maybe Text

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

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

  • autoDeployment :: Maybe AutoDeployment

    Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

  • callAs :: Maybe CallAs
    Service-managed permissions
    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 stack sets with self-managed permissions.

    • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.
    • To create a stack set 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.

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

  • capabilities :: Maybe [Capability]

    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set 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 Identity and Access Management (IAM) users. For those stack sets, 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 stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

      Stack sets 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 stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

  • clientRequestToken :: Maybe Text

    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 stack set 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.

  • description :: Maybe Text

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

  • executionRoleName :: Maybe Text

    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set 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 stack sets.

  • managedExecution :: Maybe ManagedExecution

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

  • parameters :: Maybe [Parameter]

    The input parameters for the stack set template.

  • permissionModel :: Maybe PermissionModels

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

  • stackId :: Maybe Text

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

  • tags :: Maybe [Tag]

    The key-value pairs to associate with this stack set 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 stack set is not created.

  • templateBody :: Maybe Text

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

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

  • templateURL :: Maybe Text

    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

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

  • stackSetName :: Text

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

    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.

Instances

Instances details
ToHeaders CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

ToPath CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

ToQuery CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

AWSRequest CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Associated Types

type AWSResponse CreateStackSet #

Generic CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Associated Types

type Rep CreateStackSet :: Type -> Type #

Read CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Show CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

NFData CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Methods

rnf :: CreateStackSet -> () #

Eq CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Hashable CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

type AWSResponse CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

type Rep CreateStackSet Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

type Rep CreateStackSet = D1 ('MetaData "CreateStackSet" "Amazonka.CloudFormation.CreateStackSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CreateStackSet'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "administrationRoleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "autoDeployment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoDeployment)) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)))) :*: ((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "managedExecution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedExecution)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter]))) :*: (S1 ('MetaSel ('Just "permissionModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionModels)) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateStackSet Source #

Create a value of CreateStackSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStackSet, createStackSet_administrationRoleARN - The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

CreateStackSet, createStackSet_autoDeployment - Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

$sel:callAs:CreateStackSet', createStackSet_callAs - [Service-managed permissions] 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 stack sets with self-managed permissions.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.
  • To create a stack set 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.

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

CreateStackSet, createStackSet_capabilities - In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set 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 Identity and Access Management (IAM) users. For those stack sets, 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 stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets 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 stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

CreateStackSet, createStackSet_clientRequestToken - 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 stack set 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.

CreateStackSet, createStackSet_description - A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

CreateStackSet, createStackSet_executionRoleName - The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set 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 stack sets.

CreateStackSet, createStackSet_managedExecution - Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

CreateStackSet, createStackSet_parameters - The input parameters for the stack set template.

CreateStackSet, createStackSet_permissionModel - Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

CreateStackSet, createStackSet_stackId - The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

CreateStackSet, createStackSet_tags - The key-value pairs to associate with this stack set 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 stack set is not created.

CreateStackSet, createStackSet_templateBody - The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

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

$sel:templateURL:CreateStackSet', createStackSet_templateURL - The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

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

CreateStackSet, createStackSet_stackSetName - The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

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.

Request Lenses

createStackSet_administrationRoleARN :: Lens' CreateStackSet (Maybe Text) Source #

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

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

createStackSet_autoDeployment :: Lens' CreateStackSet (Maybe AutoDeployment) Source #

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

createStackSet_callAs :: Lens' CreateStackSet (Maybe CallAs) Source #

Service-managed permissions
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 stack sets with self-managed permissions.

  • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.
  • To create a stack set 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.

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

createStackSet_capabilities :: Lens' CreateStackSet (Maybe [Capability]) Source #

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set 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 Identity and Access Management (IAM) users. For those stack sets, 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 stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets 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 stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

createStackSet_clientRequestToken :: Lens' CreateStackSet (Maybe Text) Source #

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 stack set 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.

createStackSet_description :: Lens' CreateStackSet (Maybe Text) Source #

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

createStackSet_executionRoleName :: Lens' CreateStackSet (Maybe Text) Source #

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set 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 stack sets.

createStackSet_managedExecution :: Lens' CreateStackSet (Maybe ManagedExecution) Source #

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

createStackSet_parameters :: Lens' CreateStackSet (Maybe [Parameter]) Source #

The input parameters for the stack set template.

createStackSet_permissionModel :: Lens' CreateStackSet (Maybe PermissionModels) Source #

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

createStackSet_stackId :: Lens' CreateStackSet (Maybe Text) Source #

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

createStackSet_tags :: Lens' CreateStackSet (Maybe [Tag]) Source #

The key-value pairs to associate with this stack set 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 stack set is not created.

createStackSet_templateBody :: Lens' CreateStackSet (Maybe Text) Source #

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

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

createStackSet_templateURL :: Lens' CreateStackSet (Maybe Text) Source #

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

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

createStackSet_stackSetName :: Lens' CreateStackSet Text Source #

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

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.

Destructuring the Response

data CreateStackSetResponse Source #

See: newCreateStackSetResponse smart constructor.

Constructors

CreateStackSetResponse' 

Fields

Instances

Instances details
Generic CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Associated Types

type Rep CreateStackSetResponse :: Type -> Type #

Read CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Show CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

NFData CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

Methods

rnf :: CreateStackSetResponse -> () #

Eq CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

type Rep CreateStackSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackSet

type Rep CreateStackSetResponse = D1 ('MetaData "CreateStackSetResponse" "Amazonka.CloudFormation.CreateStackSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CreateStackSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStackSetResponse Source #

Create a value of CreateStackSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStackSetResponse, createStackSetResponse_stackSetId - The ID of the stack set that you're creating.

$sel:httpStatus:CreateStackSetResponse', createStackSetResponse_httpStatus - The response's http status code.

Response Lenses

createStackSetResponse_stackSetId :: Lens' CreateStackSetResponse (Maybe Text) Source #

The ID of the stack set that you're creating.