Struct aws_sdk_cloudformation::input::UpdateStackInput
source · [−]#[non_exhaustive]pub struct UpdateStackInput {Show 17 fields
pub stack_name: Option<String>,
pub template_body: Option<String>,
pub template_url: Option<String>,
pub use_previous_template: Option<bool>,
pub stack_policy_during_update_body: Option<String>,
pub stack_policy_during_update_url: Option<String>,
pub parameters: Option<Vec<Parameter>>,
pub capabilities: Option<Vec<Capability>>,
pub resource_types: Option<Vec<String>>,
pub role_arn: Option<String>,
pub rollback_configuration: Option<RollbackConfiguration>,
pub stack_policy_body: Option<String>,
pub stack_policy_url: Option<String>,
pub notification_ar_ns: Option<Vec<String>>,
pub tags: Option<Vec<Tag>>,
pub disable_rollback: Option<bool>,
pub client_request_token: Option<String>,
}
Expand description
The input for an UpdateStack
action.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stack_name: Option<String>
The name or unique stack ID of the stack to update.
template_body: Option<String>
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 CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody
, TemplateURL
, or set the UsePreviousTemplate
to true
.
template_url: Option<String>
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
, TemplateURL
, or set the UsePreviousTemplate
to true
.
use_previous_template: Option<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
.
stack_policy_during_update_body: Option<String>
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 don't specify a stack policy, the current policy that is associated with the stack will be used.
stack_policy_during_update_url: Option<String>
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 don't specify a stack policy, the current policy that is associated with the stack will be used.
parameters: Option<Vec<Parameter>>
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
capabilities: Option<Vec<Capability>>
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_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 stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAM
orCAPABILITY_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 suggest 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
resource_types: Option<Vec<String>>
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
role_arn: Option<String>
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
rollback_configuration: Option<RollbackConfiguration>
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
stack_policy_body: Option<String>
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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.
stack_policy_url: Option<String>
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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.
notification_ar_ns: Option<Vec<String>>
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
disable_rollback: Option<bool>
Preserve the state of previously provisioned resources when an operation fails.
Default: False
client_request_token: Option<String>
A unique identifier for this UpdateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack
requests to ensure that 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
.
Implementations
sourceimpl UpdateStackInput
impl UpdateStackInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateStack, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateStack, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<UpdateStack
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture UpdateStackInput
.
sourceimpl UpdateStackInput
impl UpdateStackInput
sourcepub fn stack_name(&self) -> Option<&str>
pub fn stack_name(&self) -> Option<&str>
The name or unique stack ID of the stack to update.
sourcepub fn template_body(&self) -> Option<&str>
pub fn template_body(&self) -> Option<&str>
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 CloudFormation User Guide.)
Conditional: You must specify only one of the following parameters: TemplateBody
, TemplateURL
, or set the UsePreviousTemplate
to true
.
sourcepub fn template_url(&self) -> Option<&str>
pub fn template_url(&self) -> Option<&str>
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
, TemplateURL
, or set the UsePreviousTemplate
to true
.
sourcepub fn use_previous_template(&self) -> Option<bool>
pub fn use_previous_template(&self) -> Option<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
.
sourcepub fn stack_policy_during_update_body(&self) -> Option<&str>
pub fn stack_policy_during_update_body(&self) -> Option<&str>
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 don't specify a stack policy, the current policy that is associated with the stack will be used.
sourcepub fn stack_policy_during_update_url(&self) -> Option<&str>
pub fn stack_policy_during_update_url(&self) -> Option<&str>
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 don't specify a stack policy, the current policy that is associated with the stack will be used.
sourcepub fn parameters(&self) -> Option<&[Parameter]>
pub fn parameters(&self) -> Option<&[Parameter]>
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
sourcepub fn capabilities(&self) -> Option<&[Capability]>
pub fn capabilities(&self) -> Option<&[Capability]>
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.
-
CAPABILITY_IAM
andCAPABILITY_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 stacks, you must explicitly acknowledge this by specifying one of these capabilities.
The following IAM resources require you to specify either the
CAPABILITY_IAM
orCAPABILITY_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 suggest 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 template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.
For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.
sourcepub fn resource_types(&self) -> Option<&[String]>
pub fn resource_types(&self) -> Option<&[String]>
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, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, 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, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.
sourcepub fn rollback_configuration(&self) -> Option<&RollbackConfiguration>
pub fn rollback_configuration(&self) -> Option<&RollbackConfiguration>
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
sourcepub fn stack_policy_body(&self) -> Option<&str>
pub fn stack_policy_body(&self) -> Option<&str>
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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.
sourcepub fn stack_policy_url(&self) -> Option<&str>
pub fn stack_policy_url(&self) -> Option<&str>
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 don't specify a stack policy, the current policy that is associated with the stack is unchanged.
sourcepub fn notification_ar_ns(&self) -> Option<&[String]>
pub fn notification_ar_ns(&self) -> Option<&[String]>
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
Key-value pairs to associate with this stack. 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, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
sourcepub fn disable_rollback(&self) -> Option<bool>
pub fn disable_rollback(&self) -> Option<bool>
Preserve the state of previously provisioned resources when an operation fails.
Default: False
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
A unique identifier for this UpdateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack
requests to ensure that 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
.
Trait Implementations
sourceimpl Clone for UpdateStackInput
impl Clone for UpdateStackInput
sourcefn clone(&self) -> UpdateStackInput
fn clone(&self) -> UpdateStackInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateStackInput
impl Debug for UpdateStackInput
sourceimpl PartialEq<UpdateStackInput> for UpdateStackInput
impl PartialEq<UpdateStackInput> for UpdateStackInput
sourcefn eq(&self, other: &UpdateStackInput) -> bool
fn eq(&self, other: &UpdateStackInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateStackInput) -> bool
fn ne(&self, other: &UpdateStackInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for UpdateStackInput
Auto Trait Implementations
impl RefUnwindSafe for UpdateStackInput
impl Send for UpdateStackInput
impl Sync for UpdateStackInput
impl Unpin for UpdateStackInput
impl UnwindSafe for UpdateStackInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more