#[non_exhaustive]pub struct CreateStackInput {Show 18 fields
pub stack_name: Option<String>,
pub template_body: Option<String>,
pub template_url: Option<String>,
pub parameters: Option<Vec<Parameter>>,
pub disable_rollback: Option<bool>,
pub rollback_configuration: Option<RollbackConfiguration>,
pub timeout_in_minutes: Option<i32>,
pub notification_arns: Option<Vec<String>>,
pub capabilities: Option<Vec<Capability>>,
pub resource_types: Option<Vec<String>>,
pub role_arn: Option<String>,
pub on_failure: Option<OnFailure>,
pub stack_policy_body: Option<String>,
pub stack_policy_url: Option<String>,
pub tags: Option<Vec<Tag>>,
pub client_request_token: Option<String>,
pub enable_termination_protection: Option<bool>,
pub retain_except_on_create: Option<bool>,
}
Expand description
The input for CreateStack
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 that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
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 either the TemplateBody
or the TemplateURL
parameter, but not both.
template_url: Option<String>
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://
.
Conditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but not both.
parameters: Option<Vec<Parameter>>
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
disable_rollback: Option<bool>
Set to true
to disable rollback of the stack if stack creation failed. You can specify either DisableRollback
or OnFailure
, but not both.
Default: false
rollback_configuration: Option<RollbackConfiguration>
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
timeout_in_minutes: Option<i32>
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
notification_arns: Option<Vec<String>>
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
capabilities: Option<Vec<Capability>>
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create 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 recommend 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 creating the stack. If your stack template contains one or more macros, and you choose to create 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 create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create 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.
Only one of the Capabilities
and ResourceType
parameters can be specified.
resource_types: Option<Vec<String>>
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::*
(for all Amazon Web Services resources), Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::*
(for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID
(for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation 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.
Only one of the Capabilities
and ResourceType
parameters can be specified.
role_arn: Option<String>
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create 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's generated from your user credentials.
on_failure: Option<OnFailure>
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING
, ROLLBACK
, or DELETE
. You can specify either OnFailure
or DisableRollback
, but not both.
Default: ROLLBACK
stack_policy_body: Option<String>
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
stack_policy_url: Option<String>
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://
. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
client_request_token: Option<String>
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack
requests to ensure that CloudFormation successfully received them.
All events initiated 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
.
enable_termination_protection: Option<bool>
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
retain_except_on_create: Option<bool>
When set to true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain
.
Default: false
Implementations§
source§impl CreateStackInput
impl CreateStackInput
sourcepub fn stack_name(&self) -> Option<&str>
pub fn stack_name(&self) -> Option<&str>
The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
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 either the TemplateBody
or the TemplateURL
parameter, but not both.
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 (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://
.
Conditional: You must specify either the TemplateBody
or the TemplateURL
parameter, but not both.
sourcepub fn parameters(&self) -> &[Parameter]
pub fn parameters(&self) -> &[Parameter]
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none()
.
sourcepub fn disable_rollback(&self) -> Option<bool>
pub fn disable_rollback(&self) -> Option<bool>
Set to true
to disable rollback of the stack if stack creation failed. You can specify either DisableRollback
or OnFailure
, but not both.
Default: false
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 timeout_in_minutes(&self) -> Option<i32>
pub fn timeout_in_minutes(&self) -> Option<i32>
The amount of time that can pass before the stack status becomes CREATE_FAILED
; if DisableRollback
is not set or is set to false
, the stack will be rolled back.
sourcepub fn notification_arns(&self) -> &[String]
pub fn notification_arns(&self) -> &[String]
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .notification_arns.is_none()
.
sourcepub fn capabilities(&self) -> &[Capability]
pub fn capabilities(&self) -> &[Capability]
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create 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 recommend 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 creating the stack. If your stack template contains one or more macros, and you choose to create 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 create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.
You should only create 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.
Only one of the Capabilities
and ResourceType
parameters can be specified.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capabilities.is_none()
.
sourcepub fn resource_types(&self) -> &[String]
pub fn resource_types(&self) -> &[String]
The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
. Use the following syntax to describe template resource types: AWS::*
(for all Amazon Web Services resources), Custom::*
(for all custom resources), Custom::logical_ID
(for a specific custom resource), AWS::service_name::*
(for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID
(for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation 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.
Only one of the Capabilities
and ResourceType
parameters can be specified.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_types.is_none()
.
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 create 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's generated from your user credentials.
sourcepub fn on_failure(&self) -> Option<&OnFailure>
pub fn on_failure(&self) -> Option<&OnFailure>
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING
, ROLLBACK
, or DELETE
. You can specify either OnFailure
or DisableRollback
, but not both.
Default: ROLLBACK
sourcepub fn stack_policy_body(&self) -> Option<&str>
pub fn stack_policy_body(&self) -> Option<&str>
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
sourcepub fn stack_policy_url(&self) -> Option<&str>
pub fn stack_policy_url(&self) -> Option<&str>
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://
. You can specify either the StackPolicyBody
or the StackPolicyURL
parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
A unique identifier for this CreateStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack
requests to ensure that CloudFormation successfully received them.
All events initiated 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
.
sourcepub fn enable_termination_protection(&self) -> Option<bool>
pub fn enable_termination_protection(&self) -> Option<bool>
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks by default.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
sourcepub fn retain_except_on_create(&self) -> Option<bool>
pub fn retain_except_on_create(&self) -> Option<bool>
When set to true
, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain
.
Default: false
source§impl CreateStackInput
impl CreateStackInput
sourcepub fn builder() -> CreateStackInputBuilder
pub fn builder() -> CreateStackInputBuilder
Creates a new builder-style object to manufacture CreateStackInput
.
Trait Implementations§
source§impl Clone for CreateStackInput
impl Clone for CreateStackInput
source§fn clone(&self) -> CreateStackInput
fn clone(&self) -> CreateStackInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateStackInput
impl Debug for CreateStackInput
source§impl PartialEq for CreateStackInput
impl PartialEq for CreateStackInput
source§fn eq(&self, other: &CreateStackInput) -> bool
fn eq(&self, other: &CreateStackInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateStackInput
Auto Trait Implementations§
impl Freeze for CreateStackInput
impl RefUnwindSafe for CreateStackInput
impl Send for CreateStackInput
impl Sync for CreateStackInput
impl Unpin for CreateStackInput
impl UnwindSafe for CreateStackInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more