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.CreateStackInstances

Description

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Synopsis

Creating a Request

data CreateStackInstances Source #

See: newCreateStackInstances smart constructor.

Constructors

CreateStackInstances' 

Fields

  • accounts :: Maybe [Text]
    Self-managed permissions
    The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

    You can specify Accounts or DeploymentTargets, but not both.

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

    • If you are signed in to the management account, specify SELF.
    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

  • deploymentTargets :: Maybe DeploymentTargets
    Service-managed permissions
    The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

    You can specify Accounts or DeploymentTargets, but not both.

  • operationId :: Maybe Text

    The unique identifier for this stack set operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

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

    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

  • operationPreferences :: Maybe StackSetOperationPreferences

    Preferences for how CloudFormation performs this stack set operation.

  • parameterOverrides :: Maybe [Parameter]

    A list of stack set parameters whose values you want to override in the selected stack instances.

    Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

    • To override the current value for a parameter, include the parameter and specify its value.
    • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
    • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
    • To leave all parameters set to their present values, don't specify this property at all.

    During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

    You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

  • stackSetName :: Text

    The name or unique ID of the stack set that you want to create stack instances from.

  • regions :: [Text]

    The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

Instances

Instances details
ToHeaders CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

ToPath CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

ToQuery CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

AWSRequest CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Associated Types

type AWSResponse CreateStackInstances #

Generic CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Associated Types

type Rep CreateStackInstances :: Type -> Type #

Read CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Show CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

NFData CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Methods

rnf :: CreateStackInstances -> () #

Eq CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Hashable CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type AWSResponse CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type Rep CreateStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type Rep CreateStackInstances = D1 ('MetaData "CreateStackInstances" "Amazonka.CloudFormation.CreateStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "CreateStackInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs))) :*: (S1 ('MetaSel ('Just "deploymentTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentTargets)) :*: S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "operationPreferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetOperationPreferences)) :*: S1 ('MetaSel ('Just "parameterOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter]))) :*: (S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newCreateStackInstances Source #

Create a value of CreateStackInstances 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:

CreateStackInstances, createStackInstances_accounts - [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

$sel:callAs:CreateStackInstances', createStackInstances_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.

  • If you are signed in to the management account, specify SELF.
  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

CreateStackInstances, createStackInstances_deploymentTargets - [Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

CreateStackInstances, createStackInstances_operationId - The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

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

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

CreateStackInstances, createStackInstances_operationPreferences - Preferences for how CloudFormation performs this stack set operation.

CreateStackInstances, createStackInstances_parameterOverrides - A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.
  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
  • To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

CreateStackInstances, createStackInstances_stackSetName - The name or unique ID of the stack set that you want to create stack instances from.

$sel:regions:CreateStackInstances', createStackInstances_regions - The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

Request Lenses

createStackInstances_accounts :: Lens' CreateStackInstances (Maybe [Text]) Source #

Self-managed permissions
The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

You can specify Accounts or DeploymentTargets, but not both.

createStackInstances_callAs :: Lens' CreateStackInstances (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.

  • If you are signed in to the management account, specify SELF.
  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

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

createStackInstances_deploymentTargets :: Lens' CreateStackInstances (Maybe DeploymentTargets) Source #

Service-managed permissions
The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

createStackInstances_operationId :: Lens' CreateStackInstances (Maybe Text) Source #

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

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

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

createStackInstances_operationPreferences :: Lens' CreateStackInstances (Maybe StackSetOperationPreferences) Source #

Preferences for how CloudFormation performs this stack set operation.

createStackInstances_parameterOverrides :: Lens' CreateStackInstances (Maybe [Parameter]) Source #

A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.
  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)
  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.
  • To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

createStackInstances_stackSetName :: Lens' CreateStackInstances Text Source #

The name or unique ID of the stack set that you want to create stack instances from.

createStackInstances_regions :: Lens' CreateStackInstances [Text] Source #

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

Destructuring the Response

data CreateStackInstancesResponse Source #

See: newCreateStackInstancesResponse smart constructor.

Constructors

CreateStackInstancesResponse' 

Fields

Instances

Instances details
Generic CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Associated Types

type Rep CreateStackInstancesResponse :: Type -> Type #

Read CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Show CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

NFData CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

Eq CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

type Rep CreateStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.CreateStackInstances

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

newCreateStackInstancesResponse Source #

Create a value of CreateStackInstancesResponse 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:

CreateStackInstances, createStackInstancesResponse_operationId - The unique identifier for this stack set operation.

$sel:httpStatus:CreateStackInstancesResponse', createStackInstancesResponse_httpStatus - The response's http status code.

Response Lenses

createStackInstancesResponse_operationId :: Lens' CreateStackInstancesResponse (Maybe Text) Source #

The unique identifier for this stack set operation.