Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an AWS CloudFormation change set for the given application.

Synopsis

Creating a Request

data CreateCloudFormationChangeSet Source #

See: newCreateCloudFormationChangeSet smart constructor.

Constructors

CreateCloudFormationChangeSet'

Fields

capabilities :: Maybe [Text]
A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.
changeSetName :: Maybe Text
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
clientToken :: Maybe Text
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
description :: Maybe Text
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
notificationArns :: Maybe [Text]
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
parameterOverrides :: Maybe [ParameterValue]
A list of parameter values for the parameters of the application.
resourceTypes :: Maybe [Text]
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
rollbackConfiguration :: Maybe RollbackConfiguration
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
semanticVersion :: Maybe Text
The semantic version of the application:
https://semver.org/
tags :: Maybe [Tag]
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.
templateId :: Maybe Text
The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
applicationId :: Text
The Amazon Resource Name (ARN) of the application.
stackName :: Text
This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

Instances

Instances details

ToJSON CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods toJSON :: CreateCloudFormationChangeSet -> Value # toEncoding :: CreateCloudFormationChangeSet -> Encoding # toJSONList :: [CreateCloudFormationChangeSet] -> Value # toEncodingList :: [CreateCloudFormationChangeSet] -> Encoding #
ToHeaders CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods toHeaders :: CreateCloudFormationChangeSet -> [Header] #
ToPath CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods toPath :: CreateCloudFormationChangeSet -> ByteString #
ToQuery CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods toQuery :: CreateCloudFormationChangeSet -> QueryString #
AWSRequest CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Associated Types type AWSResponse CreateCloudFormationChangeSet # Methods request :: (Service -> Service) -> CreateCloudFormationChangeSet -> Request CreateCloudFormationChangeSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCloudFormationChangeSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCloudFormationChangeSet))) #
Generic CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Associated Types type Rep CreateCloudFormationChangeSet :: Type -> Type # Methods from :: CreateCloudFormationChangeSet -> Rep CreateCloudFormationChangeSet x # to :: Rep CreateCloudFormationChangeSet x -> CreateCloudFormationChangeSet #
Read CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods readsPrec :: Int -> ReadS CreateCloudFormationChangeSet # readList :: ReadS [CreateCloudFormationChangeSet] # readPrec :: ReadPrec CreateCloudFormationChangeSet # readListPrec :: ReadPrec [CreateCloudFormationChangeSet] #
Show CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods showsPrec :: Int -> CreateCloudFormationChangeSet -> ShowS # show :: CreateCloudFormationChangeSet -> String # showList :: [CreateCloudFormationChangeSet] -> ShowS #
NFData CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods rnf :: CreateCloudFormationChangeSet -> () #
Eq CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods (==) :: CreateCloudFormationChangeSet -> CreateCloudFormationChangeSet -> Bool # (/=) :: CreateCloudFormationChangeSet -> CreateCloudFormationChangeSet -> Bool #
Hashable CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods hashWithSalt :: Int -> CreateCloudFormationChangeSet -> Int # hash :: CreateCloudFormationChangeSet -> Int #
type AWSResponse CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet type AWSResponse CreateCloudFormationChangeSet = CreateCloudFormationChangeSetResponse
type Rep CreateCloudFormationChangeSet Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet type Rep CreateCloudFormationChangeSet = D1 ('MetaData "CreateCloudFormationChangeSet" "Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "CreateCloudFormationChangeSet'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "notificationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "parameterOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterValue]))))) :: ((S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "rollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RollbackConfiguration)) :: S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateCloudFormationChangeSet Source #

Arguments

:: Text	`CreateCloudFormationChangeSet`
-> Text	`$sel:stackName:CreateCloudFormationChangeSet'`
-> CreateCloudFormationChangeSet

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

$sel:capabilities:CreateCloudFormationChangeSet', createCloudFormationChangeSet_capabilities - A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

$sel:changeSetName:CreateCloudFormationChangeSet', createCloudFormationChangeSet_changeSetName - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

$sel:clientToken:CreateCloudFormationChangeSet', createCloudFormationChangeSet_clientToken - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

CreateCloudFormationChangeSet, createCloudFormationChangeSet_description - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

$sel:notificationArns:CreateCloudFormationChangeSet', createCloudFormationChangeSet_notificationArns - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

$sel:parameterOverrides:CreateCloudFormationChangeSet', createCloudFormationChangeSet_parameterOverrides - A list of parameter values for the parameters of the application.

$sel:resourceTypes:CreateCloudFormationChangeSet', createCloudFormationChangeSet_resourceTypes - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

$sel:rollbackConfiguration:CreateCloudFormationChangeSet', createCloudFormationChangeSet_rollbackConfiguration - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

CreateCloudFormationChangeSet, createCloudFormationChangeSet_semanticVersion - The semantic version of the application:

https://semver.org/

$sel:tags:CreateCloudFormationChangeSet', createCloudFormationChangeSet_tags - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

$sel:templateId:CreateCloudFormationChangeSet', createCloudFormationChangeSet_templateId - The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

CreateCloudFormationChangeSet, createCloudFormationChangeSet_applicationId - The Amazon Resource Name (ARN) of the application.

$sel:stackName:CreateCloudFormationChangeSet', createCloudFormationChangeSet_stackName - This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

Request Lenses

createCloudFormationChangeSet_capabilities :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

A list of values that you must specify before you can deploy certain applications. Some applications 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 applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

createCloudFormationChangeSet_changeSetName :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_clientToken :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_description :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_notificationArns :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_parameterOverrides :: Lens' CreateCloudFormationChangeSet (Maybe [ParameterValue]) Source #

A list of parameter values for the parameters of the application.

createCloudFormationChangeSet_resourceTypes :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_rollbackConfiguration :: Lens' CreateCloudFormationChangeSet (Maybe RollbackConfiguration) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_semanticVersion :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

The semantic version of the application:

https://semver.org/

createCloudFormationChangeSet_tags :: Lens' CreateCloudFormationChangeSet (Maybe [Tag]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_templateId :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

createCloudFormationChangeSet_applicationId :: Lens' CreateCloudFormationChangeSet Text Source #

The Amazon Resource Name (ARN) of the application.

createCloudFormationChangeSet_stackName :: Lens' CreateCloudFormationChangeSet Text Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

Destructuring the Response

data CreateCloudFormationChangeSetResponse Source #

See: newCreateCloudFormationChangeSetResponse smart constructor.

Constructors

CreateCloudFormationChangeSetResponse'

Fields

applicationId :: Maybe Text
The application Amazon Resource Name (ARN).
changeSetId :: Maybe Text
The Amazon Resource Name (ARN) of the change set.
Length constraints: Minimum length of 1.
Pattern: ARN:[-a-zA-Z0-9:/]*
semanticVersion :: Maybe Text
The semantic version of the application:
https://semver.org/
stackId :: Maybe Text
The unique ID of the stack.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Associated Types type Rep CreateCloudFormationChangeSetResponse :: Type -> Type # Methods from :: CreateCloudFormationChangeSetResponse -> Rep CreateCloudFormationChangeSetResponse x # to :: Rep CreateCloudFormationChangeSetResponse x -> CreateCloudFormationChangeSetResponse #
Read CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods readsPrec :: Int -> ReadS CreateCloudFormationChangeSetResponse # readList :: ReadS [CreateCloudFormationChangeSetResponse] # readPrec :: ReadPrec CreateCloudFormationChangeSetResponse # readListPrec :: ReadPrec [CreateCloudFormationChangeSetResponse] #
Show CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods showsPrec :: Int -> CreateCloudFormationChangeSetResponse -> ShowS # show :: CreateCloudFormationChangeSetResponse -> String # showList :: [CreateCloudFormationChangeSetResponse] -> ShowS #
NFData CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods rnf :: CreateCloudFormationChangeSetResponse -> () #
Eq CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet Methods (==) :: CreateCloudFormationChangeSetResponse -> CreateCloudFormationChangeSetResponse -> Bool # (/=) :: CreateCloudFormationChangeSetResponse -> CreateCloudFormationChangeSetResponse -> Bool #
type Rep CreateCloudFormationChangeSetResponse Source #
Instance details Defined in Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet type Rep CreateCloudFormationChangeSetResponse = D1 ('MetaData "CreateCloudFormationChangeSetResponse" "Amazonka.ServerlessApplicationRepository.CreateCloudFormationChangeSet" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "CreateCloudFormationChangeSetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "changeSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))