Struct aws_sdk_cloudformation::client::Client

source · [−]
pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_cloudformation::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_cloudformation::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_cloudformation::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the ActivateType operation.

Constructs a fluent builder for the BatchDescribeTypeConfigurations operation.

Constructs a fluent builder for the CancelUpdateStack operation.

Constructs a fluent builder for the ContinueUpdateRollback operation.

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

      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>):

      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. As long as 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.

    • resources_to_skip(Vec<String>) / set_resources_to_skip(Option<Vec<String>>):

      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 cancelled. 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>):

      A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that CloudFormationknows 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>

Constructs a fluent builder for the CreateChangeSet operation.

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

      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>):

      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>):

      The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified.

      Conditional: You must specify only TemplateBody or TemplateURL.

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

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

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

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

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

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

      • CAPABILITY_IAM 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.

        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 does not 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 on macros, see Using CloudFormation Macros to Perform Custom Processing on Templates.

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

      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.

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

      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. As long as 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>):

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

    • notification_ar_ns(Vec<String>) / set_notification_ar_ns(Option<Vec<String>>):

      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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      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>):

      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 alphabetic character and cannot exceed 128 characters.

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

      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>):

      A description to help you identify this change set.

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

      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(Vec<ResourceToImport>) / set_resources_to_import(Option<Vec<ResourceToImport>>):

      The resources to import into your stack.

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

      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 success, responds with CreateChangeSetOutput with field(s):
  • On failure, responds with SdkError<CreateChangeSetError>

Constructs a fluent builder for the CreateStack operation.

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

      The name that is 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 cannot be longer than 128 characters.

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

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the CloudFormation User Guide.

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

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

      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 the Template Anatomy in the CloudFormation User Guide.

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

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

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

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

      Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both.

      Default: false

    • rollback_configuration(RollbackConfiguration) / 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.

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

      The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.

    • notification_ar_ns(Vec<String>) / set_notification_ar_ns(Option<Vec<String>>):

      The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).

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

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

      • CAPABILITY_IAM 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.

        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.

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

      The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS:: (for all Amazon Web Services resources), Custom:: (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name:: (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID (for a specific Amazon Web Services resource).

      If the list of resource types doesn’t include a resource that you’re creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

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

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role’s credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as 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.

    • on_failure(OnFailure) / set_on_failure(Option<OnFailure>):

      Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both.

      Default: ROLLBACK

    • stack_policy_body(impl Into<String>) / set_stack_policy_body(Option<String>):

      Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

    • stack_policy_url(impl Into<String>) / set_stack_policy_url(Option<String>):

      Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

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

      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>):

      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 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.

    • enable_termination_protection(bool) / set_enable_termination_protection(Option<bool>):

      Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide. Termination protection is disabled on stacks by default.

      For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

  • On success, responds with CreateStackOutput with field(s):
  • On failure, responds with SdkError<CreateStackError>

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>):

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

    • accounts(Vec<String>) / set_accounts(Option<Vec<String>>):

      [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>):

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

      You can specify Accounts or DeploymentTargets, but not both.

    • regions(Vec<String>) / set_regions(Option<Vec<String>>):

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

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

      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 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 cannot 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 do not include the parameter in the list.

      • To leave all parameters set to their present values, do not specify this property at all.

      During stack set updates, any parameter values overridden for a stack instance are not 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>):

      Preferences for how CloudFormation performs this stack set operation.

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

      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>):

      [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):
  • On failure, responds with SdkError<CreateStackInstancesError>

Constructs a fluent builder for the CreateStackSet operation.

Constructs a fluent builder for the DeactivateType operation.

Constructs a fluent builder for the DeleteChangeSet operation.

Constructs a fluent builder for the DeleteStack operation.

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

      The name or the unique stack ID that is associated with the stack.

    • retain_resources(Vec<String>) / set_retain_resources(Option<Vec<String>>):

      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 does not delete the retained resources.

      Retaining resources is useful when you cannot 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>):

      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 is generated from your user credentials.

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

      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 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.

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

Constructs a fluent builder for the DeleteStackInstances operation.

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>):

      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>):

      [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>

Constructs a fluent builder for the DeregisterType operation.

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

Constructs a fluent builder for the DescribeChangeSet operation.

Constructs a fluent builder for the DescribePublisher operation.

Constructs a fluent builder for the DescribeStackDriftDetectionStatus operation.

  • The fluent builder is configurable:
  • 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 has not 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 do not 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>

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

Constructs a fluent builder for the DescribeStackInstance operation.

Constructs a fluent builder for the DescribeStackResource operation.

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

Constructs a fluent builder for the DescribeStackResources operation.

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

Constructs a fluent builder for the DescribeStackSet operation.

Constructs a fluent builder for the DescribeStackSetOperation operation.

Constructs a fluent builder for the DescribeType operation.

  • The fluent builder is configurable:
  • 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 is not specified.

      This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon 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. For public third-party extensions, whether or not 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 specifc extension version, you must specify VersionId.

      This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not 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 have not 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 specifc extension version, you must specify VersionId.

      This applies only to registered private extension versions. CloudFormation does not return this information for public extensions, whether or not 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 on 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 does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type does not include all of the following handlers, and therefore cannot 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 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 publically visible and usable within any Amazon 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, 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 do not specify a version. For all other requests, CloudFormation returns null.

    • is_activated(Option<bool>):

      Whether or not 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>

Constructs a fluent builder for the DescribeTypeRegistration operation.

Constructs a fluent builder for the DetectStackDrift operation.

Constructs a fluent builder for the DetectStackResourceDrift operation.

Constructs a fluent builder for the DetectStackSetDrift operation.

Constructs a fluent builder for the EstimateTemplateCost operation.

Constructs a fluent builder for the ExecuteChangeSet operation.

Constructs a fluent builder for the GetStackPolicy operation.

Constructs a fluent builder for the GetTemplate operation.

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

      The name or the unique stack ID that is associated with the stack, which are not 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>):

      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>):

      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>

