Struct aws_sdk_cloudformation::Client

pub struct Client { /* private fields */ }

Client for AWS CloudFormation

Client for invoking operations on AWS CloudFormation. Each operation on AWS CloudFormation is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_cloudformation::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_cloudformation::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivateType operation has a Client::activate_type, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_type()
    .r#type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn activate_organizations_access( &self ) -> ActivateOrganizationsAccessFluentBuilder

Constructs a fluent builder for the ActivateOrganizationsAccess operation.

• The fluent builder takes no input, just send it.
• On success, responds with ActivateOrganizationsAccessOutput
• On failure, responds with SdkError<ActivateOrganizationsAccessError>

impl Client

pub fn activate_type(&self) -> ActivateTypeFluentBuilder

Constructs a fluent builder for the ActivateType operation.

• The fluent builder is configurable:
  • r#type(ThirdPartyType) / set_type(Option<ThirdPartyType>):
    required: false
    

    The extension type.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    
    
  • public_type_arn(impl Into<String>) / set_public_type_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the public extension.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    
    
  • publisher_id(impl Into<String>) / set_publisher_id(Option<String>):
    required: false
    

    The ID of the extension publisher.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

    
    
  • type_name_alias(impl Into<String>) / set_type_name_alias(Option<String>):
    required: false
    

    An alias to assign to the public extension, in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

    An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.

    
    
  • auto_update(bool) / set_auto_update(Option<bool>):
    required: false
    

    Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

    The default is true.

    
    
  • logging_config(LoggingConfig) / set_logging_config(Option<LoggingConfig>):
    required: false
    

    Contains logging configuration information for an extension.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The name of the IAM execution role to use to activate the extension.

    
    
  • version_bump(VersionBump) / set_version_bump(Option<VersionBump>):
    required: false
    

    Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

    • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

    • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

    
    
  • major_version(i64) / set_major_version(Option<i64>):
    required: false
    

    The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

    You can specify MajorVersion or VersionBump, but not both.

    
    
• On success, responds with ActivateTypeOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the activated extension, in this account and Region.

• On failure, responds with SdkError<ActivateTypeError>

impl Client

pub fn batch_describe_type_configurations( &self ) -> BatchDescribeTypeConfigurationsFluentBuilder

Constructs a fluent builder for the BatchDescribeTypeConfigurations operation.

• The fluent builder is configurable:
  • type_configuration_identifiers(TypeConfigurationIdentifier) / set_type_configuration_identifiers(Option<Vec::<TypeConfigurationIdentifier>>):
    required: true
    

    The list of identifiers for the desired extension configurations.

    
    
• On success, responds with BatchDescribeTypeConfigurationsOutput with field(s):
  • errors(Option<Vec::<BatchDescribeTypeConfigurationsError>>):

    A list of information concerning any errors generated during the setting of the specified configurations.

  • unprocessed_type_configurations(Option<Vec::<TypeConfigurationIdentifier>>):

    A list of any of the specified extension configurations that CloudFormation could not process for any reason.

  • type_configurations(Option<Vec::<TypeConfigurationDetails>>):

    A list of any of the specified extension configurations from the CloudFormation registry.

• On failure, responds with SdkError<BatchDescribeTypeConfigurationsError>

impl Client

pub fn cancel_update_stack(&self) -> CancelUpdateStackFluentBuilder

