amazonka-cloudformation-1.6.1: Amazon CloudFormation SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudFormation.CreateStackSet

Contents

Description

Creates a stack set.

Synopsis

Creating a Request

createStackSet Source #

Creates a value of CreateStackSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cssAdministrationRoleARN - The Amazon Resource Number (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 Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .
  • cssParameters - The input parameters for the stack set template.
  • cssTemplateBody - 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 AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
  • cssTemplateURL - 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. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
  • cssClientRequestToken - A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
  • cssDescription - A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
  • cssCapabilities - A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates 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 stack sets, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: * AWS::IAM::AccessKey * AWS::IAM::Group * AWS::IAM::InstanceProfile * AWS::IAM::Policy * AWS::IAM::Role * AWS::IAM::User * AWS::IAM::UserToGroupAddition If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
  • cssTags - The key-value pairs to associate with this stack set and the stacks created from it. AWS 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, AWS 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.
  • cssStackSetName - The name to associate with the stack set. The name must be unique in the region where you create your stack set.

data CreateStackSet Source #

See: createStackSet smart constructor.

Instances
Eq CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Data CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStackSet -> c CreateStackSet #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStackSet #

toConstr :: CreateStackSet -> Constr #

dataTypeOf :: CreateStackSet -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStackSet) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStackSet) #

gmapT :: (forall b. Data b => b -> b) -> CreateStackSet -> CreateStackSet #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackSet -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackSet -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateStackSet -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStackSet -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStackSet -> m CreateStackSet #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackSet -> m CreateStackSet #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackSet -> m CreateStackSet #

Read CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Show CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Generic CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Associated Types

type Rep CreateStackSet :: Type -> Type #

Hashable CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

AWSRequest CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Associated Types

type Rs CreateStackSet :: Type #

ToHeaders CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

ToPath CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

ToQuery CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

NFData CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Methods

rnf :: CreateStackSet -> () #

type Rep CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

type Rep CreateStackSet = D1 (MetaData "CreateStackSet" "Network.AWS.CloudFormation.CreateStackSet" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "CreateStackSet'" PrefixI True) (((S1 (MetaSel (Just "_cssAdministrationRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cssParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) :*: (S1 (MetaSel (Just "_cssTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cssTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cssClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cssDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cssCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability])) :*: (S1 (MetaSel (Just "_cssTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 (MetaSel (Just "_cssStackSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CreateStackSet Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Request Lenses

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

The Amazon Resource Number (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 Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide .

cssParameters :: Lens' CreateStackSet [Parameter] Source #

The input parameters for the stack set template.

cssTemplateBody :: 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 AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

cssTemplateURL :: 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. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

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

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.

cssDescription :: 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.

cssCapabilities :: Lens' CreateStackSet [Capability] Source #

A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates 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 stack sets, you must explicitly acknowledge their capabilities by specifying this parameter. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: * AWS::IAM::AccessKey * AWS::IAM::Group * AWS::IAM::InstanceProfile * AWS::IAM::Policy * AWS::IAM::Role * AWS::IAM::User * AWS::IAM::UserToGroupAddition If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary. 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 this parameter, this action returns an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

cssTags :: Lens' CreateStackSet [Tag] Source #

The key-value pairs to associate with this stack set and the stacks created from it. AWS 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, AWS 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.

cssStackSetName :: 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.

Destructuring the Response

createStackSetResponse Source #

Creates a value of CreateStackSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateStackSetResponse Source #

See: createStackSetResponse smart constructor.

Instances
Eq CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Data CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateStackSetResponse -> c CreateStackSetResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateStackSetResponse #

toConstr :: CreateStackSetResponse -> Constr #

dataTypeOf :: CreateStackSetResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateStackSetResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateStackSetResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateStackSetResponse -> CreateStackSetResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackSetResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateStackSetResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateStackSetResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateStackSetResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateStackSetResponse -> m CreateStackSetResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackSetResponse -> m CreateStackSetResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateStackSetResponse -> m CreateStackSetResponse #

Read CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Show CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Generic CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Associated Types

type Rep CreateStackSetResponse :: Type -> Type #

NFData CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

Methods

rnf :: CreateStackSetResponse -> () #

type Rep CreateStackSetResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.CreateStackSet

type Rep CreateStackSetResponse = D1 (MetaData "CreateStackSetResponse" "Network.AWS.CloudFormation.CreateStackSet" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "CreateStackSetResponse'" PrefixI True) (S1 (MetaSel (Just "_cssrsStackSetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

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

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