Constructs a fluent builder for the GetTemplateSummary operation.

Constructs a fluent builder for the ImportStacksToStackSet operation.

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

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

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

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

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

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

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>):

      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>):

      The ID of the stack set operation.

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

      If the previous 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 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>):

      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>):

      [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 ListStackSetOperationResultsOutput with field(s):
    • summaries(Option<Vec<StackSetOperationResultSummary>>):

      A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and 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>

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>):

      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>):

      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>):

      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>):

      [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>

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>):

      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 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>):

      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>):

      The status of the stack sets that you want to get summary information about.

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

      [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>

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

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>):

      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 account. This includes extensions from Amazon, as well as third-party publishers.

      The default is PRIVATE.

    • provisioning_type(ProvisioningType) / set_provisioning_type(Option<ProvisioningType>):

      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 does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.

      • NON_PROVISIONABLE: The resource type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.

      The default is FULLY_MUTABLE.

    • deprecated_status(DeprecatedStatus) / set_deprecated_status(Option<DeprecatedStatus>):

      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>):

      The type of extension.

    • filters(TypeFilters) / set_filters(Option<TypeFilters>):

      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>):

      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>):

      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 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 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<ListTypesError>

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

Constructs a fluent builder for the PublishType operation.

Constructs a fluent builder for the RecordHandlerProgress operation.

Constructs a fluent builder for the RegisterPublisher operation.

Constructs a fluent builder for the RegisterType operation.

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

      The kind of extension.

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

      The name of the extension being registered.

      We recommend that extension names adhere to the following patterns:

      • For resource types, company_or_organization::service::type.

      • For modules, company_or_organization::service::type::MODULE.

      The following organization namespaces are reserved and cannot be used in your extension names:

      • Alexa

      • AMZN

      • Amazon

      • AWS

      • Custom

      • Dev

    • schema_handler_package(impl Into<String>) / set_schema_handler_package(Option<String>):

      A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

      For information on 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 is, 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>):

      Specifies logging configuration information for an extension.

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

      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 principle (resources.cloudformation.amazonaws.com). For more information on 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>):

      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 registeration 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>

Constructs a fluent builder for the RollbackStack operation.

Constructs a fluent builder for the SetStackPolicy operation.

Constructs a fluent builder for the SetTypeConfiguration operation.

Constructs a fluent builder for the SetTypeDefaultVersion operation.

Constructs a fluent builder for the SignalResource operation.

Constructs a fluent builder for the StopStackSetOperation operation.

Constructs a fluent builder for the TestType operation.

Constructs a fluent builder for the UpdateStack operation.

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

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

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

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the CloudFormation User Guide.)

      Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

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

      Location of file containing the template body. The URL must point to a template 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.

      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>):

      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>):

      Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

    • stack_policy_during_update_url(impl Into<String>) / set_stack_policy_during_update_url(Option<String>):

      Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

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

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

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

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

      • CAPABILITY_IAM 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.

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

      • CAPABILITY_AUTO_EXPAND

        Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

        If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

        You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

        Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

        For more information, see Using CloudFormation Macros to Perform Custom Processing on Templates.

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

      The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

      If the list of resource types doesn’t include a resource that you’re updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

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

      The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role’s credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as 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>):

      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>):

      Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

    • stack_policy_url(impl Into<String>) / set_stack_policy_url(Option<String>):

      Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

    • notification_ar_ns(Vec<String>) / set_notification_ar_ns(Option<Vec<String>>):

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

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

      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>):

      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>):

      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.

  • On success, responds with UpdateStackOutput with field(s):
  • On failure, responds with SdkError<UpdateStackError>

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>):

      The name or unique ID of the stack set associated with the stack instances.

    • accounts(Vec<String>) / set_accounts(Option<Vec<String>>):

      [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 Regions.

      You can specify Accounts or DeploymentTargets, but not both.

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

      [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(Vec<String>) / set_regions(Option<Vec<String>>):

      The names of one or more 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 Regions.

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

      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 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 cannot 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 do not include the parameter in the list.

      • To leave all parameters set to their present values, do not specify this property at all.

      During stack set updates, any parameter values overridden for a stack instance are not 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>):

      Preferences for how CloudFormation performs this stack set operation.

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

      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>):

      [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):
  • On failure, responds with SdkError<UpdateStackInstancesError>

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>):

      The name or unique ID of the stack set that you want to update.

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

      A brief description of updates that you are making.

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

      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>):

      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>):

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

      A list of input parameters for the stack set template.

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

      In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack 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.

        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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      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 specifed 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>):

      Preferences for how CloudFormation performs this stack set operation.

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

      The Amazon Resource Number (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>):

      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>):

      [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 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.

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

      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.

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

      [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, do not specify DeploymentTargets or Regions.

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

      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(Vec<String>) / set_accounts(Option<Vec<String>>):

      [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions 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.

    • regions(Vec<String>) / set_regions(Option<Vec<String>>):

      The 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>):

      [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>):

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

  • On success, responds with UpdateStackSetOutput with field(s):
  • On failure, responds with SdkError<UpdateStackSetError>

Constructs a fluent builder for the UpdateTerminationProtection operation.

Constructs a fluent builder for the ValidateTemplate operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more