Constructs a fluent builder for the CancelUpdateStack operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    If you don’t pass a parameter to StackName, the API returns a response that describes all resources in the account.

    The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

    { “Version”: “2012-10-17”, “Statement”: [{ “Effect”: “Deny”, “Action”: “cloudformation:DescribeStacks”, “NotResource”: “arn:aws:cloudformation:::stack//” }] }

    The name or the unique stack ID that’s associated with the stack.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

    
    
• On success, responds with CancelUpdateStackOutput
• On failure, responds with SdkError<CancelUpdateStackError>

impl Client

pub fn continue_update_rollback(&self) -> ContinueUpdateRollbackFluentBuilder

Constructs a fluent builder for the ContinueUpdateRollback operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the unique ID of the stack that you want to continue rolling back.

    Don’t specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back 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 permission.

    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.

    
    
  • resources_to_skip(impl Into<String>) / set_resources_to_skip(Option<Vec::<String>>):
    required: false
    

    A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can’t specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

    Specify this property to skip rolling back resources that CloudFormation can’t successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don’t, subsequent stack updates might fail, and the stack will become unrecoverable.

    Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

    To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

    Don’t confuse a child stack’s name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received them.

    
    
• On success, responds with ContinueUpdateRollbackOutput
• On failure, responds with SdkError<ContinueUpdateRollbackError>

impl Client

pub fn create_change_set(&self) -> CreateChangeSetFluentBuilder

Constructs a fluent builder for the CreateChangeSet operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack’s information with the information that you submit, such as a modified template or different parameter input values.

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

    Conditional: You must specify only TemplateBody or TemplateURL.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    The location of the file that contains the revised template. 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. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must specify only TemplateBody or TemplateURL.

    
    
  • use_previous_template(bool) / set_use_previous_template(Option<bool>):
    required: false
    

    Whether to reuse the template that’s associated with the stack to create the change set.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

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

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: false
    

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_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 or CAPABILITY_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.

      • AWS::IAM::AccessKey

      • AWS::IAM::Group

      • AWS::IAM::InstanceProfile

      • AWS::IAM::Policy

      • AWS::IAM::Role

      • AWS::IAM::User

      • AWS::IAM::UserToGroupAddition

      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.

      This capacity doesn’t apply to creating change sets, and specifying it when creating change sets has no effect.

      If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

      For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

    Only one of the Capabilities and ResourceType parameters can be specified.

    
    
  • resource_types(impl Into<String>) / set_resource_types(Option<Vec::<String>>):
    required: false
    

    The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

    If the list of resource types doesn’t include a resource type 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 condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

    Only one of the Capabilities and ResourceType parameters can be specified.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the role’s credentials to make calls on your behalf. CloudFormation 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 permission.

    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(RollbackConfiguration) / set_rollback_configuration(Option<RollbackConfiguration>):
    required: false
    

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

    
    
  • notification_arns(impl Into<String>) / set_notification_arns(Option<Vec::<String>>):
    required: false
    

    The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

    
    
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: true
    

    The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

    A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can’t exceed 128 characters.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description to help you identify this change set.

    
    
  • change_set_type(ChangeSetType) / set_change_set_type(Option<ChangeSetType>):
    required: false
    

    The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT.

    If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

    By default, CloudFormation specifies UPDATE. You can’t use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

    
    
  • resources_to_import(ResourceToImport) / set_resources_to_import(Option<Vec::<ResourceToImport>>):
    required: false
    

    The resources to import into your stack.

    
    
  • include_nested_stacks(bool) / set_include_nested_stacks(Option<bool>):
    required: false
    

    Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False. To include nested sets in a change set, specify True.

    
    
  • on_stack_failure(OnStackFailure) / set_on_stack_failure(Option<OnStackFailure>):
    required: false
    

    Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

    • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

    • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

    • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

    For nested stacks, when the OnStackFailure parameter is set to DELETE for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.

    
    
  • import_existing_resources(bool) / set_import_existing_resources(Option<bool>):
    required: false
    

    Indicates if the change set imports resources that already exist.

    This parameter can only import resources that have custom names in templates. For more information, see name type in the CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation management in the CloudFormation User Guide.

    
    
• On success, responds with CreateChangeSetOutput with field(s):
  • id(Option<String>):

    The Amazon Resource Name (ARN) of the change set.

  • stack_id(Option<String>):

    The unique ID of the stack.

• On failure, responds with SdkError<CreateChangeSetError>

impl Client

pub fn create_generated_template(&self) -> CreateGeneratedTemplateFluentBuilder

Constructs a fluent builder for the CreateGeneratedTemplate operation.

• The fluent builder is configurable:
  • resources(ResourceDefinition) / set_resources(Option<Vec::<ResourceDefinition>>):
    required: false
    

    An optional list of resources to be included in the generated template.

    If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.

    
    
  • generated_template_name(impl Into<String>) / set_generated_template_name(Option<String>):
    required: true
    

    The name assigned to the generated template.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    An optional name or ARN of a stack to use as the base stack for the generated template.

    
    
  • template_configuration(TemplateConfiguration) / set_template_configuration(Option<TemplateConfiguration>):
    required: false
    

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    
    
• On success, responds with CreateGeneratedTemplateOutput with field(s):
  • generated_template_id(Option<String>):

    The ID of the generated template.

• On failure, responds with SdkError<CreateGeneratedTemplateError>

impl Client

pub fn create_stack(&self) -> CreateStackFluentBuilder

Constructs a fluent builder for the CreateStack operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    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(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    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(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

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

    
    
  • disable_rollback(bool) / set_disable_rollback(Option<bool>):
    required: false
    

    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(RollbackConfiguration) / set_rollback_configuration(Option<RollbackConfiguration>):
    required: false
    

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

    
    
  • timeout_in_minutes(i32) / set_timeout_in_minutes(Option<i32>):
    required: false
    

    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(impl Into<String>) / set_notification_arns(Option<Vec::<String>>):
    required: false
    

    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(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: false
    

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_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 or CAPABILITY_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.

      • AWS::IAM::AccessKey

      • AWS::IAM::Group

      • AWS::IAM::InstanceProfile

      • AWS::IAM::Policy

      • AWS::IAM::Role

      • AWS::IAM::User

      • AWS::IAM::UserToGroupAddition

      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(impl Into<String>) / set_resource_types(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    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(OnFailure) / set_on_failure(Option<OnFailure>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_url(Option<String>):
    required: false
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    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(bool) / set_enable_termination_protection(Option<bool>):
    required: false
    

    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(bool) / set_retain_except_on_create(Option<bool>):
    required: false
    

    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

    
    
• On success, responds with CreateStackOutput with field(s):
  • stack_id(Option<String>):

    Unique identifier of the stack.

• On failure, responds with SdkError<CreateStackError>

impl Client

pub fn create_stack_instances(&self) -> CreateStackInstancesFluentBuilder

Constructs a fluent builder for the CreateStackInstances operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to create stack instances from.

    
    
  • accounts(impl Into<String>) / set_accounts(Option<Vec::<String>>):
    required: false
    

    [Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • deployment_targets(DeploymentTargets) / set_deployment_targets(Option<DeploymentTargets>):
    required: false
    

    [Service-managed permissions] The Organizations accounts for which to create stack instances in the specified Amazon Web Services Regions.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: true
    

    The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

    
    
  • parameter_overrides(Parameter) / set_parameter_overrides(Option<Vec::<Parameter>>):
    required: false
    

    A list of stack set parameters whose values you want to override in the selected stack instances.

    Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

    • To override the current value for a parameter, include the parameter and specify its value.

    • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can’t specify both a value and set UsePreviousValue to true.)

    • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don’t include the parameter in the list.

    • To leave all parameters set to their present values, don’t specify this property at all.

    During stack set updates, any parameter values overridden for a stack instance aren’t updated, but retain their overridden value.

    You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    Preferences for how CloudFormation performs this stack set operation.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    The unique identifier for this stack set operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

    If you don’t specify an operation ID, the SDK generates one automatically.

    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with CreateStackInstancesOutput with field(s):
  • operation_id(Option<String>):

    The unique identifier for this stack set operation.

• On failure, responds with SdkError<CreateStackInstancesError>

impl Client

pub fn create_stack_set(&self) -> CreateStackSetFluentBuilder

Constructs a fluent builder for the CreateStackSet operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

    A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can’t be longer than 128 characters.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the stack set. You can use the description to identify the stack set’s purpose or other important information.

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that’s located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

    Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

    
    
  • stack_id(impl Into<String>) / set_stack_id(Option<String>):
    required: false
    

    The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    The input parameters for the stack set template.

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: false
    

    In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.

    • CAPABILITY_IAM and CAPABILITY_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 stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_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.

      • AWS::IAM::AccessKey

      • AWS::IAM::Group

      • AWS::IAM::InstanceProfile

      • AWS::IAM::Policy

      • AWS::IAM::Role

      • AWS::IAM::User

      • AWS::IAM::UserToGroupAddition

      For more information, see Acknowledging IAM Resources in CloudFormation Templates.

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

      Stack sets with service-managed permissions don’t currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

    If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don’t, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

    
    
  • administration_role_arn(impl Into<String>) / set_administration_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

    
    
  • execution_role_name(impl Into<String>) / set_execution_role_name(Option<String>):
    required: false
    

    The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

    
    
  • permission_model(PermissionModels) / set_permission_model(Option<PermissionModels>):
    required: false
    

    Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

    • With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

    • With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

    
    
  • auto_deployment(AutoDeployment) / set_auto_deployment(Option<AutoDeployment>):
    required: false
    

    Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

    • To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

    If you don’t specify an operation ID, the SDK generates one automatically.

    
    
  • managed_execution(ManagedExecution) / set_managed_execution(Option<ManagedExecution>):
    required: false
    

    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    
    
• On success, responds with CreateStackSetOutput with field(s):
  • stack_set_id(Option<String>):

    The ID of the stack set that you’re creating.

• On failure, responds with SdkError<CreateStackSetError>

impl Client

pub fn deactivate_organizations_access( &self ) -> DeactivateOrganizationsAccessFluentBuilder

Constructs a fluent builder for the DeactivateOrganizationsAccess operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeactivateOrganizationsAccessOutput
• On failure, responds with SdkError<DeactivateOrganizationsAccessError>

impl Client

pub fn deactivate_type(&self) -> DeactivateTypeFluentBuilder

Constructs a fluent builder for the DeactivateType operation.

• The fluent builder is configurable:
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The type name of the extension, in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.

    Conditional: You must specify either Arn, or TypeName and Type.

    
    
  • r#type(ThirdPartyType) / set_type(Option<ThirdPartyType>):
    required: false
    

    The extension type.

    Conditional: You must specify either Arn, or TypeName and Type.

    
    
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the extension, in this account and Region.

    Conditional: You must specify either Arn, or TypeName and Type.

    
    
• On success, responds with DeactivateTypeOutput
• On failure, responds with SdkError<DeactivateTypeError>

impl Client

pub fn delete_change_set(&self) -> DeleteChangeSetFluentBuilder

Constructs a fluent builder for the DeleteChangeSet operation.

• The fluent builder is configurable:
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the change set that you want to delete.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that’s associated with it.

    
    
• On success, responds with DeleteChangeSetOutput
• On failure, responds with SdkError<DeleteChangeSetError>

impl Client

pub fn delete_generated_template(&self) -> DeleteGeneratedTemplateFluentBuilder

Constructs a fluent builder for the DeleteGeneratedTemplate operation.

• The fluent builder is configurable:
  • generated_template_name(impl Into<String>) / set_generated_template_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of a generated template.

    
    
• On success, responds with DeleteGeneratedTemplateOutput
• On failure, responds with SdkError<DeleteGeneratedTemplateError>

impl Client

pub fn delete_stack(&self) -> DeleteStackFluentBuilder

Constructs a fluent builder for the DeleteStack operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the unique stack ID that’s associated with the stack.

    
    
  • retain_resources(impl Into<String>) / set_retain_resources(Option<Vec::<String>>):
    required: false
    

    For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn’t delete the retained resources.

    Retaining resources is useful when you can’t delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role’s credentials to make calls on your behalf.

    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.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to delete a stack with the same name. You might retry DeleteStack 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.

    
    
• On success, responds with DeleteStackOutput
• On failure, responds with SdkError<DeleteStackError>

impl Client

pub fn delete_stack_instances(&self) -> DeleteStackInstancesFluentBuilder

Constructs a fluent builder for the DeleteStackInstances operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to delete stack instances for.

    
    
  • accounts(impl Into<String>) / set_accounts(Option<Vec::<String>>):
    required: false
    

    [Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • deployment_targets(DeploymentTargets) / set_deployment_targets(Option<DeploymentTargets>):
    required: false
    

    [Service-managed permissions] The Organizations accounts from which to delete stack instances.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: true
    

    The Amazon Web Services Regions where you want to delete stack set instances.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    Preferences for how CloudFormation performs this stack set operation.

    
    
  • retain_stacks(bool) / set_retain_stacks(Option<bool>):
    required: true
    

    Removes the stack instances from the specified stack set, but doesn’t delete the stacks. You can’t reassociate a retained stack or add an existing, saved stack to a new stack set.

    For more information, see Stack set operation options.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    The unique identifier for this stack set operation.

    If you don’t specify an operation ID, the SDK generates one automatically.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DeleteStackInstancesOutput with field(s):
  • operation_id(Option<String>):

    The unique identifier for this stack set operation.

• On failure, responds with SdkError<DeleteStackInstancesError>

impl Client

pub fn delete_stack_set(&self) -> DeleteStackSetFluentBuilder

Constructs a fluent builder for the DeleteStackSet operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you’re deleting. You can obtain this value by running ListStackSets.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DeleteStackSetOutput
• On failure, responds with SdkError<DeleteStackSetError>

impl Client

pub fn deregister_type(&self) -> DeregisterTypeFluentBuilder

Constructs a fluent builder for the DeregisterType operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • version_id(impl Into<String>) / set_version_id(Option<String>):
    required: false
    

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    
    
• On success, responds with DeregisterTypeOutput
• On failure, responds with SdkError<DeregisterTypeError>

impl Client

pub fn describe_account_limits(&self) -> DescribeAccountLimitsFluentBuilder

Constructs a fluent builder for the DescribeAccountLimits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of limits that you want to retrieve.

    
    
• On success, responds with DescribeAccountLimitsOutput with field(s):
  • account_limits(Option<Vec::<AccountLimit>>):

    An account limit structure that contain a list of CloudFormation account limits and their values.

  • next_token(Option<String>):

    If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

• On failure, responds with SdkError<DescribeAccountLimitsError>

impl Client

pub fn describe_change_set(&self) -> DescribeChangeSetFluentBuilder

Constructs a fluent builder for the DescribeChangeSet operation.

• The fluent builder is configurable:
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

    
    
  • include_property_values(bool) / set_include_property_values(Option<bool>):
    required: false
    

    If true, the returned changes include detailed changes in the property values.

    
    
• On success, responds with DescribeChangeSetOutput with field(s):
  • change_set_name(Option<String>):

    The name of the change set.

  • change_set_id(Option<String>):

    The Amazon Resource Name (ARN) of the change set.

  • stack_id(Option<String>):

    The Amazon Resource Name (ARN) of the stack that’s associated with the change set.

  • stack_name(Option<String>):

    The name of the stack that’s associated with the change set.

  • description(Option<String>):

    Information about the change set.

  • parameters(Option<Vec::<Parameter>>):

    A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

  • creation_time(Option<DateTime>):

    The start time when the change set was created, in UTC.

  • execution_status(Option<ExecutionStatus>):

    If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

  • status(Option<ChangeSetStatus>):

    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

  • status_reason(Option<String>):

    A description of the change set’s status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

  • notification_arns(Option<Vec::<String>>):

    The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

  • rollback_configuration(Option<RollbackConfiguration>):

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

  • capabilities(Option<Vec::<Capability>>):

    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

  • tags(Option<Vec::<Tag>>):

    If you execute the change set, the tags that will be associated with the stack.

  • changes(Option<Vec::<Change>>):

    A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

  • next_token(Option<String>):

    If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

  • include_nested_stacks(Option<bool>):

    Verifies if IncludeNestedStacks is set to True.

  • parent_change_set_id(Option<String>):

    Specifies the change set ID of the parent change set in the current nested change set hierarchy.

  • root_change_set_id(Option<String>):

    Specifies the change set ID of the root change set in the current nested change set hierarchy.

  • on_stack_failure(Option<OnStackFailure>):

    Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

    • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

    • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

    • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • import_existing_resources(Option<bool>):

    Indicates if the change set imports resources that already exist.

    This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

• On failure, responds with SdkError<DescribeChangeSetError>

impl Client

pub fn describe_change_set_hooks(&self) -> DescribeChangeSetHooksFluentBuilder

Constructs a fluent builder for the DescribeChangeSetHooks operation.

• The fluent builder is configurable:
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of information that you want to retrieve.

    
    
  • logical_resource_id(impl Into<String>) / set_logical_resource_id(Option<String>):
    required: false
    

    If specified, lists only the hooks related to the specified LogicalResourceId.

    
    
• On success, responds with DescribeChangeSetHooksOutput with field(s):
  • change_set_id(Option<String>):

    The change set identifier (stack ID).

  • change_set_name(Option<String>):

    The change set name.

  • hooks(Option<Vec::<ChangeSetHook>>):

    List of hook objects.

  • status(Option<ChangeSetHooksStatus>):

    Provides the status of the change set hook.

  • next_token(Option<String>):

    Pagination token, null or empty if no more results.

  • stack_id(Option<String>):

    The stack identifier (stack ID).

  • stack_name(Option<String>):

    The stack name.

• On failure, responds with SdkError<DescribeChangeSetHooksError>

impl Client

pub fn describe_generated_template( &self ) -> DescribeGeneratedTemplateFluentBuilder

Constructs a fluent builder for the DescribeGeneratedTemplate operation.

• The fluent builder is configurable:
  • generated_template_name(impl Into<String>) / set_generated_template_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of a generated template.

    
    
• On success, responds with DescribeGeneratedTemplateOutput with field(s):
  • generated_template_id(Option<String>):

    The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

  • generated_template_name(Option<String>):

    The name of the generated template.

  • resources(Option<Vec::<ResourceDetail>>):

    A list of objects describing the details of the resources in the template generation.

  • status(Option<GeneratedTemplateStatus>):

    The status of the template generation. Supported values are:

    • CreatePending - the creation of the template is pending.

    • CreateInProgress - the creation of the template is in progress.

    • DeletePending - the deletion of the template is pending.

    • DeleteInProgress - the deletion of the template is in progress.

    • UpdatePending - the update of the template is pending.

    • UpdateInProgress - the update of the template is in progress.

    • Failed - the template operation failed.

    • Complete - the template operation is complete.

  • status_reason(Option<String>):

    The reason for the current template generation status. This will provide more details if a failure happened.

  • creation_time(Option<DateTime>):

    The time the generated template was created.

  • last_updated_time(Option<DateTime>):

    The time the generated template was last updated.

  • progress(Option<TemplateProgress>):

    An object describing the progress of the template generation.

  • stack_id(Option<String>):

    The stack ARN of the base stack if a base stack was provided when generating the template.

  • template_configuration(Option<TemplateConfiguration>):

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

  • total_warnings(Option<i32>):

    The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

• On failure, responds with SdkError<DescribeGeneratedTemplateError>

impl Client

pub fn describe_organizations_access( &self ) -> DescribeOrganizationsAccessFluentBuilder

Constructs a fluent builder for the DescribeOrganizationsAccess operation.

• The fluent builder is configurable:
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DescribeOrganizationsAccessOutput with field(s):
  • status(Option<OrganizationStatus>):

    Presents the status of the OrganizationAccess.

• On failure, responds with SdkError<DescribeOrganizationsAccessError>

impl Client

pub fn describe_publisher(&self) -> DescribePublisherFluentBuilder

Constructs a fluent builder for the DescribePublisher operation.

• The fluent builder is configurable:
  • publisher_id(impl Into<String>) / set_publisher_id(Option<String>):
    required: false
    

    The ID of the extension publisher.

    If you don’t supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

    
    
• On success, responds with DescribePublisherOutput with field(s):
  • publisher_id(Option<String>):

    The ID of the extension publisher.

  • publisher_status(Option<PublisherStatus>):

    Whether the publisher is verified. Currently, all registered publishers are verified.

  • identity_provider(Option<IdentityProvider>):

    The type of account used as the identity provider when registering this publisher with CloudFormation.

  • publisher_profile(Option<String>):

    The URL to the publisher’s profile with the identity provider.

• On failure, responds with SdkError<DescribePublisherError>

impl Client

pub fn describe_resource_scan(&self) -> DescribeResourceScanFluentBuilder

Constructs a fluent builder for the DescribeResourceScan operation.

• The fluent builder is configurable:
  • resource_scan_id(impl Into<String>) / set_resource_scan_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource scan.

    
    
• On success, responds with DescribeResourceScanOutput with field(s):
  • resource_scan_id(Option<String>):

    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

  • status(Option<ResourceScanStatus>):

    Status of the resource scan.

    INPROGRESS

    The resource scan is still in progress.

    COMPLETE

    The resource scan is complete.

    EXPIRED

    The resource scan has expired.

    FAILED

    The resource scan has failed.

  • status_reason(Option<String>):

    The reason for the resource scan status, providing more information if a failure happened.

  • start_time(Option<DateTime>):

    The time that the resource scan was started.

  • end_time(Option<DateTime>):

    The time that the resource scan was finished.

  • percentage_completed(Option<f64>):

    The percentage of the resource scan that has been completed.

  • resource_types(Option<Vec::<String>>):

    The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

  • resources_scanned(Option<i32>):

    The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

  • resources_read(Option<i32>):

    The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

    This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

• On failure, responds with SdkError<DescribeResourceScanError>

impl Client

pub fn describe_stack_drift_detection_status( &self ) -> DescribeStackDriftDetectionStatusFluentBuilder

Constructs a fluent builder for the DescribeStackDriftDetectionStatus operation.

• The fluent builder is configurable:
  • stack_drift_detection_id(impl Into<String>) / set_stack_drift_detection_id(Option<String>):
    required: true
    

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

    
    
• On success, responds with DescribeStackDriftDetectionStatusOutput with field(s):
  • stack_id(Option<String>):

    The ID of the stack.

  • stack_drift_detection_id(Option<String>):

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

  • stack_drift_status(Option<StackDriftStatus>):

    Status of the stack’s actual configuration compared to its expected configuration.

    • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

    • NOT_CHECKED: CloudFormation hasn’t checked if the stack differs from its expected template configuration.

    • IN_SYNC: The stack’s actual configuration matches its expected template configuration.

    • UNKNOWN: This value is reserved for future use.

  • detection_status(Option<StackDriftDetectionStatus>):

    The status of the stack drift detection operation.

    • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don’t currently support stack detection remain unchecked.)

      If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

    • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

    • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

  • detection_status_reason(Option<String>):

    The reason the stack drift detection operation has its current status.

  • drifted_stack_resource_count(Option<i32>):

    Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

  • timestamp(Option<DateTime>):

    Time at which the stack drift detection operation was initiated.

• On failure, responds with SdkError<DescribeStackDriftDetectionStatusError>

impl Client

pub fn describe_stack_events(&self) -> DescribeStackEventsFluentBuilder

Constructs a fluent builder for the DescribeStackEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    The name or the unique stack ID that’s associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of events that you want to retrieve.

    
    
• On success, responds with DescribeStackEventsOutput with field(s):
  • stack_events(Option<Vec::<StackEvent>>):

    A list of StackEvents structures.

  • next_token(Option<String>):

    If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

• On failure, responds with SdkError<DescribeStackEventsError>

impl Client

pub fn describe_stack_instance(&self) -> DescribeStackInstanceFluentBuilder

Constructs a fluent builder for the DescribeStackInstance operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or the unique stack ID of the stack set that you want to get stack instance information for.

    
    
  • stack_instance_account(impl Into<String>) / set_stack_instance_account(Option<String>):
    required: true
    

    The ID of an Amazon Web Services account that’s associated with this stack instance.

    
    
  • stack_instance_region(impl Into<String>) / set_stack_instance_region(Option<String>):
    required: true
    

    The name of a Region that’s associated with this stack instance.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DescribeStackInstanceOutput with field(s):
  • stack_instance(Option<StackInstance>):

    The stack instance that matches the specified request parameters.

• On failure, responds with SdkError<DescribeStackInstanceError>

impl Client

pub fn describe_stack_resource(&self) -> DescribeStackResourceFluentBuilder

Constructs a fluent builder for the DescribeStackResource operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the unique stack ID that’s associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    
    
  • logical_resource_id(impl Into<String>) / set_logical_resource_id(Option<String>):
    required: true
    

    The logical name of the resource as specified in the template.

    Default: There is no default value.

    
    
• On success, responds with DescribeStackResourceOutput with field(s):
  • stack_resource_detail(Option<StackResourceDetail>):

    A StackResourceDetail structure containing the description of the specified resource in the specified stack.

• On failure, responds with SdkError<DescribeStackResourceError>

impl Client

pub fn describe_stack_resource_drifts( &self ) -> DescribeStackResourceDriftsFluentBuilder

Constructs a fluent builder for the DescribeStackResourceDrifts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack for which you want drift information.

    
    
  • stack_resource_drift_status_filters(StackResourceDriftStatus) / set_stack_resource_drift_status_filters(Option<Vec::<StackResourceDriftStatus>>):
    required: false
    

    The resource drift status values to use as filters for the resource drift results returned.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

    • MODIFIED: One or more resource properties differ from their expected template values.

    • IN_SYNC: The resource’s actual configuration matches its expected template configuration.

    • NOT_CHECKED: CloudFormation doesn’t currently return this value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of stack resource drift results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
• On success, responds with DescribeStackResourceDriftsOutput with field(s):
  • stack_resource_drifts(Option<Vec::<StackResourceDrift>>):

    Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

    For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven’t yet been checked for drift aren’t included. Resources that do not currently support drift detection aren’t checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<DescribeStackResourceDriftsError>

impl Client

pub fn describe_stack_resources(&self) -> DescribeStackResourcesFluentBuilder

Constructs a fluent builder for the DescribeStackResources operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    The name or the unique stack ID that is associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    Required: Conditional. If you don’t specify StackName, you must specify PhysicalResourceId.

    
    
  • logical_resource_id(impl Into<String>) / set_logical_resource_id(Option<String>):
    required: false
    

    The logical name of the resource as specified in the template.

    Default: There is no default value.

    
    
  • physical_resource_id(impl Into<String>) / set_physical_resource_id(Option<String>):
    required: false
    

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

    For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

    Required: Conditional. If you don’t specify PhysicalResourceId, you must specify StackName.

    Default: There is no default value.

    
    
• On success, responds with DescribeStackResourcesOutput with field(s):
  • stack_resources(Option<Vec::<StackResource>>):

    A list of StackResource structures.

• On failure, responds with SdkError<DescribeStackResourcesError>

impl Client

pub fn describe_stack_set(&self) -> DescribeStackSetFluentBuilder

Constructs a fluent builder for the DescribeStackSet operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set whose description you want.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DescribeStackSetOutput with field(s):
  • stack_set(Option<StackSet>):

    The specified stack set.

• On failure, responds with SdkError<DescribeStackSetError>

impl Client

pub fn describe_stack_set_operation( &self ) -> DescribeStackSetOperationFluentBuilder

Constructs a fluent builder for the DescribeStackSetOperation operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or the unique stack ID of the stack set for the stack operation.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The unique ID of the stack set operation.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DescribeStackSetOperationOutput with field(s):
  • stack_set_operation(Option<StackSetOperation>):

    The specified stack set operation.

• On failure, responds with SdkError<DescribeStackSetOperationError>

impl Client

pub fn describe_stacks(&self) -> DescribeStacksFluentBuilder

Constructs a fluent builder for the DescribeStacks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    If you don’t pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

    Consider using the ListStacks API if you’re not passing a parameter to StackName.

    The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

    { “Version”: “2012-10-17”, “Statement”: [{ “Effect”: “Deny”, “Action”: “cloudformation:DescribeStacks”, “NotResource”: “arn:aws:cloudformation:::stack//” }] }

    The name or the unique stack ID that’s associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of stacks that you want to retrieve.

    
    
• On success, responds with DescribeStacksOutput with field(s):
  • stacks(Option<Vec::<Stack>>):

    A list of stack structures.

  • next_token(Option<String>):

    If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

• On failure, responds with SdkError<DescribeStacksError>

impl Client

pub fn describe_type(&self) -> DescribeTypeFluentBuilder

Constructs a fluent builder for the DescribeType operation.

• The fluent builder is configurable:
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • version_id(impl Into<String>) / set_version_id(Option<String>):
    required: false
    

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

    
    
  • publisher_id(impl Into<String>) / set_publisher_id(Option<String>):
    required: false
    

    The publisher ID of the extension publisher.

    Extensions provided by Amazon Web Services are not assigned a publisher ID.

    
    
  • public_version_number(impl Into<String>) / set_public_version_number(Option<String>):
    required: false
    

    The version number of a public third-party extension.

    
    
• On success, responds with DescribeTypeOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the extension.

  • r#type(Option<RegistryType>):

    The kind of extension.

  • type_name(Option<String>):

    The name of the extension.

    If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.

  • default_version_id(Option<String>):

    The ID of the default version of the extension. The default version is used when the extension version isn’t specified.

    This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

    To set the default version of an extension, use SetTypeDefaultVersion.

  • is_default_version(Option<bool>):

    Whether the specified extension version is set as the default version.

    This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null.

  • type_tests_status(Option<TypeTestsStatus>):

    The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId.

    This applies only to registered private extension versions. CloudFormation doesn’t return this information for public extensions, whether they are activated in your account.

    • PASSED: The extension has passed all its contract tests.

      An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.

    • FAILED: The extension has failed one or more contract tests.

    • IN_PROGRESS: Contract tests are currently being performed on the extension.

    • NOT_TESTED: Contract tests haven’t been performed on the extension.

  • type_tests_status_description(Option<String>):

    The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId.

    This applies only to registered private extension versions. CloudFormation doesn’t return this information for public extensions, whether they are activated in your account.

  • description(Option<String>):

    The description of the extension.

  • schema(Option<String>):

    The schema that defines the extension.

    For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

  • provisioning_type(Option<ProvisioningType>):

    For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

    Valid values include:

    • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

    • IMMUTABLE: The resource type doesn’t include an update handler, so the type can’t be updated and must instead be replaced during stack update operations.

    • NON_PROVISIONABLE: The resource type doesn’t include all the following handlers, and therefore can’t actually be provisioned.

      • create

      • read

      • delete

  • deprecated_status(Option<DeprecatedStatus>):

    The deprecation status of the extension version.

    Valid values include:

    • LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

    • DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.

    For public third-party extensions, CloudFormation returns null.

  • logging_config(Option<LoggingConfig>):

    Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.

  • required_activated_types(Option<Vec::<RequiredActivatedType>>):

    For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.

  • execution_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.

    If the registered extension calls any Amazon Web Services APIs, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

  • visibility(Option<Visibility>):

    The scope at which the extension is visible and usable in CloudFormation operations.

    Valid values include:

    • PRIVATE: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as PRIVATE.

    • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

  • source_url(Option<String>):

    The URL of the source code for the extension.

  • documentation_url(Option<String>):

    The URL of a page providing detailed documentation for this extension.

  • last_updated(Option<DateTime>):

    When the specified extension version was registered. This applies only to:

    • Private extensions you have registered in your account. For more information, see RegisterType.

    • Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.

  • time_created(Option<DateTime>):

    When the specified private extension version was registered or activated in your account.

  • configuration_schema(Option<String>):

    A JSON string that represent the current configuration data for the extension in this account and Region.

    To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

  • publisher_id(Option<String>):

    The publisher ID of the extension publisher.

    This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null.

  • original_type_name(Option<String>):

    For public extensions that have been activated for this account and Region, the type name of the public extension.

    If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension’s type name within the account and Region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.

  • original_type_arn(Option<String>):

    For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

  • public_version_number(Option<String>):

    The version number of a public third-party extension.

    This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.

  • latest_public_version(Option<String>):

    The latest version of a public extension that is available for use.

    This only applies if you specify a public extension, and you don’t specify a version. For all other requests, CloudFormation returns null.

  • is_activated(Option<bool>):

    Whether the extension is activated in the account and Region.

    This only applies to public third-party extensions. For all other extensions, CloudFormation returns null.

  • auto_update(Option<bool>):

    Whether CloudFormation automatically updates the extension in this account and Region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.

• On failure, responds with SdkError<DescribeTypeError>

impl Client

pub fn describe_type_registration( &self ) -> DescribeTypeRegistrationFluentBuilder

Constructs a fluent builder for the DescribeTypeRegistration operation.

• The fluent builder is configurable:
  • registration_token(impl Into<String>) / set_registration_token(Option<String>):
    required: true
    

    The identifier for this registration request.

    This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

    
    
• On success, responds with DescribeTypeRegistrationOutput with field(s):
  • progress_status(Option<RegistrationStatus>):

    The current status of the extension registration request.

  • description(Option<String>):

    The description of the extension registration request.

  • type_arn(Option<String>):

    The Amazon Resource Name (ARN) of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

  • type_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of this specific version of the extension being registered.

    For registration requests with a ProgressStatus of other than COMPLETE, this will be null.

• On failure, responds with SdkError<DescribeTypeRegistrationError>

impl Client

pub fn detect_stack_drift(&self) -> DetectStackDriftFluentBuilder

Constructs a fluent builder for the DetectStackDrift operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack for which you want to detect drift.

    
    
  • logical_resource_ids(impl Into<String>) / set_logical_resource_ids(Option<Vec::<String>>):
    required: false
    

    The logical names of any resources you want to use as filters.

    
    
• On success, responds with DetectStackDriftOutput with field(s):
  • stack_drift_detection_id(Option<String>):

    The ID of the drift detection results of this operation.

    CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

• On failure, responds with SdkError<DetectStackDriftError>

impl Client

pub fn detect_stack_resource_drift( &self ) -> DetectStackResourceDriftFluentBuilder

Constructs a fluent builder for the DetectStackResourceDrift operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name of the stack to which the resource belongs.

    
    
  • logical_resource_id(impl Into<String>) / set_logical_resource_id(Option<String>):
    required: true
    

    The logical name of the resource for which to return drift information.

    
    
• On success, responds with DetectStackResourceDriftOutput with field(s):
  • stack_resource_drift(Option<StackResourceDrift>):

    Information about whether the resource’s actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

• On failure, responds with SdkError<DetectStackResourceDriftError>

impl Client

pub fn detect_stack_set_drift(&self) -> DetectStackSetDriftFluentBuilder

Constructs a fluent builder for the DetectStackSetDrift operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name of the stack set on which to perform the drift detection operation.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    The user-specified preferences for how CloudFormation performs a stack set operation.

    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    The ID of the stack set operation.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with DetectStackSetDriftOutput with field(s):
  • operation_id(Option<String>):

    The ID of the drift detection stack set operation.

    You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.

• On failure, responds with SdkError<DetectStackSetDriftError>

impl Client

pub fn estimate_template_cost(&self) -> EstimateTemplateCostFluentBuilder

Constructs a fluent builder for the EstimateTemplateCost operation.

• The fluent builder is configurable:
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    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 pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    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. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    A list of Parameter structures that specify input parameters.

    
    
• On success, responds with EstimateTemplateCostOutput with field(s):
  • url(Option<String>):

    An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

• On failure, responds with SdkError<EstimateTemplateCostError>

impl Client

pub fn execute_change_set(&self) -> ExecuteChangeSetFluentBuilder

Constructs a fluent builder for the ExecuteChangeSet operation.

• The fluent builder is configurable:
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that’s associated with the change set you want to execute.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

    
    
  • disable_rollback(bool) / set_disable_rollback(Option<bool>):
    required: false
    

    Preserves the state of previously provisioned resources when an operation fails. This parameter can’t be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

    • True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

    • False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

    Default: True

    
    
  • retain_except_on_create(bool) / set_retain_except_on_create(Option<bool>):
    required: false
    

    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

    
    
• On success, responds with ExecuteChangeSetOutput
• On failure, responds with SdkError<ExecuteChangeSetError>

impl Client

pub fn get_generated_template(&self) -> GetGeneratedTemplateFluentBuilder

Constructs a fluent builder for the GetGeneratedTemplate operation.

• The fluent builder is configurable:
  • format(TemplateFormat) / set_format(Option<TemplateFormat>):
    required: false
    

    The language to use to retrieve for the generated template. Supported values are:

    • JSON

    • YAML

    
    
  • generated_template_name(impl Into<String>) / set_generated_template_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

    
    
• On success, responds with GetGeneratedTemplateOutput with field(s):
  • status(Option<GeneratedTemplateStatus>):

    The status of the template generation. Supported values are:

    • CreatePending - the creation of the template is pending.

    • CreateInProgress - the creation of the template is in progress.

    • DeletePending - the deletion of the template is pending.

    • DeleteInProgress - the deletion of the template is in progress.

    • UpdatePending - the update of the template is pending.

    • UpdateInProgress - the update of the template is in progress.

    • Failed - the template operation failed.

    • Complete - the template operation is complete.

  • template_body(Option<String>):

    The template body of the generated template, in the language specified by the Language parameter.

• On failure, responds with SdkError<GetGeneratedTemplateError>

impl Client

pub fn get_stack_policy(&self) -> GetStackPolicyFluentBuilder

Constructs a fluent builder for the GetStackPolicy operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or unique stack ID that’s associated with the stack whose policy you want to get.

    
    
• On success, responds with GetStackPolicyOutput with field(s):
  • 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.)

• On failure, responds with SdkError<GetStackPolicyError>

impl Client

pub fn get_template(&self) -> GetTemplateFluentBuilder

Constructs a fluent builder for the GetTemplate operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    The name or the unique stack ID that’s associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    
    
  • change_set_name(impl Into<String>) / set_change_set_name(Option<String>):
    required: false
    

    The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

    
    
  • template_stage(TemplateStage) / set_template_stage(Option<TemplateStage>):
    required: false
    

    For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

    If the template doesn’t include transforms, Original and Processed return the same template. By default, CloudFormation specifies Processed.

    
    
• On success, responds with GetTemplateOutput with field(s):
  • template_body(Option<String>):

    Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

    CloudFormation returns the same template that was used when the stack was created.

  • stages_available(Option<Vec::<TemplateStage>>):

    The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

• On failure, responds with SdkError<GetTemplateError>

impl Client

pub fn get_template_summary(&self) -> GetTemplateSummaryFluentBuilder

Constructs a fluent builder for the GetTemplateSummary operation.

• The fluent builder is configurable:
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    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 about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: false
    

    The name or the stack ID that’s associated with the stack, which aren’t always interchangeable. For running stacks, you can specify either the stack’s name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    
    
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: false
    

    The name or unique ID of the stack set from which the stack was created.

    Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
  • template_summary_config(TemplateSummaryConfig) / set_template_summary_config(Option<TemplateSummaryConfig>):
    required: false
    

    Specifies options for the GetTemplateSummary API action.

    
    
• On success, responds with GetTemplateSummaryOutput with field(s):
  • parameters(Option<Vec::<ParameterDeclaration>>):

    A list of parameter declarations that describe various properties for each parameter.

  • description(Option<String>):

    The value that’s defined in the Description property of the template.

  • capabilities(Option<Vec::<Capability>>):

    The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • capabilities_reason(Option<String>):

    The list of resources that generated the values in the Capabilities response element.

  • resource_types(Option<Vec::<String>>):

    A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

  • version(Option<String>):

    The Amazon Web Services template format version, which identifies the capabilities of the template.

  • metadata(Option<String>):

    The value that’s defined for the Metadata property of the template.

  • declared_transforms(Option<Vec::<String>>):

    A list of the transforms that are declared in the template.

  • resource_identifier_summaries(Option<Vec::<ResourceIdentifierSummary>>):

    A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

  • warnings(Option<Warnings>):

    An object containing any warnings returned.

• On failure, responds with SdkError<GetTemplateSummaryError>

impl Client

pub fn import_stacks_to_stack_set(&self) -> ImportStacksToStackSetFluentBuilder

Constructs a fluent builder for the ImportStacksToStackSet operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name of the stack set. The name must be unique in the Region where you create your stack set.

    
    
  • stack_ids(impl Into<String>) / set_stack_ids(Option<Vec::<String>>):
    required: false
    

    The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a time.

    Specify either StackIds or StackIdsUrl.

    
    
  • stack_ids_url(impl Into<String>) / set_stack_ids_url(Option<String>):
    required: false
    

    The Amazon S3 URL which contains list of stack ids to be inputted.

    Specify either StackIds or StackIdsUrl.

    
    
  • organizational_unit_ids(impl Into<String>) / set_organizational_unit_ids(Option<Vec::<String>>):
    required: false
    

    The list of OU ID’s to which the stacks being imported has to be mapped as deployment target.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    The user-specified preferences for how CloudFormation performs a stack set operation.

    For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    A unique, user defined, identifier for the stack set operation.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • For service managed stack sets, specify DELEGATED_ADMIN.

    
    
• On success, responds with ImportStacksToStackSetOutput with field(s):
  • operation_id(Option<String>):

    The unique identifier for the stack set operation.

• On failure, responds with SdkError<ImportStacksToStackSetError>

impl Client

pub fn list_change_sets(&self) -> ListChangeSetsFluentBuilder

Constructs a fluent builder for the ListChangeSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

    
    
• On success, responds with ListChangeSetsOutput with field(s):
  • summaries(Option<Vec::<ChangeSetSummary>>):

    A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

  • next_token(Option<String>):

    If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

• On failure, responds with SdkError<ListChangeSetsError>

impl Client

pub fn list_exports(&self) -> ListExportsFluentBuilder

Constructs a fluent builder for the ListExports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

    
    
• On success, responds with ListExportsOutput with field(s):
  • exports(Option<Vec::<Export>>):

    The output for the ListExports action.

  • next_token(Option<String>):

    If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

• On failure, responds with SdkError<ListExportsError>

impl Client

pub fn list_generated_templates(&self) -> ListGeneratedTemplatesFluentBuilder

Constructs a fluent builder for the ListGeneratedTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of resource scan results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.

    
    
• On success, responds with ListGeneratedTemplatesOutput with field(s):
  • summaries(Option<Vec::<TemplateSummary>>):

    A list of summaries of the generated templates.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

• On failure, responds with SdkError<ListGeneratedTemplatesError>

impl Client

pub fn list_imports(&self) -> ListImportsFluentBuilder

Constructs a fluent builder for the ListImports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • export_name(impl Into<String>) / set_export_name(Option<String>):
    required: true
    

    The name of the exported output value. CloudFormation returns the stack names that are importing this value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

    
    
• On success, responds with ListImportsOutput with field(s):
  • imports(Option<Vec::<String>>):

    A list of stack names that are importing the specified exported output value.

  • next_token(Option<String>):

    A string that identifies the next page of exports. If there is no additional page, this value is null.

• On failure, responds with SdkError<ListImportsError>

impl Client

pub fn list_resource_scan_related_resources( &self ) -> ListResourceScanRelatedResourcesFluentBuilder

Constructs a fluent builder for the ListResourceScanRelatedResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_scan_id(impl Into<String>) / set_resource_scan_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource scan.

    
    
  • resources(ScannedResourceIdentifier) / set_resources(Option<Vec::<ScannedResourceIdentifier>>):
    required: true
    

    The list of resources for which you want to get the related resources. Up to 100 resources can be provided.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of resource scan results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum value is 100.

    
    
• On success, responds with ListResourceScanRelatedResourcesOutput with field(s):
  • related_resources(Option<Vec::<ScannedResource>>):

    List of up to MaxResults resources in the specified resource scan related to the specified resources.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

• On failure, responds with SdkError<ListResourceScanRelatedResourcesError>

impl Client

pub fn list_resource_scan_resources( &self ) -> ListResourceScanResourcesFluentBuilder

Constructs a fluent builder for the ListResourceScanResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_scan_id(impl Into<String>) / set_resource_scan_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource scan.

    
    
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: false
    

    If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).

    
    
  • resource_type_prefix(impl Into<String>) / set_resource_type_prefix(Option<String>):
    required: false
    

    If specified, the returned resources will be of any of the resource types with the specified prefix.

    
    
  • tag_key(impl Into<String>) / set_tag_key(Option<String>):
    required: false
    

    If specified, the returned resources will have a matching tag key.

    
    
  • tag_value(impl Into<String>) / set_tag_value(Option<String>):
    required: false
    

    If specified, the returned resources will have a matching tag value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of resource scan results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.

    
    
• On success, responds with ListResourceScanResourcesOutput with field(s):
  • resources(Option<Vec::<ScannedResource>>):

    List of up to MaxResults resources in the specified resource scan that match all of the specified filters.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

• On failure, responds with SdkError<ListResourceScanResourcesError>

impl Client

pub fn list_resource_scans(&self) -> ListResourceScansFluentBuilder

Constructs a fluent builder for the ListResourceScans operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of resource scan results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.

    
    
• On success, responds with ListResourceScansOutput with field(s):
  • resource_scan_summaries(Option<Vec::<ResourceScanSummary>>):

    The list of scans returned.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

• On failure, responds with SdkError<ListResourceScansError>

impl Client

pub fn list_stack_instance_resource_drifts( &self ) -> ListStackInstanceResourceDriftsFluentBuilder

Constructs a fluent builder for the ListStackInstanceResourceDrifts operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to list drifted resources for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • stack_instance_resource_drift_statuses(StackResourceDriftStatus) / set_stack_instance_resource_drift_statuses(Option<Vec::<StackResourceDriftStatus>>):
    required: false
    

    The resource drift status of the stack instance.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

    • MODIFIED: One or more resource properties differ from their expected template values.

    • IN_SYNC: The resource’s actual configuration matches its expected template configuration.

    • NOT_CHECKED: CloudFormation doesn’t currently return this value.

    
    
  • stack_instance_account(impl Into<String>) / set_stack_instance_account(Option<String>):
    required: true
    

    The name of the Amazon Web Services account that you want to list resource drifts for.

    
    
  • stack_instance_region(impl Into<String>) / set_stack_instance_region(Option<String>):
    required: true
    

    The name of the Region where you want to list resource drifts.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The unique ID of the drift operation.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with ListStackInstanceResourceDriftsOutput with field(s):
  • summaries(Option<Vec::<StackInstanceResourceDriftsSummary>>):

    A list of StackInstanceResourceDriftSummary structures that contain information about the specified stack instances.

  • next_token(Option<String>):

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

• On failure, responds with SdkError<ListStackInstanceResourceDriftsError>

impl Client

pub fn list_stack_instances(&self) -> ListStackInstancesFluentBuilder

Constructs a fluent builder for the ListStackInstances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to list stack instances for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous request didn’t return all the remaining results, the response’s NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • filters(StackInstanceFilter) / set_filters(Option<Vec::<StackInstanceFilter>>):
    required: false
    

    The filter to apply to stack instances

    
    
  • stack_instance_account(impl Into<String>) / set_stack_instance_account(Option<String>):
    required: false
    

    The name of the Amazon Web Services account that you want to list stack instances for.

    
    
  • stack_instance_region(impl Into<String>) / set_stack_instance_region(Option<String>):
    required: false
    

    The name of the Region where you want to list stack instances.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with ListStackInstancesOutput with field(s):
  • summaries(Option<Vec::<StackInstanceSummary>>):

    A list of StackInstanceSummary structures that contain information about the specified stack instances.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListStackInstancesError>

impl Client

pub fn list_stack_resources(&self) -> ListStackResourcesFluentBuilder

Constructs a fluent builder for the ListStackResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or the unique stack ID that is associated with the stack, which aren’t always interchangeable:

    • Running stacks: You can specify either the stack’s name or its unique stack ID.

    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of stack resources that you want to retrieve.

    
    
• On success, responds with ListStackResourcesOutput with field(s):
  • stack_resource_summaries(Option<Vec::<StackResourceSummary>>):

    A list of StackResourceSummary structures.

  • next_token(Option<String>):

    If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

• On failure, responds with SdkError<ListStackResourcesError>

impl Client

pub fn list_stack_set_auto_deployment_targets( &self ) -> ListStackSetAutoDeploymentTargetsFluentBuilder

Constructs a fluent builder for the ListStackSetAutoDeploymentTargets operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to get automatic deployment targets for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of stack set deployment targets that you want to retrieve.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with ListStackSetAutoDeploymentTargetsOutput with field(s):
  • summaries(Option<Vec::<StackSetAutoDeploymentTargetSummary>>):

    An array of summaries of the deployment targets for the stack set.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

• On failure, responds with SdkError<ListStackSetAutoDeploymentTargetsError>

impl Client

pub fn list_stack_set_operation_results( &self ) -> ListStackSetOperationResultsFluentBuilder

Constructs a fluent builder for the ListStackSetOperationResults operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to get operation results for.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The ID of the stack set operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous request didn’t return all the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
  • filters(OperationResultFilter) / set_filters(Option<Vec::<OperationResultFilter>>):
    required: false
    

    The filter to apply to operation results.

    
    
• On success, responds with ListStackSetOperationResultsOutput with field(s):
  • summaries(Option<Vec::<StackSetOperationResultSummary>>):

    A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Amazon Web Services Regions that are included in the operation.

  • next_token(Option<String>):

    If the request doesn’t return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object’s NextToken parameter. If there are no remaining results, NextToken is set to null.

• On failure, responds with SdkError<ListStackSetOperationResultsError>

impl Client

pub fn list_stack_set_operations(&self) -> ListStackSetOperationsFluentBuilder

Constructs a fluent builder for the ListStackSetOperations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to get operation summaries for.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with ListStackSetOperationsOutput with field(s):
  • summaries(Option<Vec::<StackSetOperationSummary>>):

    A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

  • next_token(Option<String>):

    If the request doesn’t return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object’s NextToken parameter. If there are no remaining results, NextToken is set to null.

• On failure, responds with SdkError<ListStackSetOperationsError>

impl Client

pub fn list_stack_sets(&self) -> ListStackSetsFluentBuilder

Constructs a fluent builder for the ListStackSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • status(StackSetStatus) / set_status(Option<StackSetStatus>):
    required: false
    

    The status of the stack sets that you want to get summary information about.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with ListStackSetsOutput with field(s):
  • summaries(Option<Vec::<StackSetSummary>>):

    A list of StackSetSummary structures that contain information about the user’s stack sets.

  • next_token(Option<String>):

    If the request doesn’t return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListStackSetsError>

impl Client

pub fn list_stacks(&self) -> ListStacksFluentBuilder

Constructs a fluent builder for the ListStacks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A string that identifies the next page of stacks that you want to retrieve.

    
    
  • stack_status_filter(StackStatus) / set_stack_status_filter(Option<Vec::<StackStatus>>):
    required: false
    

    Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

    
    
• On success, responds with ListStacksOutput with field(s):
  • stack_summaries(Option<Vec::<StackSummary>>):

    A list of StackSummary structures containing information about the specified stacks.

  • next_token(Option<String>):

    If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

• On failure, responds with SdkError<ListStacksError>

impl Client

pub fn list_type_registrations(&self) -> ListTypeRegistrationsFluentBuilder

Constructs a fluent builder for the ListTypeRegistrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_arn(impl Into<String>) / set_type_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • registration_status_filter(RegistrationStatus) / set_registration_status_filter(Option<RegistrationStatus>):
    required: false
    

    The current status of the extension registration request.

    The default is IN_PROGRESS.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
• On success, responds with ListTypeRegistrationsOutput with field(s):
  • registration_token_list(Option<Vec::<String>>):

    A list of extension registration tokens.

    Use DescribeTypeRegistration to return detailed information about a type registration request.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListTypeRegistrationsError>

impl Client

pub fn list_type_versions(&self) -> ListTypeVersionsFluentBuilder

Constructs a fluent builder for the ListTypeVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
  • deprecated_status(DeprecatedStatus) / set_deprecated_status(Option<DeprecatedStatus>):
    required: false
    

    The deprecation status of the extension versions that you want to get summary information about.

    Valid values include:

    • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

    • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

    The default is LIVE.

    
    
  • publisher_id(impl Into<String>) / set_publisher_id(Option<String>):
    required: false
    

    The publisher ID of the extension publisher.

    Extensions published by Amazon aren’t assigned a publisher ID.

    
    
• On success, responds with ListTypeVersionsOutput with field(s):
  • type_version_summaries(Option<Vec::<TypeVersionSummary>>):

    A list of TypeVersionSummary structures that contain information about the specified extension’s versions.

  • next_token(Option<String>):

    If the request doesn’t return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListTypeVersionsError>

impl Client

pub fn list_types(&self) -> ListTypesFluentBuilder

Constructs a fluent builder for the ListTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • visibility(Visibility) / set_visibility(Option<Visibility>):
    required: false
    

    The scope at which the extensions are visible and usable in CloudFormation operations.

    Valid values include:

    • PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

      • Private extensions you have registered in this account and Region.

      • Public extensions that you have activated in this account and Region.

    • PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

    The default is PRIVATE.

    
    
  • provisioning_type(ProvisioningType) / set_provisioning_type(Option<ProvisioningType>):
    required: false
    

    For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.

    Valid values include:

    • FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during stack update operations.

    • IMMUTABLE: The resource type doesn’t include an update handler, so the type can’t be updated and must instead be replaced during stack update operations.

    • NON_PROVISIONABLE: The resource type doesn’t include create, read, and delete handlers, and therefore can’t actually be provisioned.

    The default is FULLY_MUTABLE.

    
    
  • deprecated_status(DeprecatedStatus) / set_deprecated_status(Option<DeprecatedStatus>):
    required: false
    

    The deprecation status of the extension that you want to get summary information about.

    Valid values include:

    • LIVE: The extension is registered for use in CloudFormation operations.

    • DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

    
    
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The type of extension.

    
    
  • filters(TypeFilters) / set_filters(Option<TypeFilters>):
    required: false
    

    Filter criteria to use in determining which extensions to return.

    Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the previous paginated request didn’t return all the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

    
    
• On success, responds with ListTypesOutput with field(s):
  • type_summaries(Option<Vec::<TypeSummary>>):

    A list of TypeSummary structures that contain information about the specified extensions.

  • next_token(Option<String>):

    If the request doesn’t return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null.

• On failure, responds with SdkError<ListTypesError>

impl Client

pub fn publish_type(&self) -> PublishTypeFluentBuilder

Constructs a fluent builder for the PublishType operation.

• The fluent builder is configurable:
  • r#type(ThirdPartyType) / set_type(Option<ThirdPartyType>):
    required: false
    

    The type of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • public_version_number(impl Into<String>) / set_public_version_number(Option<String>):
    required: false
    

    The version number to assign to this version of the extension.

    Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

    MAJOR.MINOR.PATCH

    For more information, see Semantic Versioning 2.0.0.

    If you don’t specify a version number, CloudFormation increments the version number by one minor version release.

    You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

    
    
• On success, responds with PublishTypeOutput with field(s):
  • public_type_arn(Option<String>):

    The Amazon Resource Name (ARN) assigned to the public extension upon publication.

• On failure, responds with SdkError<PublishTypeError>

impl Client

pub fn record_handler_progress(&self) -> RecordHandlerProgressFluentBuilder

Constructs a fluent builder for the RecordHandlerProgress operation.

• The fluent builder is configurable:
  • bearer_token(impl Into<String>) / set_bearer_token(Option<String>):
    required: true
    

    Reserved for use by the CloudFormation CLI.

    
    
  • operation_status(OperationStatus) / set_operation_status(Option<OperationStatus>):
    required: true
    

    Reserved for use by the CloudFormation CLI.

    
    
  • current_operation_status(OperationStatus) / set_current_operation_status(Option<OperationStatus>):
    required: false
    

    Reserved for use by the CloudFormation CLI.

    
    
  • status_message(impl Into<String>) / set_status_message(Option<String>):
    required: false
    

    Reserved for use by the CloudFormation CLI.

    
    
  • error_code(HandlerErrorCode) / set_error_code(Option<HandlerErrorCode>):
    required: false
    

    Reserved for use by the CloudFormation CLI.

    
    
  • resource_model(impl Into<String>) / set_resource_model(Option<String>):
    required: false
    

    Reserved for use by the CloudFormation CLI.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Reserved for use by the CloudFormation CLI.

    
    
• On success, responds with RecordHandlerProgressOutput
• On failure, responds with SdkError<RecordHandlerProgressError>

impl Client

pub fn register_publisher(&self) -> RegisterPublisherFluentBuilder

Constructs a fluent builder for the RegisterPublisher operation.

• The fluent builder is configurable:
  • accept_terms_and_conditions(bool) / set_accept_terms_and_conditions(Option<bool>):
    required: false
    

    Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.

    The default is false.

    
    
  • connection_arn(impl Into<String>) / set_connection_arn(Option<String>):
    required: false
    

    If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.

    For more information, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.

    
    
• On success, responds with RegisterPublisherOutput with field(s):
  • publisher_id(Option<String>):

    The ID assigned this account by CloudFormation for publishing extensions.

• On failure, responds with SdkError<RegisterPublisherError>

impl Client

pub fn register_type(&self) -> RegisterTypeFluentBuilder

Constructs a fluent builder for the RegisterType operation.

• The fluent builder is configurable:
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of extension.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: true
    

    The name of the extension being registered.

    We suggest that extension names adhere to the following patterns:

    • For resource types, company_or_organization::service::type.

    • For modules, company_or_organization::service::type::MODULE.

    • For hooks, MyCompany::Testing::MyTestHook.

    The following organization namespaces are reserved and can’t be used in your extension names:

    • Alexa

    • AMZN

    • Amazon

    • AWS

    • Custom

    • Dev

    
    
  • schema_handler_package(impl Into<String>) / set_schema_handler_package(Option<String>):
    required: true
    

    A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

    For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

    The user registering the extension must be able to access the package in the S3 bucket. That’s, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

    
    
  • logging_config(LoggingConfig) / set_logging_config(Option<LoggingConfig>):
    required: false
    

    Specifies logging configuration information for an extension.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

    For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

    If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.

    
    
• On success, responds with RegisterTypeOutput with field(s):
  • registration_token(Option<String>):

    The identifier for this registration request.

    Use this registration token when calling DescribeTypeRegistration, which returns information about the status and IDs of the extension registration.

• On failure, responds with SdkError<RegisterTypeError>

impl Client

pub fn rollback_stack(&self) -> RollbackStackFluentBuilder

Constructs a fluent builder for the RollbackStack operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name that’s associated with the stack.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this RollbackStack request.

    
    
  • retain_except_on_create(bool) / set_retain_except_on_create(Option<bool>):
    required: false
    

    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

    
    
• On success, responds with RollbackStackOutput with field(s):
  • stack_id(Option<String>):

    Unique identifier of the stack.

• On failure, responds with SdkError<RollbackStackError>

impl Client

pub fn set_stack_policy(&self) -> SetStackPolicyFluentBuilder

Constructs a fluent builder for the SetStackPolicy operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or unique stack ID that you want to associate a policy with.

    
    
  • stack_policy_body(impl Into<String>) / set_stack_policy_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_url(Option<String>):
    required: false
    

    Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services 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.

    
    
• On success, responds with SetStackPolicyOutput
• On failure, responds with SdkError<SetStackPolicyError>

impl Client

pub fn set_type_configuration(&self) -> SetTypeConfigurationFluentBuilder

Constructs a fluent builder for the SetTypeConfiguration operation.

• The fluent builder is configurable:
  • type_arn(impl Into<String>) / set_type_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the extension, in this account and Region.

    For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account and Region.

    Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

    
    
  • configuration(impl Into<String>) / set_configuration(Option<String>):
    required: true
    

    The configuration data for the extension, in this account and Region.

    The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

    
    
  • configuration_alias(impl Into<String>) / set_configuration_alias(Option<String>):
    required: false
    

    An alias by which to refer to this extension configuration data.

    Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

    
    
  • r#type(ThirdPartyType) / set_type(Option<ThirdPartyType>):
    required: false
    

    The type of extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

    
    
• On success, responds with SetTypeConfigurationOutput with field(s):
  • configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

• On failure, responds with SdkError<SetTypeConfigurationError>

impl Client

pub fn set_type_default_version(&self) -> SetTypeDefaultVersionFluentBuilder

Constructs a fluent builder for the SetTypeDefaultVersion operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension for which you want version summary information.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • r#type(RegistryType) / set_type(Option<RegistryType>):
    required: false
    

    The kind of extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension.

    Conditional: You must specify either TypeName and Type, or Arn.

    
    
  • version_id(impl Into<String>) / set_version_id(Option<String>):
    required: false
    

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

    
    
• On success, responds with SetTypeDefaultVersionOutput
• On failure, responds with SdkError<SetTypeDefaultVersionError>

impl Client

pub fn signal_resource(&self) -> SignalResourceFluentBuilder

Constructs a fluent builder for the SignalResource operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The stack name or unique stack ID that includes the resource that you want to signal.

    
    
  • logical_resource_id(impl Into<String>) / set_logical_resource_id(Option<String>):
    required: true
    

    The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

    
    
  • unique_id(impl Into<String>) / set_unique_id(Option<String>):
    required: true
    

    A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

    
    
  • status(ResourceSignalStatus) / set_status(Option<ResourceSignalStatus>):
    required: true
    

    The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

    
    
• On success, responds with SignalResourceOutput
• On failure, responds with SdkError<SignalResourceError>

impl Client

pub fn start_resource_scan(&self) -> StartResourceScanFluentBuilder

Constructs a fluent builder for the StartResourceScan operation.

• The fluent builder is configurable:
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to start a new resource scan.

    
    
• On success, responds with StartResourceScanOutput with field(s):
  • resource_scan_id(Option<String>):

    The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

• On failure, responds with SdkError<StartResourceScanError>

impl Client

pub fn stop_stack_set_operation(&self) -> StopStackSetOperationFluentBuilder

Constructs a fluent builder for the StopStackSetOperation operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to stop the operation for.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: true
    

    The ID of the stack operation.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with StopStackSetOperationOutput
• On failure, responds with SdkError<StopStackSetOperationError>

impl Client

pub fn test_type(&self) -> TestTypeFluentBuilder

Constructs a fluent builder for the TestType operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • r#type(ThirdPartyType) / set_type(Option<ThirdPartyType>):
    required: false
    

    The type of the extension to test.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • type_name(impl Into<String>) / set_type_name(Option<String>):
    required: false
    

    The name of the extension to test.

    Conditional: You must specify Arn, or TypeName and Type.

    
    
  • version_id(impl Into<String>) / set_version_id(Option<String>):
    required: false
    

    The version of the extension to test.

    You can specify the version id with either Arn, or with TypeName and Type.

    If you don’t specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.

    
    
  • log_delivery_bucket(impl Into<String>) / set_log_delivery_bucket(Option<String>):
    required: false
    

    The S3 bucket to which CloudFormation delivers the contract test execution logs.

    CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

    The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

    • GetObject

    • PutObject

    For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

    
    
• On success, responds with TestTypeOutput with field(s):
  • type_version_arn(Option<String>):

    The Amazon Resource Name (ARN) of the extension.

• On failure, responds with SdkError<TestTypeError>

impl Client

pub fn update_generated_template(&self) -> UpdateGeneratedTemplateFluentBuilder

Constructs a fluent builder for the UpdateGeneratedTemplate operation.

• The fluent builder is configurable:
  • generated_template_name(impl Into<String>) / set_generated_template_name(Option<String>):
    required: true
    

    The name or Amazon Resource Name (ARN) of a generated template.

    
    
  • new_generated_template_name(impl Into<String>) / set_new_generated_template_name(Option<String>):
    required: false
    

    An optional new name to assign to the generated template.

    
    
  • add_resources(ResourceDefinition) / set_add_resources(Option<Vec::<ResourceDefinition>>):
    required: false
    

    An optional list of resources to be added to the generated template.

    
    
  • remove_resources(impl Into<String>) / set_remove_resources(Option<Vec::<String>>):
    required: false
    

    A list of logical ids for resources to remove from the generated template.

    
    
  • refresh_all_resources(bool) / set_refresh_all_resources(Option<bool>):
    required: false
    

    If true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.

    
    
  • template_configuration(TemplateConfiguration) / set_template_configuration(Option<TemplateConfiguration>):
    required: false
    

    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.

    
    
• On success, responds with UpdateGeneratedTemplateOutput with field(s):
  • generated_template_id(Option<String>):

    The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example, arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc .

• On failure, responds with SdkError<UpdateGeneratedTemplateError>

impl Client

pub fn update_stack(&self) -> UpdateStackFluentBuilder

Constructs a fluent builder for the UpdateStack operation.

• The fluent builder is configurable:
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

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

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    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. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

    
    
  • use_previous_template(bool) / set_use_previous_template(Option<bool>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_during_update_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_during_update_url(Option<String>):
    required: false
    

    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. The location for an Amazon S3 bucket must start with https://. 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(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

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

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: false
    

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.

    • CAPABILITY_IAM and CAPABILITY_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 or CAPABILITY_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.

      • AWS::IAM::AccessKey

      • AWS::IAM::Group

      • AWS::IAM::InstanceProfile

      • AWS::IAM::Policy

      • AWS::IAM::Role

      • AWS::IAM::User

      • AWS::IAM::UserToGroupAddition

      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.

    Only one of the Capabilities and ResourceType parameters can be specified.

    
    
  • resource_types(impl Into<String>) / set_resource_types(Option<Vec::<String>>):
    required: false
    

    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.

    Only one of the Capabilities and ResourceType parameters can be specified.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    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(RollbackConfiguration) / set_rollback_configuration(Option<RollbackConfiguration>):
    required: false
    

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

    
    
  • stack_policy_body(impl Into<String>) / set_stack_policy_body(Option<String>):
    required: false
    

    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(impl Into<String>) / set_stack_policy_url(Option<String>):
    required: false
    

    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. The location for an Amazon S3 bucket must start with https://. 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_arns(impl Into<String>) / set_notification_arns(Option<Vec::<String>>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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(bool) / set_disable_rollback(Option<bool>):
    required: false
    

    Preserve the state of previously provisioned resources when an operation fails.

    Default: False

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    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.

    
    
  • retain_except_on_create(bool) / set_retain_except_on_create(Option<bool>):
    required: false
    

    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

    
    
• On success, responds with UpdateStackOutput with field(s):
  • stack_id(Option<String>):

    Unique identifier of the stack.

• On failure, responds with SdkError<UpdateStackError>

impl Client

pub fn update_stack_instances(&self) -> UpdateStackInstancesFluentBuilder

Constructs a fluent builder for the UpdateStackInstances operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set associated with the stack instances.

    
    
  • accounts(impl Into<String>) / set_accounts(Option<Vec::<String>>):
    required: false
    

    [Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • deployment_targets(DeploymentTargets) / set_deployment_targets(Option<DeploymentTargets>):
    required: false
    

    [Service-managed permissions] The Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won’t use the overridden values.

    You can specify Accounts or DeploymentTargets, but not both.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: true
    

    The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.

    
    
  • parameter_overrides(Parameter) / set_parameter_overrides(Option<Vec::<Parameter>>):
    required: false
    

    A list of input parameters whose values you want to update for the specified stack instances.

    Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:

    • To override the current value for a parameter, include the parameter and specify its value.

    • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can’t specify both a value and set UsePreviousValue to true.)

    • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don’t include the parameter in the list.

    • To leave all parameters set to their present values, don’t specify this property at all.

    During stack set updates, any parameter values overridden for a stack instance aren’t updated, but retain their overridden value.

    You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    Preferences for how CloudFormation performs this stack set operation.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    The unique identifier for this stack set operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

    If you don’t specify an operation ID, the SDK generates one automatically.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
• On success, responds with UpdateStackInstancesOutput with field(s):
  • operation_id(Option<String>):

    The unique identifier for this stack set operation.

• On failure, responds with SdkError<UpdateStackInstancesError>

impl Client

pub fn update_stack_set(&self) -> UpdateStackSetFluentBuilder

Constructs a fluent builder for the UpdateStackSet operation.

• The fluent builder is configurable:
  • stack_set_name(impl Into<String>) / set_stack_set_name(Option<String>):
    required: true
    

    The name or unique ID of the stack set that you want to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of updates that you are making.

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the CloudFormation User Guide.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see Template Anatomy in the CloudFormation User Guide.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    
    
  • use_previous_template(bool) / set_use_previous_template(Option<bool>):
    required: false
    

    Use the existing template that’s associated with the stack set that you’re updating.

    Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

    
    
  • parameters(Parameter) / set_parameters(Option<Vec::<Parameter>>):
    required: false
    

    A list of input parameters for the stack set template.

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: false
    

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.

    • CAPABILITY_IAM and CAPABILITY_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 sets, you must explicitly acknowledge this by specifying one of these capabilities.

      The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_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.

      • AWS::IAM::AccessKey

      • AWS::IAM::Group

      • AWS::IAM::InstanceProfile

      • AWS::IAM::Policy

      • AWS::IAM::Role

      • AWS::IAM::User

      • AWS::IAM::UserToGroupAddition

      For more information, see Acknowledging IAM Resources in CloudFormation Templates.

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

      Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

    If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

    • If you don’t specify this parameter, CloudFormation doesn’t modify the stack’s tags.

    • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you’ve specified before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don’t include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

    • If you specify an empty value, CloudFormation removes all currently associated tags.

    If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don’t have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

    
    
  • operation_preferences(StackSetOperationPreferences) / set_operation_preferences(Option<StackSetOperationPreferences>):
    required: false
    

    Preferences for how CloudFormation performs this stack set operation.

    
    
  • administration_role_arn(impl Into<String>) / set_administration_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the CloudFormation User Guide.

    If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

    
    
  • execution_role_name(impl Into<String>) / set_execution_role_name(Option<String>):
    required: false
    

    The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

    Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

    If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

    
    
  • deployment_targets(DeploymentTargets) / set_deployment_targets(Option<DeploymentTargets>):
    required: false
    

    [Service-managed permissions] The Organizations accounts in which to update associated stack instances.

    To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions.

    If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn’t include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    
    
  • permission_model(PermissionModels) / set_permission_model(Option<PermissionModels>):
    required: false
    

    Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

    • With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions.

    • With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Grant Service-Managed Stack Set Permissions.

    
    
  • auto_deployment(AutoDeployment) / set_auto_deployment(Option<AutoDeployment>):
    required: false
    

    [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

    If you specify AutoDeployment, don’t specify DeploymentTargets or Regions.

    
    
  • operation_id(impl Into<String>) / set_operation_id(Option<String>):
    required: false
    

    The unique ID for this stack set operation.

    The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

    If you don’t specify an operation ID, CloudFormation generates one automatically.

    Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

    
    
  • accounts(impl Into<String>) / set_accounts(Option<Vec::<String>>):
    required: false
    

    [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set instances.

    To update all the stack instances associated with this stack set, don’t specify the Accounts or Regions properties.

    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack instances with their existing stack instance status.

    
    
  • regions(impl Into<String>) / set_regions(Option<Vec::<String>>):
    required: false
    

    The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.

    To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

    If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.

    
    
  • call_as(CallAs) / set_call_as(Option<CallAs>):
    required: false
    

    [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization’s management account or as a delegated administrator in a member account.

    By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

    • If you are signed in to the management account, specify SELF.

    • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

      Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

    
    
  • managed_execution(ManagedExecution) / set_managed_execution(Option<ManagedExecution>):
    required: false
    

    Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

    
    
• On success, responds with UpdateStackSetOutput with field(s):
  • operation_id(Option<String>):

    The unique ID for this stack set operation.

• On failure, responds with SdkError<UpdateStackSetError>

impl Client

pub fn update_termination_protection( &self ) -> UpdateTerminationProtectionFluentBuilder

Constructs a fluent builder for the UpdateTerminationProtection operation.

• The fluent builder is configurable:
  • enable_termination_protection(bool) / set_enable_termination_protection(Option<bool>):
    required: true
    

    Whether to enable termination protection on the specified stack.

    
    
  • stack_name(impl Into<String>) / set_stack_name(Option<String>):
    required: true
    

    The name or unique ID of the stack for which you want to set termination protection.

    
    
• On success, responds with UpdateTerminationProtectionOutput with field(s):
  • stack_id(Option<String>):

    The unique ID of the stack.

• On failure, responds with SdkError<UpdateTerminationProtectionError>

impl Client

pub fn validate_template(&self) -> ValidateTemplateFluentBuilder

Constructs a fluent builder for the ValidateTemplate operation.

• The fluent builder is configurable:
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: false
    

    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 pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    
    
  • template_url(impl Into<String>) / set_template_url(Option<String>):
    required: false
    

    Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

    Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.

    
    
• On success, responds with ValidateTemplateOutput with field(s):
  • parameters(Option<Vec::<TemplateParameter>>):

    A list of TemplateParameter structures.

  • description(Option<String>):

    The description found within the template.

  • capabilities(Option<Vec::<Capability>>):

    The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

    For more information, see Acknowledging IAM Resources in CloudFormation Templates.

  • capabilities_reason(Option<String>):

    The list of resources that generated the values in the Capabilities response element.

  • declared_transforms(Option<Vec::<String>>):

    A list of the transforms that are declared in the template.

• On failure, responds with SdkError<ValidateTemplateError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_change_set_create_complete( &self ) -> ChangeSetCreateCompleteFluentBuilder

Wait until change set status is CREATE_COMPLETE.

fn wait_until_stack_create_complete(&self) -> StackCreateCompleteFluentBuilder

Wait until stack status is CREATE_COMPLETE.

fn wait_until_stack_delete_complete(&self) -> StackDeleteCompleteFluentBuilder

Wait until stack status is DELETE_COMPLETE.

fn wait_until_stack_exists(&self) -> StackExistsFluentBuilder

Wait for stack_exists

fn wait_until_stack_import_complete(&self) -> StackImportCompleteFluentBuilder

Wait until stack status is IMPORT_COMPLETE.

fn wait_until_stack_rollback_complete( &self ) -> StackRollbackCompleteFluentBuilder

Wait until stack status is UPDATE_ROLLBACK_COMPLETE.

fn wait_until_stack_update_complete(&self) -> StackUpdateCompleteFluentBuilder

Wait until stack status is UPDATE_COMPLETE.

fn wait_until_type_registration_complete( &self ) -> TypeRegistrationCompleteFluentBuilder

Wait until type registration is COMPLETE.