Network.AWS.CloudFormation.UpdateStack

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack .

Creating a Request

updateStack

Arguments

:: Text

usStackName

-> UpdateStack

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

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

• usUsePreviousTemplate - Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .
• usNotificationARNs - Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
• usStackPolicyBody - Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
• usStackPolicyDuringUpdateBody - Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
• usStackPolicyDuringUpdateURL - Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
• usParameters - A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
• usStackPolicyURL - Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
• usTemplateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .
• usTemplateURL - Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .
• usClientRequestToken - A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1 , then all the StackEvents generated by that operation will have ClientRequestToken set as token1 . In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID , which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 .
• usCapabilities - A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack 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 stacks, 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 , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions 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 .
• usRollbackConfiguration - The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
• usResourceTypes - The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance , AWS::EC2::* , or Custom::MyCustomInstance . If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management .
• usTags - Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
• usRoleARN - The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
• usStackName - The name or unique stack ID of the stack to update.

data UpdateStack

The input for an UpdateStack action.

See: updateStack smart constructor.

Instances

Eq UpdateStack

Methods

(==) :: UpdateStack -> UpdateStack -> Bool

(/=) :: UpdateStack -> UpdateStack -> Bool

Data UpdateStack

Methods

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

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

toConstr :: UpdateStack -> Constr

dataTypeOf :: UpdateStack -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStack)

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

gmapT :: (forall b. Data b => b -> b) -> UpdateStack -> UpdateStack

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

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

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

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

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

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

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

Read UpdateStack

Methods

readsPrec :: Int -> ReadS UpdateStack

readList :: ReadS [UpdateStack]

readPrec :: ReadPrec UpdateStack

readListPrec :: ReadPrec [UpdateStack]

Show UpdateStack

Methods

showsPrec :: Int -> UpdateStack -> ShowS

show :: UpdateStack -> String

showList :: [UpdateStack] -> ShowS

Generic UpdateStack

Associated Types

type Rep UpdateStack :: * -> *

Methods

from :: UpdateStack -> Rep UpdateStack x

to :: Rep UpdateStack x -> UpdateStack

Hashable UpdateStack

Methods

hashWithSalt :: Int -> UpdateStack -> Int

hash :: UpdateStack -> Int

NFData UpdateStack

Methods

rnf :: UpdateStack -> ()

AWSRequest UpdateStack

Associated Types

type Rs UpdateStack :: *

Methods

request :: UpdateStack -> Request UpdateStack

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * UpdateStack -> ClientResponse -> m (Response UpdateStack)

ToHeaders UpdateStack

Methods

toHeaders :: UpdateStack -> [Header]

ToPath UpdateStack

Methods

toPath :: UpdateStack -> ByteString

ToQuery UpdateStack

Methods

toQuery :: UpdateStack -> QueryString

type Rep UpdateStack

type Rep UpdateStack = D1 * (MetaData "UpdateStack" "Network.AWS.CloudFormation.UpdateStack" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" False) (C1 * (MetaCons "UpdateStack'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_usUsePreviousTemplate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_usNotificationARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usStackPolicyBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usStackPolicyDuringUpdateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_usStackPolicyDuringUpdateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Parameter])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usStackPolicyURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_usTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Capability]))) (S1 * (MetaSel (Just Symbol "_usRollbackConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RollbackConfiguration))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_usResourceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_usTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Tag])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_usRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs UpdateStack

type Rs UpdateStack = UpdateStackResponse

Request Lenses

usUsePreviousTemplate :: Lens' UpdateStack (Maybe Bool)

Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .

usNotificationARNs :: Lens' UpdateStack [Text]

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

usStackPolicyBody :: Lens' UpdateStack (Maybe Text)

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

usStackPolicyDuringUpdateBody :: Lens' UpdateStack (Maybe Text)

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

usStackPolicyDuringUpdateURL :: Lens' UpdateStack (Maybe Text)

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

usParameters :: Lens' UpdateStack [Parameter]

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

usStackPolicyURL :: Lens' UpdateStack (Maybe Text)

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

usTemplateBody :: Lens' UpdateStack (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .

usTemplateURL :: Lens' UpdateStack (Maybe Text)

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL , or set the UsePreviousTemplate to true .

usClientRequestToken :: Lens' UpdateStack (Maybe Text)

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1 , then all the StackEvents generated by that operation will have ClientRequestToken set as token1 . In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID , which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 .

usCapabilities :: Lens' UpdateStack [Capability]

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack 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 stacks, 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 , and AWS::IAM::UserToGroupAddition . If your stack template contains these resources, we recommend that you review all permissions 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 .

usRollbackConfiguration :: Lens' UpdateStack (Maybe RollbackConfiguration)

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

usResourceTypes :: Lens' UpdateStack [Text]

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance , AWS::EC2::* , or Custom::MyCustomInstance . If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management .

usTags :: Lens' UpdateStack [Tag]

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.

usRoleARN :: Lens' UpdateStack (Maybe Text)

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

usStackName :: Lens' UpdateStack Text

The name or unique stack ID of the stack to update.

Destructuring the Response

updateStackResponse

Arguments

:: Int

usrsResponseStatus

-> UpdateStackResponse

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

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

• usrsStackId - Unique identifier of the stack.
• usrsResponseStatus - -- | The response status code.

data UpdateStackResponse

The output for an UpdateStack action.

See: updateStackResponse smart constructor.

Instances

Eq UpdateStackResponse

Methods

(==) :: UpdateStackResponse -> UpdateStackResponse -> Bool

(/=) :: UpdateStackResponse -> UpdateStackResponse -> Bool

Data UpdateStackResponse

Methods

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

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

toConstr :: UpdateStackResponse -> Constr

dataTypeOf :: UpdateStackResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStackResponse)

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

gmapT :: (forall b. Data b => b -> b) -> UpdateStackResponse -> UpdateStackResponse

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

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

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

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

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

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

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

Read UpdateStackResponse

Methods

readsPrec :: Int -> ReadS UpdateStackResponse

readList :: ReadS [UpdateStackResponse]

readPrec :: ReadPrec UpdateStackResponse

readListPrec :: ReadPrec [UpdateStackResponse]

Show UpdateStackResponse

Methods

showsPrec :: Int -> UpdateStackResponse -> ShowS

show :: UpdateStackResponse -> String

showList :: [UpdateStackResponse] -> ShowS

Generic UpdateStackResponse

Associated Types

type Rep UpdateStackResponse :: * -> *

Methods

from :: UpdateStackResponse -> Rep UpdateStackResponse x

to :: Rep UpdateStackResponse x -> UpdateStackResponse

NFData UpdateStackResponse

Methods

rnf :: UpdateStackResponse -> ()

type Rep UpdateStackResponse

type Rep UpdateStackResponse = D1 * (MetaData "UpdateStackResponse" "Network.AWS.CloudFormation.UpdateStack" "amazonka-cloudformation-1.6.0-E2GV66prdF5G8DMBRBifWM" False) (C1 * (MetaCons "UpdateStackResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_usrsStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_usrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

usrsStackId :: Lens' UpdateStackResponse (Maybe Text)

Unique identifier of the stack.

usrsResponseStatus :: Lens' UpdateStackResponse Int

• - | The response status code.