pub struct CreateStackFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateStack
.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks
operation.
Implementations§
source§impl CreateStackFluentBuilder
impl CreateStackFluentBuilder
sourcepub fn as_input(&self) -> &CreateStackInputBuilder
pub fn as_input(&self) -> &CreateStackInputBuilder
Access the CreateStack as a reference.
sourcepub async fn send(
self
) -> Result<CreateStackOutput, SdkError<CreateStackError, HttpResponse>>
pub async fn send( self ) -> Result<CreateStackOutput, SdkError<CreateStackError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateStackOutput, CreateStackError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateStackOutput, CreateStackError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn stack_name(self, input: impl Into<String>) -> Self
pub fn stack_name(self, input: impl Into<String>) -> Self
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 set_stack_name(self, input: Option<String>) -> Self
pub fn set_stack_name(self, input: Option<String>) -> Self
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 get_stack_name(&self) -> &Option<String>
pub fn get_stack_name(&self) -> &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.
sourcepub fn template_body(self, input: impl Into<String>) -> Self
pub fn template_body(self, input: impl Into<String>) -> Self
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 set_template_body(self, input: Option<String>) -> Self
pub fn set_template_body(self, input: Option<String>) -> Self
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 get_template_body(&self) -> &Option<String>
pub fn get_template_body(&self) -> &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.
sourcepub fn template_url(self, input: impl Into<String>) -> Self
pub fn template_url(self, input: impl Into<String>) -> Self
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 set_template_url(self, input: Option<String>) -> Self
pub fn set_template_url(self, input: Option<String>) -> Self
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 get_template_url(&self) -> &Option<String>
pub fn get_template_url(&self) -> &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.
sourcepub fn parameters(self, input: Parameter) -> Self
pub fn parameters(self, input: Parameter) -> Self
Appends an item to Parameters
.
To override the contents of this collection use set_parameters
.
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
sourcepub fn set_parameters(self, input: Option<Vec<Parameter>>) -> Self
pub fn set_parameters(self, input: Option<Vec<Parameter>>) -> Self
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
sourcepub fn get_parameters(&self) -> &Option<Vec<Parameter>>
pub fn get_parameters(&self) -> &Option<Vec<Parameter>>
A list of Parameter
structures that specify input parameters for the stack. For more information, see the Parameter data type.
sourcepub fn disable_rollback(self, input: bool) -> Self
pub fn disable_rollback(self, input: bool) -> Self
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 set_disable_rollback(self, input: Option<bool>) -> Self
pub fn set_disable_rollback(self, input: Option<bool>) -> Self
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 get_disable_rollback(&self) -> &Option<bool>
pub fn get_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, input: RollbackConfiguration) -> Self
pub fn rollback_configuration(self, input: RollbackConfiguration) -> Self
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
sourcepub fn set_rollback_configuration(
self,
input: Option<RollbackConfiguration>
) -> Self
pub fn set_rollback_configuration( self, input: Option<RollbackConfiguration> ) -> Self
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
sourcepub fn get_rollback_configuration(&self) -> &Option<RollbackConfiguration>
pub fn get_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, input: i32) -> Self
pub fn timeout_in_minutes(self, input: i32) -> Self
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 set_timeout_in_minutes(self, input: Option<i32>) -> Self
pub fn set_timeout_in_minutes(self, input: Option<i32>) -> Self
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 get_timeout_in_minutes(&self) -> &Option<i32>
pub fn get_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, input: impl Into<String>) -> Self
pub fn notification_arns(self, input: impl Into<String>) -> Self
Appends an item to NotificationARNs
.
To override the contents of this collection use set_notification_arns
.
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).
sourcepub fn set_notification_arns(self, input: Option<Vec<String>>) -> Self
pub fn set_notification_arns(self, input: Option<Vec<String>>) -> Self
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).
sourcepub fn get_notification_arns(&self) -> &Option<Vec<String>>
pub fn get_notification_arns(&self) -> &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).
sourcepub fn capabilities(self, input: Capability) -> Self
pub fn capabilities(self, input: Capability) -> Self
Appends an item to Capabilities
.
To override the contents of this collection use set_capabilities
.
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.
sourcepub fn set_capabilities(self, input: Option<Vec<Capability>>) -> Self
pub fn set_capabilities(self, input: Option<Vec<Capability>>) -> Self
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.
sourcepub fn get_capabilities(&self) -> &Option<Vec<Capability>>
pub fn get_capabilities(&self) -> &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.
sourcepub fn resource_types(self, input: impl Into<String>) -> Self
pub fn resource_types(self, input: impl Into<String>) -> Self
Appends an item to ResourceTypes
.
To override the contents of this collection use set_resource_types
.
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.
sourcepub fn set_resource_types(self, input: Option<Vec<String>>) -> Self
pub fn set_resource_types(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_resource_types(&self) -> &Option<Vec<String>>
pub fn get_resource_types(&self) -> &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.
sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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 set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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 get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &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.
sourcepub fn on_failure(self, input: OnFailure) -> Self
pub fn on_failure(self, input: OnFailure) -> Self
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 set_on_failure(self, input: Option<OnFailure>) -> Self
pub fn set_on_failure(self, input: Option<OnFailure>) -> Self
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 get_on_failure(&self) -> &Option<OnFailure>
pub fn get_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, input: impl Into<String>) -> Self
pub fn stack_policy_body(self, input: impl Into<String>) -> Self
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 set_stack_policy_body(self, input: Option<String>) -> Self
pub fn set_stack_policy_body(self, input: Option<String>) -> Self
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 get_stack_policy_body(&self) -> &Option<String>
pub fn get_stack_policy_body(&self) -> &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.
sourcepub fn stack_policy_url(self, input: impl Into<String>) -> Self
pub fn stack_policy_url(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_stack_policy_url(self, input: Option<String>) -> Self
pub fn set_stack_policy_url(self, input: Option<String>) -> Self
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.
sourcepub fn get_stack_policy_url(&self) -> &Option<String>
pub fn get_stack_policy_url(&self) -> &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.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
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 set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
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 get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &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
.
sourcepub fn enable_termination_protection(self, input: bool) -> Self
pub fn enable_termination_protection(self, input: bool) -> Self
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 set_enable_termination_protection(self, input: Option<bool>) -> Self
pub fn set_enable_termination_protection(self, input: Option<bool>) -> Self
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 get_enable_termination_protection(&self) -> &Option<bool>
pub fn get_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, input: bool) -> Self
pub fn retain_except_on_create(self, input: bool) -> Self
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
sourcepub fn set_retain_except_on_create(self, input: Option<bool>) -> Self
pub fn set_retain_except_on_create(self, input: Option<bool>) -> Self
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
sourcepub fn get_retain_except_on_create(&self) -> &Option<bool>
pub fn get_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
Trait Implementations§
source§impl Clone for CreateStackFluentBuilder
impl Clone for CreateStackFluentBuilder
source§fn clone(&self) -> CreateStackFluentBuilder
fn clone(&self) -> CreateStackFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateStackFluentBuilder
impl !RefUnwindSafe for CreateStackFluentBuilder
impl Send for CreateStackFluentBuilder
impl Sync for CreateStackFluentBuilder
impl Unpin for CreateStackFluentBuilder
impl !UnwindSafe for CreateStackFluentBuilder
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