Class: Aws::CloudFormation::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb

Overview

An API client for CloudFormation. To construct a client, you need to configure a :region and :credentials.

client = Aws::CloudFormation::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CloudFormation::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CloudFormation::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



471
472
473
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#activate_organizations_access(params = {}) ⇒ Struct

Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



487
488
489
490
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 487

def activate_organizations_access(params = {}, options = {})
  req = build_request(:activate_organizations_access, params)
  req.send_request(options)
end

#activate_type(params = {}) ⇒ Types::ActivateTypeOutput

Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.

After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension.

To see which extensions have been activated, use ListTypes. To see configuration details for an extension, use DescribeType.

For more information, see Activate a third-party public extension in your account in the CloudFormation User Guide. For information about creating Hooks, see the CloudFormation Hooks User Guide.

Examples:

Request syntax with placeholder values


resp = client.activate_type({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  public_type_arn: "ThirdPartyTypeArn",
  publisher_id: "PublisherId",
  type_name: "TypeName",
  type_name_alias: "TypeName",
  auto_update: false,
  logging_config: {
    log_role_arn: "RoleArn", # required
    log_group_name: "LogGroupName", # required
  },
  execution_role_arn: "RoleArn",
  version_bump: "MAJOR", # accepts MAJOR, MINOR
  major_version: 1,
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The extension type.

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

  • :public_type_arn (String) —

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

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

  • :publisher_id (String) —

    The ID of the extension publisher.

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

  • :type_name (String) —

    The name of the extension.

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

  • :type_name_alias (String) —

    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 (Boolean) —

    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 (Types::LoggingConfig) —

    Contains logging configuration information for an extension.

  • :execution_role_arn (String) —

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

  • :version_bump (String) —

    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 (Integer) —

    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.

Returns:

See Also:



615
616
617
618
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 615

def activate_type(params = {}, options = {})
  req = build_request(:activate_type, params)
  req.send_request(options)
end

#batch_describe_type_configurations(params = {}) ⇒ Types::BatchDescribeTypeConfigurationsOutput

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_describe_type_configurations({
  type_configuration_identifiers: [ # required
    {
      type_arn: "TypeArn",
      type_configuration_alias: "TypeConfigurationAlias",
      type_configuration_arn: "TypeConfigurationArn",
      type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
      type_name: "TypeName",
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.errors[0].type_configuration_identifier.type_arn #=> String
resp.errors[0].type_configuration_identifier.type_configuration_alias #=> String
resp.errors[0].type_configuration_identifier.type_configuration_arn #=> String
resp.errors[0].type_configuration_identifier.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
resp.errors[0].type_configuration_identifier.type_name #=> String
resp.unprocessed_type_configurations #=> Array
resp.unprocessed_type_configurations[0].type_arn #=> String
resp.unprocessed_type_configurations[0].type_configuration_alias #=> String
resp.unprocessed_type_configurations[0].type_configuration_arn #=> String
resp.unprocessed_type_configurations[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
resp.unprocessed_type_configurations[0].type_name #=> String
resp.type_configurations #=> Array
resp.type_configurations[0].arn #=> String
resp.type_configurations[0].alias #=> String
resp.type_configurations[0].configuration #=> String
resp.type_configurations[0].last_updated #=> Time
resp.type_configurations[0].type_arn #=> String
resp.type_configurations[0].type_name #=> String
resp.type_configurations[0].is_default_configuration #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



683
684
685
686
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 683

def batch_describe_type_configurations(params = {}, options = {})
  req = build_request(:batch_describe_type_configurations, params)
  req.send_request(options)
end

#cancel_update_stack(params = {}) ⇒ Struct

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Examples:

Request syntax with placeholder values


resp = client.cancel_update_stack({
  stack_name: "StackName", # required
  client_request_token: "ClientRequestToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    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 (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



732
733
734
735
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 732

def cancel_update_stack(params = {}, options = {})
  req = build_request(:cancel_update_stack, params)
  req.send_request(options)
end

#continue_update_rollback(params = {}) ⇒ Struct

Continues rolling back a stack from UPDATE_ROLLBACK_FAILED to UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state) and then try to update the stack again.

A stack enters the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, this might occur when a stack attempts to roll back to an old database that was deleted outside of CloudFormation. Because CloudFormation doesn't know the instance was deleted, it assumes the instance still exists and attempts to roll back to it, causing the update rollback to fail.

For more information, see Continue rolling back an update in the CloudFormation User Guide. For information for troubleshooting a failed update rollback, see Update rollback failed.

Examples:

Request syntax with placeholder values


resp = client.continue_update_rollback({
  stack_name: "StackNameOrId", # required
  role_arn: "RoleARN",
  resources_to_skip: ["ResourceToSkip"],
  client_request_token: "ClientRequestToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, 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 (String) —

    The Amazon Resource Name (ARN) of an 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 (Array<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 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 Continue rolling back from failed nested stack updates.

  • :client_request_token (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



852
853
854
855
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 852

def continue_update_rollback(params = {}, options = {})
  req = build_request(:continue_update_rollback, params)
  req.send_request(options)
end

#create_change_set(params = {}) ⇒ Types::CreateChangeSetOutput

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

Examples:

Request syntax with placeholder values


resp = client.create_change_set({
  stack_name: "StackNameOrId", # required
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  use_previous_template: false,
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  notification_arns: ["NotificationARN"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  change_set_name: "ChangeSetName", # required
  client_token: "ClientToken",
  description: "Description",
  change_set_type: "CREATE", # accepts CREATE, UPDATE, IMPORT
  resources_to_import: [
    {
      resource_type: "ResourceType", # required
      logical_resource_id: "LogicalResourceId", # required
      resource_identifier: { # required
        "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
      },
    },
  ],
  include_nested_stacks: false,
  on_stack_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
  import_existing_resources: false,
  deployment_mode: "REVERT_DRIFT", # accepts REVERT_DRIFT
})

Response structure


resp.id #=> String
resp.stack_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, 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 (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 one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

  • :template_url (String) —

    The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) 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://. URLs from S3 static websites are not supported.

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

  • :use_previous_template (Boolean) —

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

    When using templates with the AWS::LanguageExtensions transform, provide the template instead of using UsePreviousTemplate to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.

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

  • :parameters (Array<Types::Parameter>) —

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

  • :capabilities (Array<String>) —

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

    • 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 Perform custom processing on CloudFormation templates with template macros.

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

  • :resource_types (Array<String>) —

    Specifies which resource types you can work with, such as AWS::EC2::Instance 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. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Control CloudFormation access with Identity and Access Management in the CloudFormation User Guide.

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

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an 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 (Types::RollbackConfiguration) —

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

  • :notification_arns (Array<String>) —

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

  • :tags (Array<Types::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 (required, 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 alphabetical character and can't exceed 128 characters.

  • :client_token (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 (String) —

    A description to help you identify this change set.

  • :change_set_type (String) —

    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 (Array<Types::ResourceToImport>) —

    The resources to import into your stack.

  • :include_nested_stacks (Boolean) —

    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 (String) —

    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 (Boolean) —

    Indicates if the change set auto-imports resources that already exist. For more information, see Import Amazon Web Services resources into a CloudFormation stack automatically in the CloudFormation User Guide.

    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 ResourcesToImport parameter instead.

  • :deployment_mode (String) —

    Determines how CloudFormation handles configuration drift during deployment.

    • REVERT_DRIFT – Creates a drift-aware change set that brings actual resource states in line with template definitions. Provides a three-way comparison between actual state, previous deployment state, and desired state.

    ^

    For more information, see Using drift-aware change sets in the CloudFormation User Guide.

Returns:

See Also:



1249
1250
1251
1252
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1249

def create_change_set(params = {}, options = {})
  req = build_request(:create_change_set, params)
  req.send_request(options)
end

#create_generated_template(params = {}) ⇒ Types::CreateGeneratedTemplateOutput

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.

Examples:

Example: To create a generated template


# This example creates a generated template with a resources file.

resp = client.create_generated_template({
  generated_template_name: "JazzyTemplate", 
  resources: [
    {
      resource_identifier: {
        "BucketName" => "jazz-bucket", 
      }, 
      resource_type: "AWS::S3::Bucket", 
    }, 
    {
      resource_identifier: {
        "DhcpOptionsId" => "random-id123", 
      }, 
      resource_type: "AWS::EC2::DHCPOptions", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca", 
}

Request syntax with placeholder values


resp = client.create_generated_template({
  resources: [
    {
      resource_type: "ResourceType", # required
      logical_resource_id: "LogicalResourceId",
      resource_identifier: { # required
        "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
      },
    },
  ],
  generated_template_name: "GeneratedTemplateName", # required
  stack_name: "StackName",
  template_configuration: {
    deletion_policy: "DELETE", # accepts DELETE, RETAIN
    update_replace_policy: "DELETE", # accepts DELETE, RETAIN
  },
})

Response structure


resp.generated_template_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resources (Array<Types::ResourceDefinition>) —

    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 (required, String) —

    The name assigned to the generated template.

  • :stack_name (String) —

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

  • :template_configuration (Types::TemplateConfiguration) —

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

Returns:

See Also:



1337
1338
1339
1340
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1337

def create_generated_template(params = {}, options = {})
  req = build_request(:create_generated_template, params)
  req.send_request(options)
end

#create_stack(params = {}) ⇒ Types::CreateStackOutput

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.

For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_stack({
  stack_name: "StackName", # required
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  disable_rollback: false,
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  timeout_in_minutes: 1,
  notification_arns: ["NotificationARN"],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  on_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_request_token: "ClientRequestToken",
  enable_termination_protection: false,
  retain_except_on_create: false,
})

Response structure


resp.stack_id #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.

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

  • :template_body (String) —

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

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

  • :parameters (Array<Types::Parameter>) —

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

  • :disable_rollback (Boolean) —

    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 (Types::RollbackConfiguration) —

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

  • :timeout_in_minutes (Integer) —

    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 (Array<String>) —

    The 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 (Array<String>) —

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

    • 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 Perform custom processing on CloudFormation templates with template macros.

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

  • :resource_types (Array<String>) —

    Specifies which resource types you can work with, such as AWS::EC2::Instance or Custom::MyCustomInstance.

    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. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control CloudFormation access with Identity and Access Management.

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

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an 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 (String) —

    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.

    Although the default setting is ROLLBACK, there is one exception. This exception occurs when a StackSet attempts to deploy a stack instance and the stack instance fails to create successfully. In this case, the CreateStack call overrides the default setting and sets the value of OnFailure to DELETE.

    Default: ROLLBACK

  • :stack_policy_body (String) —

    Structure that contains the stack policy body. For more information, see 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 (String) —

    Location of a file that contains 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://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

  • :tags (Array<Types::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 (String) —

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

    All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

    In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

  • :enable_termination_protection (Boolean) —

    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 Protect CloudFormation stacks 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 (Boolean) —

    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

Returns:

See Also:



1679
1680
1681
1682
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1679

def create_stack(params = {}, options = {})
  req = build_request(:create_stack, params)
  req.send_request(options)
end

#create_stack_instances(params = {}) ⇒ Types::CreateStackInstancesOutput

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

The maximum number of organizational unit (OUs) supported by a CreateStackInstances operation is 50.

If you need more than 50, consider the following options:

  • Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.

  • Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

Examples:

Request syntax with placeholder values


resp = client.create_stack_instances({
  stack_set_name: "StackSetName", # required
  accounts: ["Account"],
  deployment_targets: {
    accounts: ["Account"],
    accounts_url: "AccountsUrl",
    organizational_unit_ids: ["OrganizationalUnitId"],
    account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
  },
  regions: ["Region"], # required
  parameter_overrides: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :accounts (Array<String>) —

    [Self-managed permissions] The account IDs 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 (Types::DeploymentTargets) —

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

    You can specify Accounts or DeploymentTargets, but not both.

  • :regions (required, Array<String>) —

    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 (Array<Types::Parameter>) —

    A list of StackSet 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 StackSet, 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 StackSet 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 StackSet; to add or delete a parameter itself, use UpdateStackSet to update the StackSet template.

  • :operation_preferences (Types::StackSetOperationPreferences) —

    Preferences for how CloudFormation performs this StackSet operation.

  • :operation_id (String) —

    The unique identifier for this StackSet operation.

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

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

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :call_as (String) —

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

Returns:

See Also:



1848
1849
1850
1851
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1848

def create_stack_instances(params = {}, options = {})
  req = build_request(:create_stack_instances, params)
  req.send_request(options)
end

#create_stack_refactor(params = {}) ⇒ Types::CreateStackRefactorOutput

Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.

Examples:

Request syntax with placeholder values


resp = client.create_stack_refactor({
  description: "Description",
  enable_stack_creation: false,
  resource_mappings: [
    {
      source: { # required
        stack_name: "StackName", # required
        logical_resource_id: "LogicalResourceId", # required
      },
      destination: { # required
        stack_name: "StackName", # required
        logical_resource_id: "LogicalResourceId", # required
      },
    },
  ],
  stack_definitions: [ # required
    {
      stack_name: "StackName",
      template_body: "TemplateBody",
      template_url: "TemplateURL",
    },
  ],
})

Response structure


resp.stack_refactor_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    A description to help you identify the stack refactor.

  • :enable_stack_creation (Boolean) —

    Determines if a new stack is created with the refactor.

  • :resource_mappings (Array<Types::ResourceMapping>) —

    The mappings for the stack resource Source and stack resource Destination.

  • :stack_definitions (required, Array<Types::StackDefinition>) —

    The stacks being refactored.

Returns:

See Also:



1907
1908
1909
1910
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 1907

def create_stack_refactor(params = {}, options = {})
  req = build_request(:create_stack_refactor, params)
  req.send_request(options)
end

#create_stack_set(params = {}) ⇒ Types::CreateStackSetOutput

Creates a StackSet.

Examples:

Request syntax with placeholder values


resp = client.create_stack_set({
  stack_set_name: "StackSetName", # required
  description: "Description",
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  stack_id: "StackId",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  administration_role_arn: "RoleARN",
  execution_role_name: "ExecutionRoleName",
  permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
  auto_deployment: {
    enabled: false,
    retain_stacks_on_account_removal: false,
    depends_on: ["StackSetARN"],
  },
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
  client_request_token: "ClientRequestToken",
  managed_execution: {
    active: false,
  },
})

Response structure


resp.stack_set_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

    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 (String) —

    A description of the StackSet. You can use the description to identify the StackSet's purpose or other important information.

  • :template_body (String) —

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

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

  • :stack_id (String) —

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

  • :parameters (Array<Types::Parameter>) —

    The input parameters for the StackSet template.

  • :capabilities (Array<String>) —

    In some cases, you must explicitly acknowledge that your StackSet template contains certain capabilities in order for CloudFormation to create the StackSet 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 IAM users. For those StackSets, 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.

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your StackSet template references one or more macros, you must create the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To create the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros.

      StackSets 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 StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.

  • :tags (Array<Types::Tag>) —

    The key-value pairs to associate with this StackSet 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 StackSet is not created.

  • :administration_role_arn (String) —

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

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

    Valid only if the permissions model is SELF_MANAGED.

  • :execution_role_name (String) —

    The name of the IAM execution role to use to create the StackSet. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet 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 StackSets.

    Valid only if the permissions model is SELF_MANAGED.

  • :permission_model (String) —

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

  • :auto_deployment (Types::AutoDeployment) —

    Describes whether StackSets automatically deploys to Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

    Required if the permissions model is SERVICE_MANAGED. (Not used with self-managed permissions.)

  • :call_as (String) —

    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.

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

    • To create a StackSet 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.

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

    Valid only if the permissions model is SERVICE_MANAGED.

  • :client_request_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :managed_execution (Types::ManagedExecution) —

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

Returns:

See Also:



2191
2192
2193
2194
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2191

def create_stack_set(params = {}, options = {})
  req = build_request(:create_stack_set, params)
  req.send_request(options)
end

#deactivate_organizations_access(params = {}) ⇒ Struct

Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2206
2207
2208
2209
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2206

def deactivate_organizations_access(params = {}, options = {})
  req = build_request(:deactivate_organizations_access, params)
  req.send_request(options)
end

#deactivate_type(params = {}) ⇒ Struct

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.

Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use SetTypeConfiguration.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

To see which extensions are currently activated, use ListTypes.

Examples:

Request syntax with placeholder values


resp = client.deactivate_type({
  type_name: "TypeName",
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  arn: "PrivateTypeArn",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type_name (String) —

    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.

  • :type (String) —

    The extension type.

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

  • :arn (String) —

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2263
2264
2265
2266
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2263

def deactivate_type(params = {}, options = {})
  req = build_request(:deactivate_type, params)
  req.send_request(options)
end

#delete_change_set(params = {}) ⇒ Struct

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

Examples:

Request syntax with placeholder values


resp = client.delete_change_set({
  change_set_name: "ChangeSetNameOrId", # required
  stack_name: "StackNameOrId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :change_set_name (required, String) —

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

  • :stack_name (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2300
2301
2302
2303
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2300

def delete_change_set(params = {}, options = {})
  req = build_request(:delete_change_set, params)
  req.send_request(options)
end

#delete_generated_template(params = {}) ⇒ Struct

Deleted a generated template.

Examples:

Example: To delete a generated template


# This example deletes a generated template

resp = client.delete_generated_template({
  generated_template_name: "JazzyTemplate", 
})

Request syntax with placeholder values


resp = client.delete_generated_template({
  generated_template_name: "GeneratedTemplateName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :generated_template_name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2331
2332
2333
2334
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2331

def delete_generated_template(params = {}, options = {})
  req = build_request(:delete_generated_template, params)
  req.send_request(options)
end

#delete_stack(params = {}) ⇒ Struct

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.

For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_stack({
  stack_name: "StackName", # required
  retain_resources: ["LogicalResourceId"],
  role_arn: "RoleARN",
  client_request_token: "ClientRequestToken",
  deletion_mode: "STANDARD", # accepts STANDARD, FORCE_DELETE_STACK
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

  • :retain_resources (Array<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 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 (String) —

    The Amazon Resource Name (ARN) of an 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 (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 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.

  • :deletion_mode (String) —

    Specifies the deletion mode for the stack. Possible values are:

    • STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this parameter.

    • FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to resource deletion failure.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2415
2416
2417
2418
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2415

def delete_stack(params = {}, options = {})
  req = build_request(:delete_stack, params)
  req.send_request(options)
end

#delete_stack_instances(params = {}) ⇒ Types::DeleteStackInstancesOutput

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

The maximum number of organizational unit (OUs) supported by a DeleteStackInstances operation is 50.

If you need more than 50, consider the following options:

  • Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.

  • Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

Examples:

Request syntax with placeholder values


resp = client.delete_stack_instances({
  stack_set_name: "StackSetName", # required
  accounts: ["Account"],
  deployment_targets: {
    accounts: ["Account"],
    accounts_url: "AccountsUrl",
    organizational_unit_ids: ["OrganizationalUnitId"],
    account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
  },
  regions: ["Region"], # required
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  retain_stacks: false, # required
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :accounts (Array<String>) —

    [Self-managed permissions] The account IDs 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 (Types::DeploymentTargets) —

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

    You can specify Accounts or DeploymentTargets, but not both.

  • :regions (required, Array<String>) —

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

  • :operation_preferences (Types::StackSetOperationPreferences) —

    Preferences for how CloudFormation performs this StackSet operation.

  • :retain_stacks (required, Boolean) —

    Removes the stack instances from the specified StackSet, 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 StackSet operation options.

  • :operation_id (String) —

    The unique identifier for this StackSet 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 StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :call_as (String) —

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

Returns:

See Also:



2548
2549
2550
2551
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2548

def delete_stack_instances(params = {}, options = {})
  req = build_request(:delete_stack_instances, params)
  req.send_request(options)
end

#delete_stack_set(params = {}) ⇒ Struct

Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.

Examples:

Request syntax with placeholder values


resp = client.delete_stack_set({
  stack_set_name: "StackSetName", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :call_as (String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2596
2597
2598
2599
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2596

def delete_stack_set(params = {}, options = {})
  req = build_request(:delete_stack_set, params)
  req.send_request(options)
end

#deregister_type(params = {}) ⇒ Struct

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

For more information, see Remove third-party private extensions from your account in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.deregister_type({
  arn: "PrivateTypeArn",
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  version_id: "TypeVersionId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (String) —

    The Amazon Resource Name (ARN) of the extension.

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

  • :type (String) —

    The kind of extension.

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

  • :type_name (String) —

    The name of the extension.

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

  • :version_id (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2663
2664
2665
2666
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2663

def deregister_type(params = {}, options = {})
  req = build_request(:deregister_type, params)
  req.send_request(options)
end

#describe_account_limits(params = {}) ⇒ Types::DescribeAccountLimitsOutput

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  next_token: "NextToken",
})

Response structure


resp. #=> Array
resp.[0].name #=> String
resp.[0].value #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



2705
2706
2707
2708
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2705

def (params = {}, options = {})
  req = build_request(:describe_account_limits, params)
  req.send_request(options)
end

#describe_change_set(params = {}) ⇒ Types::DescribeChangeSetOutput

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • change_set_create_complete

Examples:

Request syntax with placeholder values


resp = client.describe_change_set({
  change_set_name: "ChangeSetNameOrId", # required
  stack_name: "StackNameOrId",
  next_token: "NextToken",
  include_property_values: false,
})

Response structure


resp.change_set_name #=> String
resp.change_set_id #=> String
resp.stack_id #=> String
resp.stack_name #=> String
resp.description #=> String
resp.parameters #=> Array
resp.parameters[0].parameter_key #=> String
resp.parameters[0].parameter_value #=> String
resp.parameters[0].use_previous_value #=> Boolean
resp.parameters[0].resolved_value #=> String
resp.creation_time #=> Time
resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
resp.status_reason #=> String
resp.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.notification_arns #=> Array
resp.notification_arns[0] #=> String
resp.rollback_configuration.rollback_triggers #=> Array
resp.rollback_configuration.rollback_triggers[0].arn #=> String
resp.rollback_configuration.rollback_triggers[0].type #=> String
resp.rollback_configuration.monitoring_time_in_minutes #=> Integer
resp.capabilities #=> Array
resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.changes #=> Array
resp.changes[0].type #=> String, one of "Resource"
resp.changes[0].hook_invocation_count #=> Integer
resp.changes[0].resource_change.policy_action #=> String, one of "Delete", "Retain", "Snapshot", "ReplaceAndDelete", "ReplaceAndRetain", "ReplaceAndSnapshot"
resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic", "SyncWithActual"
resp.changes[0].resource_change.logical_resource_id #=> String
resp.changes[0].resource_change.physical_resource_id #=> String
resp.changes[0].resource_change.resource_type #=> String
resp.changes[0].resource_change.replacement #=> String, one of "True", "False", "Conditional"
resp.changes[0].resource_change.scope #=> Array
resp.changes[0].resource_change.scope[0] #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "UpdateReplacePolicy", "Tags"
resp.changes[0].resource_change.resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.changes[0].resource_change.resource_drift_ignored_attributes #=> Array
resp.changes[0].resource_change.resource_drift_ignored_attributes[0].path #=> String
resp.changes[0].resource_change.resource_drift_ignored_attributes[0].reason #=> String, one of "MANAGED_BY_AWS", "WRITE_ONLY_PROPERTY"
resp.changes[0].resource_change.details #=> Array
resp.changes[0].resource_change.details[0].target.attribute #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "UpdateReplacePolicy", "Tags"
resp.changes[0].resource_change.details[0].target.name #=> String
resp.changes[0].resource_change.details[0].target.requires_recreation #=> String, one of "Never", "Conditionally", "Always"
resp.changes[0].resource_change.details[0].target.path #=> String
resp.changes[0].resource_change.details[0].target.before_value #=> String
resp.changes[0].resource_change.details[0].target.after_value #=> String
resp.changes[0].resource_change.details[0].target.before_value_from #=> String, one of "PREVIOUS_DEPLOYMENT_STATE", "ACTUAL_STATE"
resp.changes[0].resource_change.details[0].target.after_value_from #=> String, one of "TEMPLATE"
resp.changes[0].resource_change.details[0].target.drift.previous_value #=> String
resp.changes[0].resource_change.details[0].target.drift.actual_value #=> String
resp.changes[0].resource_change.details[0].target.drift.drift_detection_timestamp #=> Time
resp.changes[0].resource_change.details[0].target.attribute_change_type #=> String, one of "Add", "Remove", "Modify", "SyncWithActual"
resp.changes[0].resource_change.details[0].evaluation #=> String, one of "Static", "Dynamic"
resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic", "NoModification"
resp.changes[0].resource_change.details[0].causing_entity #=> String
resp.changes[0].resource_change.change_set_id #=> String
resp.changes[0].resource_change.module_info.type_hierarchy #=> String
resp.changes[0].resource_change.module_info.logical_id_hierarchy #=> String
resp.changes[0].resource_change.before_context #=> String
resp.changes[0].resource_change.after_context #=> String
resp.changes[0].resource_change.previous_deployment_context #=> String
resp.next_token #=> String
resp.include_nested_stacks #=> Boolean
resp.parent_change_set_id #=> String
resp.root_change_set_id #=> String
resp.on_stack_failure #=> String, one of "DO_NOTHING", "ROLLBACK", "DELETE"
resp.import_existing_resources #=> Boolean
resp.deployment_mode #=> String, one of "REVERT_DRIFT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :change_set_name (required, String) —

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

  • :stack_name (String) —

    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 (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :include_property_values (Boolean) —

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

Returns:

See Also:



2854
2855
2856
2857
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2854

def describe_change_set(params = {}, options = {})
  req = build_request(:describe_change_set, params)
  req.send_request(options)
end

#describe_change_set_hooks(params = {}) ⇒ Types::DescribeChangeSetHooksOutput

Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Examples:

Request syntax with placeholder values


resp = client.describe_change_set_hooks({
  change_set_name: "ChangeSetNameOrId", # required
  stack_name: "StackNameOrId",
  next_token: "NextToken",
  logical_resource_id: "LogicalResourceId",
})

Response structure


resp.change_set_id #=> String
resp.change_set_name #=> String
resp.hooks #=> Array
resp.hooks[0].invocation_point #=> String, one of "PRE_PROVISION"
resp.hooks[0].failure_mode #=> String, one of "FAIL", "WARN"
resp.hooks[0].type_name #=> String
resp.hooks[0].type_version_id #=> String
resp.hooks[0].type_configuration_version_id #=> String
resp.hooks[0].target_details.target_type #=> String, one of "RESOURCE"
resp.hooks[0].target_details.resource_target_details.logical_resource_id #=> String
resp.hooks[0].target_details.resource_target_details.resource_type #=> String
resp.hooks[0].target_details.resource_target_details.resource_action #=> String, one of "Add", "Modify", "Remove", "Import", "Dynamic", "SyncWithActual"
resp.status #=> String, one of "PLANNING", "PLANNED", "UNAVAILABLE"
resp.next_token #=> String
resp.stack_id #=> String
resp.stack_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :change_set_name (required, String) —

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

  • :stack_name (String) —

    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 (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :logical_resource_id (String) —

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

Returns:

See Also:



2920
2921
2922
2923
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 2920

def describe_change_set_hooks(params = {}, options = {})
  req = build_request(:describe_change_set_hooks, params)
  req.send_request(options)
end

#describe_events(params = {}) ⇒ Types::DescribeEventsOutput

Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment.

An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack.

Returns different types of events including:

  • Progress events - Status updates during stack operation execution.

  • Validation errors - Failures from CloudFormation Early Validations.

  • Provisioning errors - Resource creation and update failures.

  • Hook invocation errors - Failures from CloudFormation Hook during stack operations.

One of ChangeSetName, OperationId or StackName must be specified as input.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  stack_name: "StackNameOrId",
  change_set_name: "ChangeSetNameOrId",
  operation_id: "OperationId",
  filters: {
    failed_events: false,
  },
  next_token: "NextToken",
})

Response structure


resp.operation_events #=> Array
resp.operation_events[0].event_id #=> String
resp.operation_events[0].stack_id #=> String
resp.operation_events[0].operation_id #=> String
resp.operation_events[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
resp.operation_events[0].operation_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.operation_events[0].event_type #=> String, one of "STACK_EVENT", "PROGRESS_EVENT", "VALIDATION_ERROR", "PROVISIONING_ERROR", "HOOK_INVOCATION_ERROR"
resp.operation_events[0].logical_resource_id #=> String
resp.operation_events[0].physical_resource_id #=> String
resp.operation_events[0].resource_type #=> String
resp.operation_events[0].timestamp #=> Time
resp.operation_events[0].start_time #=> Time
resp.operation_events[0].end_time #=> Time
resp.operation_events[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.operation_events[0].resource_status_reason #=> String
resp.operation_events[0].resource_properties #=> String
resp.operation_events[0].client_request_token #=> String
resp.operation_events[0].hook_type #=> String
resp.operation_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
resp.operation_events[0].hook_status_reason #=> String
resp.operation_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
resp.operation_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
resp.operation_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
resp.operation_events[0].validation_failure_mode #=> String, one of "FAIL", "WARN"
resp.operation_events[0].validation_name #=> String
resp.operation_events[0].validation_status #=> String, one of "FAILED", "SKIPPED"
resp.operation_events[0].validation_status_reason #=> String
resp.operation_events[0].validation_path #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (String) —

    The name or unique stack ID for which you want to retrieve events.

  • :change_set_name (String) —

    The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.

  • :operation_id (String) —

    The unique identifier of the operation for which you want to retrieve events.

  • :filters (Types::EventFilter) —

    Filters to apply when retrieving events.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



3026
3027
3028
3029
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3026

def describe_events(params = {}, options = {})
  req = build_request(:describe_events, params)
  req.send_request(options)
end

#describe_generated_template(params = {}) ⇒ Types::DescribeGeneratedTemplateOutput

Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.

Examples:

Example: To describe a generated template


# This example describes a generated template

resp = client.describe_generated_template({
  generated_template_name: "JazzyTemplate", 
})

resp.to_h outputs the following:
{
  creation_time: Time.parse("2023-12-28T17:55:20.086000+00:00"), 
  generated_template_id: "arn:aws:cloudformation:us-east-1:*:generatedtemplate/*", 
  generated_template_name: "DeletedResourceTest", 
  last_updated_time: Time.parse("2023-12-28T17:57:16.610000+00:00"), 
  progress: {
    resources_failed: 0, 
    resources_pending: 0, 
    resources_processing: 0, 
    resources_succeeded: 0, 
  }, 
  status: "COMPLETE", 
  status_reason: "All resources complete", 
  template_configuration: {
    deletion_policy: "RETAIN", 
    update_replace_policy: "RETAIN", 
  }, 
  total_warnings: 0, 
}

Request syntax with placeholder values


resp = client.describe_generated_template({
  generated_template_name: "GeneratedTemplateName", # required
})

Response structure


resp.generated_template_id #=> String
resp.generated_template_name #=> String
resp.resources #=> Array
resp.resources[0].resource_type #=> String
resp.resources[0].logical_resource_id #=> String
resp.resources[0].resource_identifier #=> Hash
resp.resources[0].resource_identifier["ResourceIdentifierPropertyKey"] #=> String
resp.resources[0].resource_status #=> String, one of "PENDING", "IN_PROGRESS", "FAILED", "COMPLETE"
resp.resources[0].resource_status_reason #=> String
resp.resources[0].warnings #=> Array
resp.resources[0].warnings[0].type #=> String, one of "MUTUALLY_EXCLUSIVE_PROPERTIES", "UNSUPPORTED_PROPERTIES", "MUTUALLY_EXCLUSIVE_TYPES", "EXCLUDED_PROPERTIES", "EXCLUDED_RESOURCES"
resp.resources[0].warnings[0].properties #=> Array
resp.resources[0].warnings[0].properties[0].property_path #=> String
resp.resources[0].warnings[0].properties[0].required #=> Boolean
resp.resources[0].warnings[0].properties[0].description #=> String
resp.status #=> String, one of "CREATE_PENDING", "UPDATE_PENDING", "DELETE_PENDING", "CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "COMPLETE"
resp.status_reason #=> String
resp.creation_time #=> Time
resp.last_updated_time #=> Time
resp.progress.resources_succeeded #=> Integer
resp.progress.resources_failed #=> Integer
resp.progress.resources_processing #=> Integer
resp.progress.resources_pending #=> Integer
resp.stack_id #=> String
resp.template_configuration.deletion_policy #=> String, one of "DELETE", "RETAIN"
resp.template_configuration.update_replace_policy #=> String, one of "DELETE", "RETAIN"
resp.total_warnings #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :generated_template_name (required, String) —

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

Returns:

See Also:



3123
3124
3125
3126
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3123

def describe_generated_template(params = {}, options = {})
  req = build_request(:describe_generated_template, params)
  req.send_request(options)
end

#describe_organizations_access(params = {}) ⇒ Types::DescribeOrganizationsAccessOutput

Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.

Examples:

Request syntax with placeholder values


resp = client.describe_organizations_access({
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.status #=> String, one of "ENABLED", "DISABLED", "DISABLED_PERMANENTLY"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :call_as (String) —

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

Returns:

See Also:



3173
3174
3175
3176
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3173

def describe_organizations_access(params = {}, options = {})
  req = build_request(:describe_organizations_access, params)
  req.send_request(options)
end

#describe_publisher(params = {}) ⇒ Types::DescribePublisherOutput

Returns information about a CloudFormation 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.

For more information about registering as a publisher, see:

Examples:

Request syntax with placeholder values


resp = client.describe_publisher({
  publisher_id: "PublisherId",
})

Response structure


resp.publisher_id #=> String
resp.publisher_status #=> String, one of "VERIFIED", "UNVERIFIED"
resp.identity_provider #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
resp.publisher_profile #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :publisher_id (String) —

    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.

Returns:

See Also:



3227
3228
3229
3230
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3227

def describe_publisher(params = {}, options = {})
  req = build_request(:describe_publisher, params)
  req.send_request(options)
end

#describe_resource_scan(params = {}) ⇒ Types::DescribeResourceScanOutput

Describes details of a resource scan.

Examples:

Example: To describe a selected resource scan


# This example describes a selected resource scan

resp = client.describe_resource_scan({
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
})

resp.to_h outputs the following:
{
  end_time: Time.parse("2024-01-02T23:25:48.075000+00:00"), 
  percentage_completed: 100.0, 
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
  resource_types: [
    "AWS::Amplify::App", 
    "AWS::ApiGateway::Deployment", 
    "AWS::ApiGateway::DocumentationPart", 
    "AWS::ApiGateway::Model", 
    "AWS::ApiGateway::Resource", 
    "AWS::ApiGateway::RestApi", 
    "AWS::ApiGateway::Stage", 
    "AWS::AppConfig::Extension", 
    "AWS::ApplicationAutoScaling::ScalableTarget", 
    "AWS::Athena::WorkGroup", 
    "AWS::Cassandra::Keyspace", 
    "AWS::CloudFront::CachePolicy", 
    "AWS::CloudFront::Function", 
    "AWS::CloudFront::OriginRequestPolicy", 
    "AWS::CloudTrail::Trail", 
    "AWS::CloudWatch::Alarm", 
    "AWS::CodeDeploy::Application", 
    "AWS::CodeDeploy::DeploymentConfig", 
    "AWS::Cognito::UserPool", 
    "AWS::Cognito::UserPoolGroup", 
    "AWS::Cognito::UserPoolUser", 
    "AWS::DynamoDB::Table", 
    "AWS::EC2::DHCPOptions", 
    "AWS::EC2::EIP", 
    "AWS::EC2::InternetGateway", 
    "AWS::EC2::LaunchTemplate", 
    "AWS::EC2::NetworkAcl", 
    "AWS::EC2::Route", 
    "AWS::EC2::RouteTable", 
    "AWS::EC2::SubnetNetworkAclAssociation", 
    "AWS::EC2::SubnetRouteTableAssociation", 
    "AWS::EC2::VPC", 
    "AWS::EC2::VPCDHCPOptionsAssociation", 
    "AWS::EC2::VPCGatewayAttachment", 
    "AWS::ECR::Repository", 
    "AWS::ECS::Cluster", 
    "AWS::ECS::ClusterCapacityProviderAssociations", 
    "AWS::ECS::Service", 
    "AWS::ECS::TaskDefinition", 
    "AWS::ElastiCache::SubnetGroup", 
    "AWS::ElastiCache::User", 
    "AWS::Events::EventBus", 
    "AWS::Events::Rule", 
    "AWS::GameLift::Location", 
    "AWS::GuardDuty::Detector", 
    "AWS::IAM::InstanceProfile", 
    "AWS::IAM::ManagedPolicy", 
    "AWS::IAM::Role", 
    "AWS::IAM::User", 
    "AWS::IoT::DomainConfiguration", 
    "AWS::KMS::Alias", 
    "AWS::KMS::Key", 
    "AWS::Lambda::EventSourceMapping", 
    "AWS::Lambda::Function", 
    "AWS::Lambda::Permission", 
    "AWS::Lambda::Version", 
    "AWS::Logs::LogGroup", 
    "AWS::Logs::LogStream", 
    "AWS::MemoryDB::ACL", 
    "AWS::MemoryDB::ParameterGroup", 
    "AWS::MemoryDB::User", 
    "AWS::RAM::Permission", 
    "AWS::RDS::CustomDBEngineVersion", 
    "AWS::Route53Resolver::ResolverRuleAssociation", 
    "AWS::S3::AccessPoint", 
    "AWS::S3::BucketPolicy", 
    "AWS::S3::StorageLens", 
    "AWS::SNS::Topic", 
    "AWS::SQS::Queue", 
    "AWS::SSM::Association", 
    "AWS::SSM::Document", 
    "AWS::StepFunctions::StateMachine", 
    "AWS::XRay::Group", 
    "AWS::XRay::SamplingRule", 
  ], 
  resources_read: 25107, 
  start_time: Time.parse("2024-01-02T22:15:18.382000+00:00"), 
  status: "COMPLETE", 
}

Request syntax with placeholder values


resp = client.describe_resource_scan({
  resource_scan_id: "ResourceScanId", # required
})

Response structure


resp.resource_scan_id #=> String
resp.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETE", "EXPIRED"
resp.status_reason #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.percentage_completed #=> Float
resp.resource_types #=> Array
resp.resource_types[0] #=> String
resp.resources_scanned #=> Integer
resp.resources_read #=> Integer
resp.scan_filters #=> Array
resp.scan_filters[0].types #=> Array
resp.scan_filters[0].types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_scan_id (required, String) —

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

Returns:

See Also:



3371
3372
3373
3374
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3371

def describe_resource_scan(params = {}, options = {})
  req = build_request(:describe_resource_scan, params)
  req.send_request(options)
end

#describe_stack_drift_detection_status(params = {}) ⇒ Types::DescribeStackDriftDetectionStatusOutput

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_drift_detection_status({
  stack_drift_detection_id: "StackDriftDetectionId", # required
})

Response structure


resp.stack_id #=> String
resp.stack_drift_detection_id #=> String
resp.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.detection_status #=> String, one of "DETECTION_IN_PROGRESS", "DETECTION_FAILED", "DETECTION_COMPLETE"
resp.detection_status_reason #=> String
resp.drifted_stack_resource_count #=> Integer
resp.timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_drift_detection_id (required, 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.

Returns:

See Also:



3435
3436
3437
3438
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3435

def describe_stack_drift_detection_status(params = {}, options = {})
  req = build_request(:describe_stack_drift_detection_status, params)
  req.send_request(options)
end

#describe_stack_events(params = {}) ⇒ Types::DescribeStackEventsOutput

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_events({
  stack_name: "StackName", # required
  next_token: "NextToken",
})

Response structure


resp.stack_events #=> Array
resp.stack_events[0].stack_id #=> String
resp.stack_events[0].event_id #=> String
resp.stack_events[0].stack_name #=> String
resp.stack_events[0].operation_id #=> String
resp.stack_events[0].logical_resource_id #=> String
resp.stack_events[0].physical_resource_id #=> String
resp.stack_events[0].resource_type #=> String
resp.stack_events[0].timestamp #=> Time
resp.stack_events[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.stack_events[0].resource_status_reason #=> String
resp.stack_events[0].resource_properties #=> String
resp.stack_events[0].client_request_token #=> String
resp.stack_events[0].hook_type #=> String
resp.stack_events[0].hook_status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
resp.stack_events[0].hook_status_reason #=> String
resp.stack_events[0].hook_invocation_point #=> String, one of "PRE_PROVISION"
resp.stack_events[0].hook_invocation_id #=> String
resp.stack_events[0].hook_failure_mode #=> String, one of "FAIL", "WARN"
resp.stack_events[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    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.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



3509
3510
3511
3512
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3509

def describe_stack_events(params = {}, options = {})
  req = build_request(:describe_stack_events, params)
  req.send_request(options)
end

#describe_stack_instance(params = {}) ⇒ Types::DescribeStackInstanceOutput

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_instance({
  stack_set_name: "StackSetName", # required
  stack_instance_account: "Account", # required
  stack_instance_region: "Region", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.stack_instance.stack_set_id #=> String
resp.stack_instance.region #=> String
resp.stack_instance. #=> String
resp.stack_instance.stack_id #=> String
resp.stack_instance.parameter_overrides #=> Array
resp.stack_instance.parameter_overrides[0].parameter_key #=> String
resp.stack_instance.parameter_overrides[0].parameter_value #=> String
resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
resp.stack_instance.parameter_overrides[0].resolved_value #=> String
resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT", "FAILED_IMPORT"
resp.stack_instance.status_reason #=> String
resp.stack_instance.organizational_unit_id #=> String
resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.stack_instance.last_drift_check_timestamp #=> Time
resp.stack_instance.last_operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :stack_instance_account (required, String) —

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

  • :stack_instance_region (required, String) —

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

  • :call_as (String) —

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

Returns:

See Also:



3589
3590
3591
3592
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3589

def describe_stack_instance(params = {}, options = {})
  req = build_request(:describe_stack_instance, params)
  req.send_request(options)
end

#describe_stack_refactor(params = {}) ⇒ Types::DescribeStackRefactorOutput

Describes the stack refactor status.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • stack_refactor_create_complete
  • stack_refactor_execute_complete

Examples:

Request syntax with placeholder values


resp = client.describe_stack_refactor({
  stack_refactor_id: "StackRefactorId", # required
})

Response structure


resp.description #=> String
resp.stack_refactor_id #=> String
resp.stack_ids #=> Array
resp.stack_ids[0] #=> String
resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "OBSOLETE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.execution_status_reason #=> String
resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
resp.status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_refactor_id (required, String) —

    The ID associated with the stack refactor created from the CreateStackRefactor action.

Returns:

See Also:



3637
3638
3639
3640
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3637

def describe_stack_refactor(params = {}, options = {})
  req = build_request(:describe_stack_refactor, params)
  req.send_request(options)
end

#describe_stack_resource(params = {}) ⇒ Types::DescribeStackResourceOutput

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_resource({
  stack_name: "StackName", # required
  logical_resource_id: "LogicalResourceId", # required
})

Response structure


resp.stack_resource_detail.stack_name #=> String
resp.stack_resource_detail.stack_id #=> String
resp.stack_resource_detail.logical_resource_id #=> String
resp.stack_resource_detail.physical_resource_id #=> String
resp.stack_resource_detail.resource_type #=> String
resp.stack_resource_detail.last_updated_timestamp #=> Time
resp.stack_resource_detail.resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.stack_resource_detail.resource_status_reason #=> String
resp.stack_resource_detail.description #=> String
resp.stack_resource_detail.metadata #=> String
resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.stack_resource_detail.drift_information.last_check_timestamp #=> Time
resp.stack_resource_detail.module_info.type_hierarchy #=> String
resp.stack_resource_detail.module_info.logical_id_hierarchy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    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.

  • :logical_resource_id (required, String) —

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

Returns:

See Also:



3692
3693
3694
3695
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3692

def describe_stack_resource(params = {}, options = {})
  req = build_request(:describe_stack_resource, params)
  req.send_request(options)
end

#describe_stack_resource_drifts(params = {}) ⇒ Types::DescribeStackResourceDriftsOutput

Returns 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 configuration 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 don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_resource_drifts({
  stack_name: "StackNameOrId", # required
  stack_resource_drift_status_filters: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN, UNSUPPORTED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.stack_resource_drifts #=> Array
resp.stack_resource_drifts[0].stack_id #=> String
resp.stack_resource_drifts[0].logical_resource_id #=> String
resp.stack_resource_drifts[0].physical_resource_id #=> String
resp.stack_resource_drifts[0].physical_resource_id_context #=> Array
resp.stack_resource_drifts[0].physical_resource_id_context[0].key #=> String
resp.stack_resource_drifts[0].physical_resource_id_context[0].value #=> String
resp.stack_resource_drifts[0].resource_type #=> String
resp.stack_resource_drifts[0].expected_properties #=> String
resp.stack_resource_drifts[0].actual_properties #=> String
resp.stack_resource_drifts[0].property_differences #=> Array
resp.stack_resource_drifts[0].property_differences[0].property_path #=> String
resp.stack_resource_drifts[0].property_differences[0].expected_value #=> String
resp.stack_resource_drifts[0].property_differences[0].actual_value #=> String
resp.stack_resource_drifts[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.stack_resource_drifts[0].timestamp #=> Time
resp.stack_resource_drifts[0].module_info.type_hierarchy #=> String
resp.stack_resource_drifts[0].module_info.logical_id_hierarchy #=> String
resp.stack_resource_drifts[0].drift_status_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

  • :stack_resource_drift_status_filters (Array<String>) —

    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.

    • UNKNOWN: CloudFormation could not run drift detection for the resource.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



3792
3793
3794
3795
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3792

def describe_stack_resource_drifts(params = {}, options = {})
  req = build_request(:describe_stack_resource_drifts, params)
  req.send_request(options)
end

#describe_stack_resources(params = {}) ⇒ Types::DescribeStackResourcesOutput

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, see the CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_resources({
  stack_name: "StackName",
  logical_resource_id: "LogicalResourceId",
  physical_resource_id: "PhysicalResourceId",
})

Response structure


resp.stack_resources #=> Array
resp.stack_resources[0].stack_name #=> String
resp.stack_resources[0].stack_id #=> String
resp.stack_resources[0].logical_resource_id #=> String
resp.stack_resources[0].physical_resource_id #=> String
resp.stack_resources[0].resource_type #=> String
resp.stack_resources[0].timestamp #=> Time
resp.stack_resources[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.stack_resources[0].resource_status_reason #=> String
resp.stack_resources[0].description #=> String
resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.stack_resources[0].drift_information.last_check_timestamp #=> Time
resp.stack_resources[0].module_info.type_hierarchy #=> String
resp.stack_resources[0].module_info.logical_id_hierarchy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (String) —

    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.

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

  • :logical_resource_id (String) —

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

  • :physical_resource_id (String) —

    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.

Returns:

See Also:



3886
3887
3888
3889
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3886

def describe_stack_resources(params = {}, options = {})
  req = build_request(:describe_stack_resources, params)
  req.send_request(options)
end

#describe_stack_set(params = {}) ⇒ Types::DescribeStackSetOutput

Returns the description of the specified StackSet.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_set({
  stack_set_name: "StackSetName", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.stack_set.stack_set_name #=> String
resp.stack_set.stack_set_id #=> String
resp.stack_set.description #=> String
resp.stack_set.status #=> String, one of "ACTIVE", "DELETED"
resp.stack_set.template_body #=> String
resp.stack_set.parameters #=> Array
resp.stack_set.parameters[0].parameter_key #=> String
resp.stack_set.parameters[0].parameter_value #=> String
resp.stack_set.parameters[0].use_previous_value #=> Boolean
resp.stack_set.parameters[0].resolved_value #=> String
resp.stack_set.capabilities #=> Array
resp.stack_set.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
resp.stack_set.tags #=> Array
resp.stack_set.tags[0].key #=> String
resp.stack_set.tags[0].value #=> String
resp.stack_set.stack_set_arn #=> String
resp.stack_set.administration_role_arn #=> String
resp.stack_set.execution_role_name #=> String
resp.stack_set.stack_set_drift_detection_details.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKED"
resp.stack_set.stack_set_drift_detection_details.drift_detection_status #=> String, one of "COMPLETED", "FAILED", "PARTIAL_SUCCESS", "IN_PROGRESS", "STOPPED"
resp.stack_set.stack_set_drift_detection_details.last_drift_check_timestamp #=> Time
resp.stack_set.stack_set_drift_detection_details.total_stack_instances_count #=> Integer
resp.stack_set.stack_set_drift_detection_details.drifted_stack_instances_count #=> Integer
resp.stack_set.stack_set_drift_detection_details.in_sync_stack_instances_count #=> Integer
resp.stack_set.stack_set_drift_detection_details.in_progress_stack_instances_count #=> Integer
resp.stack_set.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
resp.stack_set.auto_deployment.enabled #=> Boolean
resp.stack_set.auto_deployment. #=> Boolean
resp.stack_set.auto_deployment.depends_on #=> Array
resp.stack_set.auto_deployment.depends_on[0] #=> String
resp.stack_set.permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
resp.stack_set.organizational_unit_ids #=> Array
resp.stack_set.organizational_unit_ids[0] #=> String
resp.stack_set.managed_execution.active #=> Boolean
resp.stack_set.regions #=> Array
resp.stack_set.regions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :call_as (String) —

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

Returns:

See Also:



3977
3978
3979
3980
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 3977

def describe_stack_set(params = {}, options = {})
  req = build_request(:describe_stack_set, params)
  req.send_request(options)
end

#describe_stack_set_operation(params = {}) ⇒ Types::DescribeStackSetOperationOutput

Returns the description of the specified StackSet operation.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

Examples:

Request syntax with placeholder values


resp = client.describe_stack_set_operation({
  stack_set_name: "StackSetName", # required
  operation_id: "ClientRequestToken", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.stack_set_operation.operation_id #=> String
resp.stack_set_operation.stack_set_id #=> String
resp.stack_set_operation.action #=> String, one of "CREATE", "UPDATE", "DELETE", "DETECT_DRIFT"
resp.stack_set_operation.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
resp.stack_set_operation.operation_preferences.region_concurrency_type #=> String, one of "SEQUENTIAL", "PARALLEL"
resp.stack_set_operation.operation_preferences.region_order #=> Array
resp.stack_set_operation.operation_preferences.region_order[0] #=> String
resp.stack_set_operation.operation_preferences.failure_tolerance_count #=> Integer
resp.stack_set_operation.operation_preferences.failure_tolerance_percentage #=> Integer
resp.stack_set_operation.operation_preferences.max_concurrent_count #=> Integer
resp.stack_set_operation.operation_preferences.max_concurrent_percentage #=> Integer
resp.stack_set_operation.operation_preferences.concurrency_mode #=> String, one of "STRICT_FAILURE_TOLERANCE", "SOFT_FAILURE_TOLERANCE"
resp.stack_set_operation.retain_stacks #=> Boolean
resp.stack_set_operation.administration_role_arn #=> String
resp.stack_set_operation.execution_role_name #=> String
resp.stack_set_operation.creation_timestamp #=> Time
resp.stack_set_operation.end_timestamp #=> Time
resp.stack_set_operation.deployment_targets.accounts #=> Array
resp.stack_set_operation.deployment_targets.accounts[0] #=> String
resp.stack_set_operation.deployment_targets.accounts_url #=> String
resp.stack_set_operation.deployment_targets.organizational_unit_ids #=> Array
resp.stack_set_operation.deployment_targets.organizational_unit_ids[0] #=> String
resp.stack_set_operation.deployment_targets. #=> String, one of "NONE", "INTERSECTION", "DIFFERENCE", "UNION"
resp.stack_set_operation.stack_set_drift_detection_details.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKED"
resp.stack_set_operation.stack_set_drift_detection_details.drift_detection_status #=> String, one of "COMPLETED", "FAILED", "PARTIAL_SUCCESS", "IN_PROGRESS", "STOPPED"
resp.stack_set_operation.stack_set_drift_detection_details.last_drift_check_timestamp #=> Time
resp.stack_set_operation.stack_set_drift_detection_details.total_stack_instances_count #=> Integer
resp.stack_set_operation.stack_set_drift_detection_details.drifted_stack_instances_count #=> Integer
resp.stack_set_operation.stack_set_drift_detection_details.in_sync_stack_instances_count #=> Integer
resp.stack_set_operation.stack_set_drift_detection_details.in_progress_stack_instances_count #=> Integer
resp.stack_set_operation.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
resp.stack_set_operation.status_reason #=> String
resp.stack_set_operation.status_details.failed_stack_instances_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :operation_id (required, String) —

    The unique ID of the StackSet operation.

  • :call_as (String) —

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

Returns:

See Also:



4070
4071
4072
4073
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4070

def describe_stack_set_operation(params = {}, options = {})
  req = build_request(:describe_stack_set_operation, params)
  req.send_request(options)
end

#describe_stacks(params = {}) ⇒ Types::DescribeStacksOutput

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

If the stack doesn't exist, a ValidationError is returned.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • stack_create_complete
  • stack_delete_complete
  • stack_exists
  • stack_import_complete
  • stack_rollback_complete
  • stack_update_complete

Examples:

Request syntax with placeholder values


resp = client.describe_stacks({
  stack_name: "StackName",
  next_token: "NextToken",
})

Response structure


resp.stacks #=> Array
resp.stacks[0].stack_id #=> String
resp.stacks[0].stack_name #=> String
resp.stacks[0].change_set_id #=> String
resp.stacks[0].description #=> String
resp.stacks[0].parameters #=> Array
resp.stacks[0].parameters[0].parameter_key #=> String
resp.stacks[0].parameters[0].parameter_value #=> String
resp.stacks[0].parameters[0].use_previous_value #=> Boolean
resp.stacks[0].parameters[0].resolved_value #=> String
resp.stacks[0].creation_time #=> Time
resp.stacks[0].deletion_time #=> Time
resp.stacks[0].last_updated_time #=> Time
resp.stacks[0].rollback_configuration.rollback_triggers #=> Array
resp.stacks[0].rollback_configuration.rollback_triggers[0].arn #=> String
resp.stacks[0].rollback_configuration.rollback_triggers[0].type #=> String
resp.stacks[0].rollback_configuration.monitoring_time_in_minutes #=> Integer
resp.stacks[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
resp.stacks[0].stack_status_reason #=> String
resp.stacks[0].disable_rollback #=> Boolean
resp.stacks[0].notification_arns #=> Array
resp.stacks[0].notification_arns[0] #=> String
resp.stacks[0].timeout_in_minutes #=> Integer
resp.stacks[0].capabilities #=> Array
resp.stacks[0].capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
resp.stacks[0].outputs #=> Array
resp.stacks[0].outputs[0].output_key #=> String
resp.stacks[0].outputs[0].output_value #=> String
resp.stacks[0].outputs[0].description #=> String
resp.stacks[0].outputs[0].export_name #=> String
resp.stacks[0].role_arn #=> String
resp.stacks[0].tags #=> Array
resp.stacks[0].tags[0].key #=> String
resp.stacks[0].tags[0].value #=> String
resp.stacks[0].enable_termination_protection #=> Boolean
resp.stacks[0].parent_id #=> String
resp.stacks[0].root_id #=> String
resp.stacks[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.stacks[0].drift_information.last_check_timestamp #=> Time
resp.stacks[0].retain_except_on_create #=> Boolean
resp.stacks[0].deletion_mode #=> String, one of "STANDARD", "FORCE_DELETE_STACK"
resp.stacks[0].detailed_status #=> String, one of "CONFIGURATION_COMPLETE", "VALIDATION_FAILED"
resp.stacks[0].last_operations #=> Array
resp.stacks[0].last_operations[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
resp.stacks[0].last_operations[0].operation_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (String) —

    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.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



4197
4198
4199
4200
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4197

def describe_stacks(params = {}, options = {})
  req = build_request(:describe_stacks, params)
  req.send_request(options)
end

#describe_type(params = {}) ⇒ Types::DescribeTypeOutput

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

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

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_type({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  arn: "TypeArn",
  version_id: "TypeVersionId",
  publisher_id: "PublisherId",
  public_version_number: "PublicVersionNumber",
})

Response structure


resp.arn #=> String
resp.type #=> String, one of "RESOURCE", "MODULE", "HOOK"
resp.type_name #=> String
resp.default_version_id #=> String
resp.is_default_version #=> Boolean
resp.type_tests_status #=> String, one of "PASSED", "FAILED", "IN_PROGRESS", "NOT_TESTED"
resp.type_tests_status_description #=> String
resp.description #=> String
resp.schema #=> String
resp.provisioning_type #=> String, one of "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"
resp.deprecated_status #=> String, one of "LIVE", "DEPRECATED"
resp.logging_config.log_role_arn #=> String
resp.logging_config.log_group_name #=> String
resp.required_activated_types #=> Array
resp.required_activated_types[0].type_name_alias #=> String
resp.required_activated_types[0].original_type_name #=> String
resp.required_activated_types[0].publisher_id #=> String
resp.required_activated_types[0].supported_major_versions #=> Array
resp.required_activated_types[0].supported_major_versions[0] #=> Integer
resp.execution_role_arn #=> String
resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
resp.source_url #=> String
resp.documentation_url #=> String
resp.last_updated #=> Time
resp.time_created #=> Time
resp.configuration_schema #=> String
resp.publisher_id #=> String
resp.original_type_name #=> String
resp.original_type_arn #=> String
resp.public_version_number #=> String
resp.latest_public_version #=> String
resp.is_activated #=> Boolean
resp.auto_update #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The kind of extension.

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

  • :type_name (String) —

    The name of the extension.

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

  • :arn (String) —

    The Amazon Resource Name (ARN) of the extension.

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

  • :version_id (String) —

    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 (String) —

    The publisher ID of the extension publisher.

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

  • :public_version_number (String) —

    The version number of a public third-party extension.

Returns:

See Also:



4330
4331
4332
4333
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4330

def describe_type(params = {}, options = {})
  req = build_request(:describe_type, params)
  req.send_request(options)
end

#describe_type_registration(params = {}) ⇒ Types::DescribeTypeRegistrationOutput

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • type_registration_complete

Examples:

Request syntax with placeholder values


resp = client.describe_type_registration({
  registration_token: "RegistrationToken", # required
})

Response structure


resp.progress_status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
resp.description #=> String
resp.type_arn #=> String
resp.type_version_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :registration_token (required, String) —

    The identifier for this registration request.

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

Returns:

See Also:



4380
4381
4382
4383
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4380

def describe_type_registration(params = {}, options = {})
  req = build_request(:describe_type_registration, params)
  req.send_request(options)
end

#detect_stack_drift(params = {}) ⇒ Types::DetectStackDriftOutput

Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see Resource type support for imports and drift detection.

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

Examples:

Request syntax with placeholder values


resp = client.detect_stack_drift({
  stack_name: "StackNameOrId", # required
  logical_resource_ids: ["LogicalResourceId"],
})

Response structure


resp.stack_drift_detection_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

  • :logical_resource_ids (Array<String>) —

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

Returns:

See Also:



4445
4446
4447
4448
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4445

def detect_stack_drift(params = {}, options = {})
  req = build_request(:detect_stack_drift, params)
  req.send_request(options)
end

#detect_stack_resource_drift(params = {}) ⇒ Types::DetectStackResourceDriftOutput

Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

Examples:

Request syntax with placeholder values


resp = client.detect_stack_resource_drift({
  stack_name: "StackNameOrId", # required
  logical_resource_id: "LogicalResourceId", # required
})

Response structure


resp.stack_resource_drift.stack_id #=> String
resp.stack_resource_drift.logical_resource_id #=> String
resp.stack_resource_drift.physical_resource_id #=> String
resp.stack_resource_drift.physical_resource_id_context #=> Array
resp.stack_resource_drift.physical_resource_id_context[0].key #=> String
resp.stack_resource_drift.physical_resource_id_context[0].value #=> String
resp.stack_resource_drift.resource_type #=> String
resp.stack_resource_drift.expected_properties #=> String
resp.stack_resource_drift.actual_properties #=> String
resp.stack_resource_drift.property_differences #=> Array
resp.stack_resource_drift.property_differences[0].property_path #=> String
resp.stack_resource_drift.property_differences[0].expected_value #=> String
resp.stack_resource_drift.property_differences[0].actual_value #=> String
resp.stack_resource_drift.property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.stack_resource_drift.timestamp #=> Time
resp.stack_resource_drift.module_info.type_hierarchy #=> String
resp.stack_resource_drift.module_info.logical_id_hierarchy #=> String
resp.stack_resource_drift.drift_status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    The name of the stack to which the resource belongs.

  • :logical_resource_id (required, String) —

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

Returns:

See Also:



4517
4518
4519
4520
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4517

def detect_stack_resource_drift(params = {}, options = {})
  req = build_request(:detect_stack_resource_drift, params)
  req.send_request(options)
end

#detect_stack_set_drift(params = {}) ⇒ Types::DetectStackSetDriftOutput

Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see Performing drift detection on CloudFormation StackSets.

DetectStackSetDrift returns the OperationId of the StackSet drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the StackSet, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.)

  • Use ListStackInstances to return a list of stack instances belonging to the StackSet, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

You can only run a single drift detection operation on a given StackSet at one time.

To stop a drift detection StackSet operation, use StopStackSetOperation.

Examples:

Request syntax with placeholder values


resp = client.detect_stack_set_drift({
  stack_set_name: "StackSetNameOrId", # required
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :operation_preferences (Types::StackSetOperationPreferences) —

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

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

  • :operation_id (String) —

    The ID of the StackSet operation.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :call_as (String) —

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

Returns:

See Also:



4633
4634
4635
4636
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4633

def detect_stack_set_drift(params = {}, options = {})
  req = build_request(:detect_stack_set_drift, params)
  req.send_request(options)
end

#estimate_template_cost(params = {}) ⇒ Types::EstimateTemplateCostOutput

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Examples:

Request syntax with placeholder values


resp = client.estimate_template_cost({
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
})

Response structure


resp.url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_body (String) —

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. URLs from S3 static websites are not supported.

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

  • :parameters (Array<Types::Parameter>) —

    A list of Parameter structures that specify input parameters.

Returns:

See Also:



4688
4689
4690
4691
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4688

def estimate_template_cost(params = {}, options = {})
  req = build_request(:estimate_template_cost, params)
  req.send_request(options)
end

#execute_change_set(params = {}) ⇒ Struct

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.

Examples:

Request syntax with placeholder values


resp = client.execute_change_set({
  change_set_name: "ChangeSetNameOrId", # required
  stack_name: "StackNameOrId",
  client_request_token: "ClientRequestToken",
  disable_rollback: false,
  retain_except_on_create: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :change_set_name (required, String) —

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

  • :stack_name (String) —

    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 (String) —

    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 (Boolean) —

    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 (Boolean) —

    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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4768
4769
4770
4771
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4768

def execute_change_set(params = {}, options = {})
  req = build_request(:execute_change_set, params)
  req.send_request(options)
end

#execute_stack_refactor(params = {}) ⇒ Struct

Executes the stack refactor operation.

Examples:

Request syntax with placeholder values


resp = client.execute_stack_refactor({
  stack_refactor_id: "StackRefactorId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_refactor_id (required, String) —

    The ID associated with the stack refactor created from the CreateStackRefactor action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4791
4792
4793
4794
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4791

def execute_stack_refactor(params = {}, options = {})
  req = build_request(:execute_stack_refactor, params)
  req.send_request(options)
end

#get_generated_template(params = {}) ⇒ Types::GetGeneratedTemplateOutput

Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.

Examples:

Example: To get a generated template in JSON format


# This example gets a generated template ins JSON format.

resp = client.get_generated_template({
  generated_template_name: "JazzyTemplate", 
})

resp.to_h outputs the following:
{
  status: "COMPLETE", 
  template_body: "{\"Metadata\":{\"TemplateId\":\"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*\"},\"Parameters\":{\"Stage\":{\"Default\":\"beta\",\"Type\":\"String\"}},\"Resources\":{\"TestRole\":{\"Properties\":{\"AssumeRolePolicyDocument\":{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":{\"Fn::Sub\":[\"arn:${AWS::Partition}:iam::${AccountId}:root\",{\"AccountId\":{\"Fn::AccountIdFromAlias\":\"test-account-alias\"}}]}},\"Action\":\"sts:AssumeRole\"}]}},\"Type\":\"AWS::IAM::Role\",\"DeletionPolicy\":\"Delete\"},\"DocumentationPartl7ob4vsd76vs\":{\"UpdateReplacePolicy\":\"Retain\",\"Type\":\"AWS::ApiGateway::DocumentationPart\",\"DeletionPolicy\":\"Retain\",\"Properties\":{\"RestApiId\":\"l7ob4vsd76\",\"Properties\":\"{\\n  \\\"description\\\" : \\\"ListGeneratedTemplates 200 response\\\"\\n}\",\"Location\":{\"Path\":\"/ListGeneratedTemplates\",\"Type\":\"RESPONSE\",\"Method\":\"POST\",\"StatusCode\":\"200\"}}}}}", 
}

Example: To get a generated template in YAML format


# This example gets a generated template in YAML format.

resp = client.get_generated_template({
  format: "YAML", 
  generated_template_name: "JazzyTemplate", 
})

resp.to_h outputs the following:
{
  status: "COMPLETE", 
  template_body: "---\nMetadata:\n  TemplateId: \"arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/*\"\nParameters:\n  Stage:\n    Default: \"beta\"\n    Type: \"String\"\nResources:\n  TestRole:\n    Properties:\n      AssumeRolePolicyDocument:\n        Version: \"2012-10-17\"\n        Statement:\n        - Effect: \"Allow\"\n          Principal:\n            AWS:\n              Fn::Sub:\n              - \"arn:${AWS::Partition}:iam::${AccountId}:root\"\n              - AccountId:\n                  Fn::AccountIdFromAlias: \"test-account-alias\"\n          Action: \"sts:AssumeRole\"\n    Type: \"AWS::IAM::Role\"\n    DeletionPolicy: \"Delete\"\n  DocumentationPartl7ob4vsd76vsnAlFMLXKVm:\n    UpdateReplacePolicy: \"Retain\"\n    Type: \"AWS::ApiGateway::DocumentationPart\"\n    DeletionPolicy: \"Retain\"\n    Properties:\n      RestApiId: \"l7ob4vsd76\"\n      Properties: \"{\\n  \\\"description\\\" : \\\"ListGeneratedTemplates 200 response\\\"\\n\\\n        }\"\n      Location:\n        Path: \"/ListGeneratedTemplates\"\n        Type: \"RESPONSE\"\n        Method: \"POST\"\n        StatusCode: \"200\"\n", 
}

Request syntax with placeholder values


resp = client.get_generated_template({
  format: "JSON", # accepts JSON, YAML
  generated_template_name: "GeneratedTemplateName", # required
})

Response structure


resp.status #=> String, one of "CREATE_PENDING", "UPDATE_PENDING", "DELETE_PENDING", "CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "COMPLETE"
resp.template_body #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :format (String) —

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

    • JSON

    • YAML

  • :generated_template_name (required, String) —

    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 .

Returns:

See Also:



4869
4870
4871
4872
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4869

def get_generated_template(params = {}, options = {})
  req = build_request(:get_generated_template, params)
  req.send_request(options)
end

#get_hook_result(params = {}) ⇒ Types::GetHookResultOutput

Retrieves detailed information and remediation guidance for a Hook invocation result.

If the Hook uses a KMS key to encrypt annotations, callers of the GetHookResult operation must have kms:Decrypt permissions. For more information, see KMS key policy and permissions for encrypting CloudFormation Hooks results at rest in the CloudFormation Hooks User Guide.

Examples:

Request syntax with placeholder values


resp = client.get_hook_result({
  hook_result_id: "HookInvocationId",
})

Response structure


resp.hook_result_id #=> String
resp.invocation_point #=> String, one of "PRE_PROVISION"
resp.failure_mode #=> String, one of "FAIL", "WARN"
resp.type_name #=> String
resp.original_type_name #=> String
resp.type_version_id #=> String
resp.type_configuration_version_id #=> String
resp.type_arn #=> String
resp.status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
resp.hook_status_reason #=> String
resp.invoked_at #=> Time
resp.target.target_type #=> String, one of "RESOURCE"
resp.target.target_type_name #=> String
resp.target.target_id #=> String
resp.target.action #=> String, one of "CREATE", "UPDATE", "DELETE", "IMPORT"
resp.annotations #=> Array
resp.annotations[0].annotation_name #=> String
resp.annotations[0].status #=> String, one of "PASSED", "FAILED", "SKIPPED"
resp.annotations[0].status_message #=> String
resp.annotations[0].remediation_message #=> String
resp.annotations[0].remediation_link #=> String
resp.annotations[0].severity_level #=> String, one of "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hook_result_id (String) —

    The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the ListHookResults operation.

Returns:

See Also:



4947
4948
4949
4950
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4947

def get_hook_result(params = {}, options = {})
  req = build_request(:get_hook_result, params)
  req.send_request(options)
end

#get_stack_policy(params = {}) ⇒ Types::GetStackPolicyOutput

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Examples:

Request syntax with placeholder values


resp = client.get_stack_policy({
  stack_name: "StackName", # required
})

Response structure


resp.stack_policy_body #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

Returns:

See Also:



4977
4978
4979
4980
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 4977

def get_stack_policy(params = {}, options = {})
  req = build_request(:get_stack_policy, params)
  req.send_request(options)
end

#get_template(params = {}) ⇒ Types::GetTemplateOutput

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template doesn't exist, a ValidationError is returned.

Examples:

Request syntax with placeholder values


resp = client.get_template({
  stack_name: "StackName",
  change_set_name: "ChangeSetNameOrId",
  template_stage: "Original", # accepts Original, Processed
})

Response structure


resp.template_body #=> String
resp.stages_available #=> Array
resp.stages_available[0] #=> String, one of "Original", "Processed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (String) —

    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.

  • :change_set_name (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 (String) —

    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.

Returns:

See Also:



5039
5040
5041
5042
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5039

def get_template(params = {}, options = {})
  req = build_request(:get_template, params)
  req.send_request(options)
end

#get_template_summary(params = {}) ⇒ Types::GetTemplateSummaryOutput

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or StackSet.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Examples:

Request syntax with placeholder values


resp = client.get_template_summary({
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  stack_name: "StackNameOrId",
  stack_set_name: "StackSetNameOrId",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
  template_summary_config: {
    treat_unrecognized_resource_types_as_warnings: false,
  },
})

Response structure


resp.parameters #=> Array
resp.parameters[0].parameter_key #=> String
resp.parameters[0].default_value #=> String
resp.parameters[0].parameter_type #=> String
resp.parameters[0].no_echo #=> Boolean
resp.parameters[0].description #=> String
resp.parameters[0].parameter_constraints.allowed_values #=> Array
resp.parameters[0].parameter_constraints.allowed_values[0] #=> String
resp.description #=> String
resp.capabilities #=> Array
resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
resp.capabilities_reason #=> String
resp.resource_types #=> Array
resp.resource_types[0] #=> String
resp.version #=> String
resp.metadata #=> String
resp.declared_transforms #=> Array
resp.declared_transforms[0] #=> String
resp.resource_identifier_summaries #=> Array
resp.resource_identifier_summaries[0].resource_type #=> String
resp.resource_identifier_summaries[0].logical_resource_ids #=> Array
resp.resource_identifier_summaries[0].logical_resource_ids[0] #=> String
resp.resource_identifier_summaries[0].resource_identifiers #=> Array
resp.resource_identifier_summaries[0].resource_identifiers[0] #=> String
resp.warnings.unrecognized_resource_types #=> Array
resp.warnings.unrecognized_resource_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_body (String) —

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. 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 (String) —

    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 (String) —

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

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

  • :call_as (String) —

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

  • :template_summary_config (Types::TemplateSummaryConfig) —

    Specifies options for the GetTemplateSummary API action.

Returns:

See Also:



5173
5174
5175
5176
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5173

def get_template_summary(params = {}, options = {})
  req = build_request(:get_template_summary, params)
  req.send_request(options)
end

#import_stacks_to_stack_set(params = {}) ⇒ Types::ImportStacksToStackSetOutput

Import existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

Examples:

Request syntax with placeholder values


resp = client.import_stacks_to_stack_set({
  stack_set_name: "StackSetNameOrId", # required
  stack_ids: ["StackId"],
  stack_ids_url: "StackIdsUrl",
  organizational_unit_ids: ["OrganizationalUnitId"],
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :stack_ids (Array<String>) —

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

    Specify either StackIds or StackIdsUrl.

  • :stack_ids_url (String) —

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

    Specify either StackIds or StackIdsUrl.

  • :organizational_unit_ids (Array<String>) —

    The list of OU ID's to which the imported stacks must be mapped as deployment targets.

  • :operation_preferences (Types::StackSetOperationPreferences) —

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

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

  • :operation_id (String) —

    A unique, user defined, identifier for the StackSet operation.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :call_as (String) —

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

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

    • For service managed StackSets, specify DELEGATED_ADMIN.

Returns:

See Also:



5260
5261
5262
5263
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5260

def import_stacks_to_stack_set(params = {}, options = {})
  req = build_request(:import_stacks_to_stack_set, params)
  req.send_request(options)
end

#list_change_sets(params = {}) ⇒ Types::ListChangeSetsOutput

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_change_sets({
  stack_name: "StackNameOrId", # required
  next_token: "NextToken",
})

Response structure


resp.summaries #=> Array
resp.summaries[0].stack_id #=> String
resp.summaries[0].stack_name #=> String
resp.summaries[0].change_set_id #=> String
resp.summaries[0].change_set_name #=> String
resp.summaries[0].execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "FAILED"
resp.summaries[0].status_reason #=> String
resp.summaries[0].creation_time #=> Time
resp.summaries[0].description #=> String
resp.summaries[0].include_nested_stacks #=> Boolean
resp.summaries[0].parent_change_set_id #=> String
resp.summaries[0].root_change_set_id #=> String
resp.summaries[0].import_existing_resources #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



5313
5314
5315
5316
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5313

def list_change_sets(params = {}, options = {})
  req = build_request(:list_change_sets, params)
  req.send_request(options)
end

#list_exports(params = {}) ⇒ Types::ListExportsOutput

Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.

For more information, see Get exported outputs from a deployed CloudFormation stack.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_exports({
  next_token: "NextToken",
})

Response structure


resp.exports #=> Array
resp.exports[0].exporting_stack_id #=> String
resp.exports[0].name #=> String
resp.exports[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



5360
5361
5362
5363
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5360

def list_exports(params = {}, options = {})
  req = build_request(:list_exports, params)
  req.send_request(options)
end

#list_generated_templates(params = {}) ⇒ Types::ListGeneratedTemplatesOutput

Lists your generated templates in this Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list generated templates


# This example lists the generated templates.

resp = client.list_generated_templates({
})

resp.to_h outputs the following:
{
  summaries: [
    {
      creation_time: Time.parse("2023-12-28T17:55:20.086000+00:00"), 
      generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/abcdefghi-1234-abcd-abcd-abcdefgh1234567", 
      generated_template_name: "Template3", 
      last_updated_time: Time.parse("2023-12-28T17:57:16.610000+00:00"), 
      number_of_resources: 85, 
      status: "COMPLETE", 
      status_reason: "All resources complete", 
    }, 
    {
      creation_time: Time.parse("2023-12-21T01:51:07.764000+00:00"), 
      generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/bbcdefghi-1234-abcd-abcd-abcdefgh1234567", 
      generated_template_name: "Template2", 
      last_updated_time: Time.parse("2023-12-21T01:51:22.664000+00:00"), 
      number_of_resources: 12, 
      status: "COMPLETE", 
      status_reason: "All resources complete", 
    }, 
    {
      creation_time: Time.parse("2023-11-20T23:53:28.722000+00:00"), 
      generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/cbcdefghi-1234-abcd-abcd-abcdefgh1234567", 
      generated_template_name: "Template1", 
      last_updated_time: Time.parse("2023-11-21T04:25:30.527000+00:00"), 
      number_of_resources: 19, 
      status: "COMPLETE", 
      status_reason: "All resources complete", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_generated_templates({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.summaries #=> Array
resp.summaries[0].generated_template_id #=> String
resp.summaries[0].generated_template_name #=> String
resp.summaries[0].status #=> String, one of "CREATE_PENDING", "UPDATE_PENDING", "DELETE_PENDING", "CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "COMPLETE"
resp.summaries[0].status_reason #=> String
resp.summaries[0].creation_time #=> Time
resp.summaries[0].last_updated_time #=> Time
resp.summaries[0].number_of_resources #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



5449
5450
5451
5452
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5449

def list_generated_templates(params = {}, options = {})
  req = build_request(:list_generated_templates, params)
  req.send_request(options)
end

#list_hook_results(params = {}) ⇒ Types::ListHookResultsOutput

Returns summaries of invoked Hooks. For more information, see View invocation summaries for CloudFormation Hooks in the CloudFormation Hooks User Guide.

This operation supports the following parameter combinations:

  • No parameters: Returns all Hook invocation summaries.

  • TypeArn only: Returns summaries for a specific Hook.

  • TypeArn and Status: Returns summaries for a specific Hook filtered by status.

  • TargetId and TargetType: Returns summaries for a specific Hook invocation target.

Examples:

Request syntax with placeholder values


resp = client.list_hook_results({
  target_type: "CHANGE_SET", # accepts CHANGE_SET, STACK, RESOURCE, CLOUD_CONTROL
  target_id: "HookResultId",
  type_arn: "HookTypeArn",
  status: "HOOK_IN_PROGRESS", # accepts HOOK_IN_PROGRESS, HOOK_COMPLETE_SUCCEEDED, HOOK_COMPLETE_FAILED, HOOK_FAILED
  next_token: "NextToken",
})

Response structure


resp.target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
resp.target_id #=> String
resp.hook_results #=> Array
resp.hook_results[0].hook_result_id #=> String
resp.hook_results[0].invocation_point #=> String, one of "PRE_PROVISION"
resp.hook_results[0].failure_mode #=> String, one of "FAIL", "WARN"
resp.hook_results[0].type_name #=> String
resp.hook_results[0].type_version_id #=> String
resp.hook_results[0].type_configuration_version_id #=> String
resp.hook_results[0].status #=> String, one of "HOOK_IN_PROGRESS", "HOOK_COMPLETE_SUCCEEDED", "HOOK_COMPLETE_FAILED", "HOOK_FAILED"
resp.hook_results[0].hook_status_reason #=> String
resp.hook_results[0].invoked_at #=> Time
resp.hook_results[0].target_type #=> String, one of "CHANGE_SET", "STACK", "RESOURCE", "CLOUD_CONTROL"
resp.hook_results[0].target_id #=> String
resp.hook_results[0].type_arn #=> String
resp.hook_results[0].hook_execution_target #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_type (String) —

    Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

    Required when TargetId is specified and cannot be used otherwise.

  • :target_id (String) —

    Filters results by the unique identifier of the target the Hook was invoked against.

    For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the HookRequestToken returned by the Cloud Control API request. For more information on the HookRequestToken, see ProgressEvent.

    Required when TargetType is specified and cannot be used otherwise.

  • :type_arn (String) —

    Filters results by the ARN of the Hook. Can be used alone or in combination with Status.

  • :status (String) —

    Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

    • HOOK_IN_PROGRESS: The Hook is currently running.

    • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

    • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

    • HOOK_FAILED: The Hook encountered an error during execution.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



5556
5557
5558
5559
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5556

def list_hook_results(params = {}, options = {})
  req = build_request(:list_hook_results, params)
  req.send_request(options)
end

#list_imports(params = {}) ⇒ Types::ListImportsOutput

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue function.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_imports({
  export_name: "ExportName", # required
  next_token: "NextToken",
})

Response structure


resp.imports #=> Array
resp.imports[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :export_name (required, String) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



5605
5606
5607
5608
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5605

def list_imports(params = {}, options = {})
  req = build_request(:list_imports, params)
  req.send_request(options)
end

#list_resource_scan_related_resources(params = {}) ⇒ Types::ListResourceScanRelatedResourcesOutput

Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list resource scan related resources


# This example lists the resources related to the passed in resources

resp = client.list_resource_scan_related_resources({
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
  resources: [
    {
      resource_identifier: {
        "BucketName" => "jazz-bucket", 
      }, 
      resource_type: "AWS::S3::Bucket", 
    }, 
    {
      resource_identifier: {
        "DhcpOptionsId" => "random-id123", 
      }, 
      resource_type: "AWS::EC2::DHCPOptions", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  related_resources: [
    {
      managed_by_stack: false, 
      resource_identifier: {
        "DhcpOptionsId" => "dopt-98765edcba", 
        "VpcId" => "vpc-0123456abcdefg", 
      }, 
      resource_type: "AWS::EC2::VPCDHCPOptionsAssociation", 
    }, 
    {
      managed_by_stack: false, 
      resource_identifier: {
        "VpcId" => "vpc-0123456abcdefgabc", 
      }, 
      resource_type: "AWS::EC2::VPC", 
    }, 
    {
      managed_by_stack: false, 
      resource_identifier: {
        "DhcpOptionsId" => "dopt-98765edcba", 
        "VpcId" => "vpc-123456abcdef", 
      }, 
      resource_type: "AWS::EC2::VPCDHCPOptionsAssociation", 
    }, 
    {
      managed_by_stack: false, 
      resource_identifier: {
        "VpcId" => "vpc-12345678abcd", 
      }, 
      resource_type: "AWS::EC2::VPC", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_resource_scan_related_resources({
  resource_scan_id: "ResourceScanId", # required
  resources: [ # required
    {
      resource_type: "ResourceType", # required
      resource_identifier: { # required
        "JazzResourceIdentifierPropertyKey" => "JazzResourceIdentifierPropertyValue",
      },
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.related_resources #=> Array
resp.related_resources[0].resource_type #=> String
resp.related_resources[0].resource_identifier #=> Hash
resp.related_resources[0].resource_identifier["JazzResourceIdentifierPropertyKey"] #=> String
resp.related_resources[0].managed_by_stack #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_scan_id (required, String) —

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

  • :resources (required, Array<Types::ScannedResourceIdentifier>) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



5727
5728
5729
5730
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5727

def list_resource_scan_related_resources(params = {}, options = {})
  req = build_request(:list_resource_scan_related_resources, params)
  req.send_request(options)
end

#list_resource_scan_resources(params = {}) ⇒ Types::ListResourceScanResourcesOutput

Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the resources in your resource scan


# This example lists the resources in your resource scan

resp = client.list_resource_scan_resources({
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
})

resp.to_h outputs the following:
{
  next_token: "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=", 
  resources: [
    {
      managed_by_stack: false, 
      resource_identifier: {
        "Arn" => "arn:aws:amplify:us-east-1:123456789012:apps/12345678", 
      }, 
      resource_type: "AWS::Amplify::App", 
    }, 
    {
      managed_by_stack: true, 
      resource_identifier: {
        "DeploymentId" => "1234567", 
        "RestApiId" => "abcdefgh", 
      }, 
      resource_type: "AWS::ApiGateway::Deployment", 
    }, 
  ], 
}

Example: To list the resources in your resource scan for specific resource type


# This example lists the resources in your resource scan filtering only the resources that start with the passed in prefix

resp = client.list_resource_scan_resources({
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
  resource_type_prefix: "AWS::S3", 
})

resp.to_h outputs the following:
{
  next_token: "AQICAHjOiFofVZCZ0aEN1VnF1m9jq/xxpTY7MyPexz72BHuAkgETVS8c+PVCFpE6uGVJDxCFAAACbjCCAmoGCSqGSIb3DQEHBqCCAlswggJXAgEAMIICUAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAwJ9QJAYeDzUoBeimECARCAggIh8brcL6H6uMvcZafRTB79hUkdJlOoFavrhYA2U7qdlPUwyvaVqN2DvFMxsl2XC1SaWmr5esMKxg1fLjbOEF32lVQn0Jp8QuoFUvREnqEsR32ZQmiI/Oc9HmwIr/BS3rzljki2Kr8Y0nriS7aFDLUCYsdsRdQ9iL5/iCc6oW7IisCzq1VKcHijlXvuiEipZAinsxEbmYBjmWgT7UYZdrrb6Hq3COEgPzS490ucndtwPjyvuCIMiAfTLMuBgjkzEfp4U97aLwPWaiKw94dMXj/3K67uuH9BjWZO+j6d3nnyZ14FOgI7SQvvVBnxARbTmINttHWjXPrIuE9YuuSWgn6GmuzEEDqkuglOS/OeTHYSPvLPRrFieUiawblljLVoVY9/HDjL/EErSTWiCnytGXIRoMI9Ozp2Yjfm3MBwSDXvMIrscw6QAa3bUA6uJSV2skCBnDoqV8EXd8umh788OgEtDxQ7d/NlUYEhN6AJ0K9TVz/2rZgOlzLCmtvmbIy7loAZCmf/uPNkyu6WuoLWTzQz78SnA8jWPKnxrzhNyPuaIgUH23U3mExhfMRDczitpOo5JM81oHVPECslGoqktLhP55BQqMbJy4w16SZJfr993TXhF5jOZenRN1zDsK3J5cLdJgPK1Ds1Z9DnRKMfXOqoAyme2l94/h0kLIxgAtxOeJFP/g/9hUtt1qGkZeV3Xqw1nkFQnafGIg4fJoWg74Sr7yo=", 
  resources: [
    {
      managed_by_stack: true, 
      resource_identifier: {
        "Name" => "test-access-point", 
      }, 
      resource_type: "AWS::S3::AccessPoint", 
    }, 
    {
      managed_by_stack: false, 
      resource_identifier: {
        "Bucket" => "a-random-bucket", 
      }, 
      resource_type: "AWS::S3::BucketPolicy", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_resource_scan_resources({
  resource_scan_id: "ResourceScanId", # required
  resource_identifier: "ResourceIdentifier",
  resource_type_prefix: "ResourceTypePrefix",
  tag_key: "TagKey",
  tag_value: "TagValue",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.resources #=> Array
resp.resources[0].resource_type #=> String
resp.resources[0].resource_identifier #=> Hash
resp.resources[0].resource_identifier["JazzResourceIdentifierPropertyKey"] #=> String
resp.resources[0].managed_by_stack #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_scan_id (required, String) —

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

  • :resource_identifier (String) —

    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 (String) —

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

  • :tag_key (String) —

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

  • :tag_value (String) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



5860
5861
5862
5863
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5860

def list_resource_scan_resources(params = {}, options = {})
  req = build_request(:list_resource_scan_resources, params)
  req.send_request(options)
end

#list_resource_scans(params = {}) ⇒ Types::ListResourceScansOutput

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: Listing Resource Scans


# This example shows how to list resource scans

resp = client.list_resource_scans({
})

resp.to_h outputs the following:
{
  resource_scan_summaries: [
    {
      percentage_completed: 37.4, 
      resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/51448627-817f-40f0-b37c-f6e0f974340c", 
      start_time: Time.parse("2024-01-24T00:33:29.673000+00:00"), 
      status: "IN_PROGRESS", 
    }, 
    {
      end_time: Time.parse("2024-01-02T23:25:48.075000+00:00"), 
      percentage_completed: 100.0, 
      resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1", 
      start_time: Time.parse("2024-01-02T22:15:18.382000+00:00"), 
      status: "COMPLETE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_resource_scans({
  next_token: "NextToken",
  max_results: 1,
  scan_type_filter: "FULL", # accepts FULL, PARTIAL
})

Response structure


resp.resource_scan_summaries #=> Array
resp.resource_scan_summaries[0].resource_scan_id #=> String
resp.resource_scan_summaries[0].status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETE", "EXPIRED"
resp.resource_scan_summaries[0].status_reason #=> String
resp.resource_scan_summaries[0].start_time #=> Time
resp.resource_scan_summaries[0].end_time #=> Time
resp.resource_scan_summaries[0].percentage_completed #=> Float
resp.resource_scan_summaries[0].scan_type #=> String, one of "FULL", "PARTIAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

  • :scan_type_filter (String) —

    The scan type that you want to get summary information about. The default is FULL.

Returns:

See Also:



5940
5941
5942
5943
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 5940

def list_resource_scans(params = {}, options = {})
  req = build_request(:list_resource_scans, params)
  req.send_request(options)
end

#list_stack_instance_resource_drifts(params = {}) ⇒ Types::ListStackInstanceResourceDriftsOutput

Returns drift information for resources in a stack instance.

ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.

Examples:

Request syntax with placeholder values


resp = client.list_stack_instance_resource_drifts({
  stack_set_name: "StackSetNameOrId", # required
  next_token: "NextToken",
  max_results: 1,
  stack_instance_resource_drift_statuses: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED, UNKNOWN, UNSUPPORTED
  stack_instance_account: "Account", # required
  stack_instance_region: "Region", # required
  operation_id: "ClientRequestToken", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.summaries #=> Array
resp.summaries[0].stack_id #=> String
resp.summaries[0].logical_resource_id #=> String
resp.summaries[0].physical_resource_id #=> String
resp.summaries[0].physical_resource_id_context #=> Array
resp.summaries[0].physical_resource_id_context[0].key #=> String
resp.summaries[0].physical_resource_id_context[0].value #=> String
resp.summaries[0].resource_type #=> String
resp.summaries[0].property_differences #=> Array
resp.summaries[0].property_differences[0].property_path #=> String
resp.summaries[0].property_differences[0].expected_value #=> String
resp.summaries[0].property_differences[0].actual_value #=> String
resp.summaries[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
resp.summaries[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.summaries[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (Array<String>) —

    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 (required, String) —

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

  • :stack_instance_region (required, String) —

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

  • :operation_id (required, String) —

    The unique ID of the drift operation.

  • :call_as (String) —

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

Returns:

See Also:



6054
6055
6056
6057
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6054

def list_stack_instance_resource_drifts(params = {}, options = {})
  req = build_request(:list_stack_instance_resource_drifts, params)
  req.send_request(options)
end

#list_stack_instances(params = {}) ⇒ Types::ListStackInstancesOutput

Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_instances({
  stack_set_name: "StackSetName", # required
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      name: "DETAILED_STATUS", # accepts DETAILED_STATUS, LAST_OPERATION_ID, DRIFT_STATUS
      values: "StackInstanceFilterValues",
    },
  ],
  stack_instance_account: "Account",
  stack_instance_region: "Region",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.summaries #=> Array
resp.summaries[0].stack_set_id #=> String
resp.summaries[0].region #=> String
resp.summaries[0]. #=> String
resp.summaries[0].stack_id #=> String
resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
resp.summaries[0].status_reason #=> String
resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE", "SKIPPED_SUSPENDED_ACCOUNT", "FAILED_IMPORT"
resp.summaries[0].organizational_unit_id #=> String
resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.summaries[0].last_drift_check_timestamp #=> Time
resp.summaries[0].last_operation_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (Array<Types::StackInstanceFilter>) —

    The filter to apply to stack instances

  • :stack_instance_account (String) —

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

  • :stack_instance_region (String) —

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

  • :call_as (String) —

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

Returns:

See Also:



6154
6155
6156
6157
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6154

def list_stack_instances(params = {}, options = {})
  req = build_request(:list_stack_instances, params)
  req.send_request(options)
end

#list_stack_refactor_actions(params = {}) ⇒ Types::ListStackRefactorActionsOutput

Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_refactor_actions({
  stack_refactor_id: "StackRefactorId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.stack_refactor_actions #=> Array
resp.stack_refactor_actions[0].action #=> String, one of "MOVE", "CREATE"
resp.stack_refactor_actions[0].entity #=> String, one of "RESOURCE", "STACK"
resp.stack_refactor_actions[0].physical_resource_id #=> String
resp.stack_refactor_actions[0].resource_identifier #=> String
resp.stack_refactor_actions[0].description #=> String
resp.stack_refactor_actions[0].detection #=> String, one of "AUTO", "MANUAL"
resp.stack_refactor_actions[0].detection_reason #=> String
resp.stack_refactor_actions[0].tag_resources #=> Array
resp.stack_refactor_actions[0].tag_resources[0].key #=> String
resp.stack_refactor_actions[0].tag_resources[0].value #=> String
resp.stack_refactor_actions[0].untag_resources #=> Array
resp.stack_refactor_actions[0].untag_resources[0] #=> String
resp.stack_refactor_actions[0].resource_mapping.source.stack_name #=> String
resp.stack_refactor_actions[0].resource_mapping.source.logical_resource_id #=> String
resp.stack_refactor_actions[0].resource_mapping.destination.stack_name #=> String
resp.stack_refactor_actions[0].resource_mapping.destination.logical_resource_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_refactor_id (required, String) —

    The ID associated with the stack refactor created from the CreateStackRefactor action.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



6216
6217
6218
6219
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6216

def list_stack_refactor_actions(params = {}, options = {})
  req = build_request(:list_stack_refactor_actions, params)
  req.send_request(options)
end

#list_stack_refactors(params = {}) ⇒ Types::ListStackRefactorsOutput

Lists all account stack refactor operations and their statuses.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_refactors({
  execution_status_filter: ["UNAVAILABLE"], # accepts UNAVAILABLE, AVAILABLE, OBSOLETE, EXECUTE_IN_PROGRESS, EXECUTE_COMPLETE, EXECUTE_FAILED, ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETE, ROLLBACK_FAILED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.stack_refactor_summaries #=> Array
resp.stack_refactor_summaries[0].stack_refactor_id #=> String
resp.stack_refactor_summaries[0].description #=> String
resp.stack_refactor_summaries[0].execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "OBSOLETE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.stack_refactor_summaries[0].execution_status_reason #=> String
resp.stack_refactor_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
resp.stack_refactor_summaries[0].status_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :execution_status_filter (Array<String>) —

    Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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.

Returns:

See Also:



6268
6269
6270
6271
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6268

def list_stack_refactors(params = {}, options = {})
  req = build_request(:list_stack_refactors, params)
  req.send_request(options)
end

#list_stack_resources(params = {}) ⇒ Types::ListStackResourcesOutput

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_resources({
  stack_name: "StackName", # required
  next_token: "NextToken",
})

Response structure


resp.stack_resource_summaries #=> Array
resp.stack_resource_summaries[0].logical_resource_id #=> String
resp.stack_resource_summaries[0].physical_resource_id #=> String
resp.stack_resource_summaries[0].resource_type #=> String
resp.stack_resource_summaries[0].last_updated_timestamp #=> Time
resp.stack_resource_summaries[0].resource_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE", "IMPORT_FAILED", "IMPORT_COMPLETE", "IMPORT_IN_PROGRESS", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", "EXPORT_FAILED", "EXPORT_COMPLETE", "EXPORT_IN_PROGRESS", "EXPORT_ROLLBACK_IN_PROGRESS", "EXPORT_ROLLBACK_FAILED", "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", "ROLLBACK_IN_PROGRESS", "ROLLBACK_COMPLETE", "ROLLBACK_FAILED"
resp.stack_resource_summaries[0].resource_status_reason #=> String
resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED", "UNKNOWN", "UNSUPPORTED"
resp.stack_resource_summaries[0].drift_information.last_check_timestamp #=> Time
resp.stack_resource_summaries[0].module_info.type_hierarchy #=> String
resp.stack_resource_summaries[0].module_info.logical_id_hierarchy #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    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.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



6324
6325
6326
6327
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6324

def list_stack_resources(params = {}, options = {})
  req = build_request(:list_stack_resources, params)
  req.send_request(options)
end

#list_stack_set_auto_deployment_targets(params = {}) ⇒ Types::ListStackSetAutoDeploymentTargetsOutput

Returns summary information about deployment targets for a StackSet.

Examples:

Request syntax with placeholder values


resp = client.list_stack_set_auto_deployment_targets({
  stack_set_name: "StackSetNameOrId", # required
  next_token: "NextToken",
  max_results: 1,
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.summaries #=> Array
resp.summaries[0].organizational_unit_id #=> String
resp.summaries[0].regions #=> Array
resp.summaries[0].regions[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

    The name or unique ID of the StackSet that you want to get automatic deployment targets for.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (String) —

    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.

Returns:

See Also:



6393
6394
6395
6396
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6393

def list_stack_set_auto_deployment_targets(params = {}, options = {})
  req = build_request(:list_stack_set_auto_deployment_targets, params)
  req.send_request(options)
end

#list_stack_set_operation_results(params = {}) ⇒ Types::ListStackSetOperationResultsOutput

Returns summary information about the results of a StackSet operation.

This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_set_operation_results({
  stack_set_name: "StackSetName", # required
  operation_id: "ClientRequestToken", # required
  next_token: "NextToken",
  max_results: 1,
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
  filters: [
    {
      name: "OPERATION_RESULT_STATUS", # accepts OPERATION_RESULT_STATUS
      values: "OperationResultFilterValues",
    },
  ],
})

Response structure


resp.summaries #=> Array
resp.summaries[0]. #=> String
resp.summaries[0].region #=> String
resp.summaries[0].status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
resp.summaries[0].status_reason #=> String
resp.summaries[0]..status #=> String, one of "SUCCEEDED", "FAILED", "SKIPPED"
resp.summaries[0]..status_reason #=> String
resp.summaries[0].organizational_unit_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

    The name or unique ID of the StackSet that you want to get operation results for.

  • :operation_id (required, String) —

    The ID of the StackSet operation.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (String) —

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

  • :filters (Array<Types::OperationResultFilter>) —

    The filter to apply to operation results.

Returns:

See Also:



6486
6487
6488
6489
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6486

def list_stack_set_operation_results(params = {}, options = {})
  req = build_request(:list_stack_set_operation_results, params)
  req.send_request(options)
end

#list_stack_set_operations(params = {}) ⇒ Types::ListStackSetOperationsOutput

Returns summary information about operations performed on a StackSet.

This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_set_operations({
  stack_set_name: "StackSetName", # required
  next_token: "NextToken",
  max_results: 1,
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.summaries #=> Array
resp.summaries[0].operation_id #=> String
resp.summaries[0].action #=> String, one of "CREATE", "UPDATE", "DELETE", "DETECT_DRIFT"
resp.summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
resp.summaries[0].creation_timestamp #=> Time
resp.summaries[0].end_timestamp #=> Time
resp.summaries[0].status_reason #=> String
resp.summaries[0].status_details.failed_stack_instances_count #=> Integer
resp.summaries[0].operation_preferences.region_concurrency_type #=> String, one of "SEQUENTIAL", "PARALLEL"
resp.summaries[0].operation_preferences.region_order #=> Array
resp.summaries[0].operation_preferences.region_order[0] #=> String
resp.summaries[0].operation_preferences.failure_tolerance_count #=> Integer
resp.summaries[0].operation_preferences.failure_tolerance_percentage #=> Integer
resp.summaries[0].operation_preferences.max_concurrent_count #=> Integer
resp.summaries[0].operation_preferences.max_concurrent_percentage #=> Integer
resp.summaries[0].operation_preferences.concurrency_mode #=> String, one of "STRICT_FAILURE_TOLERANCE", "SOFT_FAILURE_TOLERANCE"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

    The name or unique ID of the StackSet that you want to get operation summaries for.

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (String) —

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

Returns:

See Also:



6574
6575
6576
6577
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6574

def list_stack_set_operations(params = {}, options = {})
  req = build_request(:list_stack_set_operations, params)
  req.send_request(options)
end

#list_stack_sets(params = {}) ⇒ Types::ListStackSetsOutput

Returns summary information about StackSets that are associated with the user.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

  • [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed StackSets in your Amazon Web Services account.

  • [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all StackSets in the management account.

  • [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all StackSets with service-managed permissions in the management account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stack_sets({
  next_token: "NextToken",
  max_results: 1,
  status: "ACTIVE", # accepts ACTIVE, DELETED
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.summaries #=> Array
resp.summaries[0].stack_set_name #=> String
resp.summaries[0].stack_set_id #=> String
resp.summaries[0].description #=> String
resp.summaries[0].status #=> String, one of "ACTIVE", "DELETED"
resp.summaries[0].auto_deployment.enabled #=> Boolean
resp.summaries[0].auto_deployment. #=> Boolean
resp.summaries[0].auto_deployment.depends_on #=> Array
resp.summaries[0].auto_deployment.depends_on[0] #=> String
resp.summaries[0].permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.summaries[0].last_drift_check_timestamp #=> Time
resp.summaries[0].managed_execution.active #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_results (Integer) —

    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 (String) —

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

  • :call_as (String) —

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

Returns:

See Also:



6674
6675
6676
6677
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6674

def list_stack_sets(params = {}, options = {})
  req = build_request(:list_stack_sets, params)
  req.send_request(options)
end

#list_stacks(params = {}) ⇒ Types::ListStacksOutput

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_stacks({
  next_token: "NextToken",
  stack_status_filter: ["CREATE_IN_PROGRESS"], # accepts CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, REVIEW_IN_PROGRESS, IMPORT_IN_PROGRESS, IMPORT_COMPLETE, IMPORT_ROLLBACK_IN_PROGRESS, IMPORT_ROLLBACK_FAILED, IMPORT_ROLLBACK_COMPLETE
})

Response structure


resp.stack_summaries #=> Array
resp.stack_summaries[0].stack_id #=> String
resp.stack_summaries[0].stack_name #=> String
resp.stack_summaries[0].template_description #=> String
resp.stack_summaries[0].creation_time #=> Time
resp.stack_summaries[0].last_updated_time #=> Time
resp.stack_summaries[0].deletion_time #=> Time
resp.stack_summaries[0].stack_status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "REVIEW_IN_PROGRESS", "IMPORT_IN_PROGRESS", "IMPORT_COMPLETE", "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE"
resp.stack_summaries[0].stack_status_reason #=> String
resp.stack_summaries[0].parent_id #=> String
resp.stack_summaries[0].root_id #=> String
resp.stack_summaries[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
resp.stack_summaries[0].drift_information.last_check_timestamp #=> Time
resp.stack_summaries[0].last_operations #=> Array
resp.stack_summaries[0].last_operations[0].operation_type #=> String, one of "CREATE_STACK", "UPDATE_STACK", "DELETE_STACK", "CONTINUE_ROLLBACK", "ROLLBACK", "CREATE_CHANGESET"
resp.stack_summaries[0].last_operations[0].operation_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :stack_status_filter (Array<String>) —

    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.

Returns:

See Also:



6734
6735
6736
6737
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6734

def list_stacks(params = {}, options = {})
  req = build_request(:list_stacks, params)
  req.send_request(options)
end

#list_type_registrations(params = {}) ⇒ Types::ListTypeRegistrationsOutput

Returns a list of registration tokens for the specified extension(s).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_type_registrations({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  type_arn: "TypeArn",
  registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.registration_token_list #=> Array
resp.registration_token_list[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The kind of extension.

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

  • :type_name (String) —

    The name of the extension.

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

  • :type_arn (String) —

    The Amazon Resource Name (ARN) of the extension.

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

  • :registration_status_filter (String) —

    The current status of the extension registration request.

    The default is IN_PROGRESS.

  • :max_results (Integer) —

    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 (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



6799
6800
6801
6802
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6799

def list_type_registrations(params = {}, options = {})
  req = build_request(:list_type_registrations, params)
  req.send_request(options)
end

#list_type_versions(params = {}) ⇒ Types::ListTypeVersionsOutput

Returns summary information about the versions of an extension.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_type_versions({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  arn: "TypeArn",
  max_results: 1,
  next_token: "NextToken",
  deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
  publisher_id: "PublisherId",
})

Response structure


resp.type_version_summaries #=> Array
resp.type_version_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
resp.type_version_summaries[0].type_name #=> String
resp.type_version_summaries[0].version_id #=> String
resp.type_version_summaries[0].is_default_version #=> Boolean
resp.type_version_summaries[0].arn #=> String
resp.type_version_summaries[0].time_created #=> Time
resp.type_version_summaries[0].description #=> String
resp.type_version_summaries[0].public_version_number #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The kind of the extension.

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

  • :type_name (String) —

    The name of the extension for which you want version summary information.

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

  • :arn (String) —

    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 (Integer) —

    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 (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

  • :deprecated_status (String) —

    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 (String) —

    The publisher ID of the extension publisher.

    Extensions published by Amazon aren't assigned a publisher ID.

Returns:

See Also:



6889
6890
6891
6892
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 6889

def list_type_versions(params = {}, options = {})
  req = build_request(:list_type_versions, params)
  req.send_request(options)
end

#list_types(params = {}) ⇒ Types::ListTypesOutput

Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_types({
  visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
  provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
  deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  filters: {
    category: "REGISTERED", # accepts REGISTERED, ACTIVATED, THIRD_PARTY, AWS_TYPES
    publisher_id: "PublisherId",
    type_name_prefix: "TypeNamePrefix",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.type_summaries #=> Array
resp.type_summaries[0].type #=> String, one of "RESOURCE", "MODULE", "HOOK"
resp.type_summaries[0].type_name #=> String
resp.type_summaries[0].default_version_id #=> String
resp.type_summaries[0].type_arn #=> String
resp.type_summaries[0].last_updated #=> Time
resp.type_summaries[0].description #=> String
resp.type_summaries[0].publisher_id #=> String
resp.type_summaries[0].original_type_name #=> String
resp.type_summaries[0].public_version_number #=> String
resp.type_summaries[0].latest_public_version #=> String
resp.type_summaries[0].publisher_identity #=> String, one of "AWS_Marketplace", "GitHub", "Bitbucket"
resp.type_summaries[0].publisher_name #=> String
resp.type_summaries[0].is_activated #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :visibility (String) —

    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 and third-party publishers.

    The default is PRIVATE.

  • :provisioning_type (String) —

    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 (String) —

    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.

  • :type (String) —

    The type of extension.

  • :filters (Types::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 (Integer) —

    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 (String) —

    The token for the next set of items to return. (You received this token from a previous call.)

Returns:

See Also:



7016
7017
7018
7019
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7016

def list_types(params = {}, options = {})
  req = build_request(:list_types, params)
  req.send_request(options)
end

#publish_type(params = {}) ⇒ Types::PublishTypeOutput

Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Examples:

Request syntax with placeholder values


resp = client.publish_type({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  arn: "PrivateTypeArn",
  type_name: "TypeName",
  public_version_number: "PublicVersionNumber",
})

Response structure


resp.public_type_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The type of the extension.

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

  • :arn (String) —

    The Amazon Resource Name (ARN) of the extension.

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

  • :type_name (String) —

    The name of the extension.

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

  • :public_version_number (String) —

    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.

Returns:

See Also:



7093
7094
7095
7096
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7093

def publish_type(params = {}, options = {})
  req = build_request(:publish_type, params)
  req.send_request(options)
end

#record_handler_progress(params = {}) ⇒ Struct

Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI. Don't use this API in your code.

Examples:

Request syntax with placeholder values


resp = client.record_handler_progress({
  bearer_token: "ClientToken", # required
  operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
  current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
  status_message: "StatusMessage",
  error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure, InvalidTypeConfiguration, HandlerInternalFailure, NonCompliant, Unknown, UnsupportedTarget
  resource_model: "ResourceModel",
  client_request_token: "ClientRequestToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7174
7175
7176
7177
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7174

def record_handler_progress(params = {}, options = {})
  req = build_request(:record_handler_progress, params)
  req.send_request(options)
end

#register_publisher(params = {}) ⇒ Types::RegisterPublisherOutput

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

Examples:

Request syntax with placeholder values


resp = client.register_publisher({
  accept_terms_and_conditions: false,
  connection_arn: "ConnectionArn",
})

Response structure


resp.publisher_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :accept_terms_and_conditions (Boolean) —

    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 (String) —

    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 Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

Returns:

See Also:



7239
7240
7241
7242
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7239

def register_publisher(params = {}, options = {})
  req = build_request(:register_publisher, params)
  req.send_request(options)
end

#register_type(params = {}) ⇒ Types::RegisterTypeOutput

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

  • Validating the extension schema.

  • Determining which handlers, if any, have been specified for the extension.

  • Making the extension available for use in your account.

For more information about how to develop extensions and ready them for registration, see Creating resource types using the CloudFormation CLI in the CloudFormation Command Line Interface (CLI) User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.register_type({
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName", # required
  schema_handler_package: "S3Url", # required
  logging_config: {
    log_role_arn: "RoleArn", # required
    log_group_name: "LogGroupName", # required
  },
  execution_role_arn: "RoleArn",
  client_request_token: "RequestToken",
})

Response structure


resp.registration_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type (String) —

    The kind of extension.

  • :type_name (required, String) —

    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 (required, String) —

    A URL to the S3 bucket that contains 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 Command Line Interface (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 (Types::LoggingConfig) —

    Specifies logging configuration information for an extension.

  • :execution_role_arn (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 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 (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 registration request, even if the request is submitted multiple times.

Returns:

See Also:



7397
7398
7399
7400
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7397

def register_type(params = {}, options = {})
  req = build_request(:register_type, params)
  req.send_request(options)
end

#rollback_stack(params = {}) ⇒ Types::RollbackStackOutput

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE

  • UPDATE_COMPLETE

  • UPDATE_ROLLBACK_COMPLETE

  • IMPORT_COMPLETE

  • IMPORT_ROLLBACK_COMPLETE

Examples:

Request syntax with placeholder values


resp = client.rollback_stack({
  stack_name: "StackNameOrId", # required
  role_arn: "RoleARN",
  client_request_token: "ClientRequestToken",
  retain_except_on_create: false,
})

Response structure


resp.stack_id #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    The name that's associated with the stack.

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.

  • :client_request_token (String) —

    A unique identifier for this RollbackStack request.

  • :retain_except_on_create (Boolean) —

    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

Returns:

See Also:



7463
7464
7465
7466
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7463

def rollback_stack(params = {}, options = {})
  req = build_request(:rollback_stack, params)
  req.send_request(options)
end

#set_stack_policy(params = {}) ⇒ Struct

Sets a stack policy for a specified stack.

Examples:

Request syntax with placeholder values


resp = client.set_stack_policy({
  stack_name: "StackName", # required
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    The name or unique stack ID that you want to associate a policy with.

  • :stack_policy_body (String) —

    Structure that contains the stack policy body. For more information, see 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 (String) —

    Location of a file that contains 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://. URLs from S3 static websites are not supported.

    You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7507
7508
7509
7510
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7507

def set_stack_policy(params = {}, options = {})
  req = build_request(:set_stack_policy, params)
  req.send_request(options)
end

#set_type_configuration(params = {}) ⇒ Types::SetTypeConfigurationOutput

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see Specify values stored in other services using dynamic references in the CloudFormation User Guide.

For more information about setting the configuration data for resource types, see Defining the account-level configuration of an extension in the CloudFormation Command Line Interface (CLI) User Guide. For more information about setting the configuration data for Hooks, see the CloudFormation Hooks User Guide.

Examples:

Request syntax with placeholder values


resp = client.set_type_configuration({
  type_arn: "TypeArn",
  configuration: "TypeConfiguration", # required
  configuration_alias: "TypeConfigurationAlias",
  type_name: "TypeName",
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
})

Response structure


resp.configuration_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :type_arn (String) —

    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 (required, String) —

    The configuration data for the extension in this account and Region.

    The configuration data must be formatted as JSON and validate against the extension's schema returned in the Schema response element of DescribeType.

  • :configuration_alias (String) —

    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 (String) —

    The name of the extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

  • :type (String) —

    The type of extension.

    Conditional: You must specify ConfigurationArn, or Type and TypeName.

Returns:

See Also:



7609
7610
7611
7612
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7609

def set_type_configuration(params = {}, options = {})
  req = build_request(:set_type_configuration, params)
  req.send_request(options)
end

#set_type_default_version(params = {}) ⇒ Struct

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

Examples:

Request syntax with placeholder values


resp = client.set_type_default_version({
  arn: "PrivateTypeArn",
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  version_id: "TypeVersionId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (String) —

    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.

  • :type (String) —

    The kind of extension.

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

  • :type_name (String) —

    The name of the extension.

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

  • :version_id (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7653
7654
7655
7656
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7653

def set_type_default_version(params = {}, options = {})
  req = build_request(:set_type_default_version, params)
  req.send_request(options)
end

#signal_resource(params = {}) ⇒ Struct

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Examples:

Request syntax with placeholder values


resp = client.signal_resource({
  stack_name: "StackNameOrId", # required
  logical_resource_id: "LogicalResourceId", # required
  unique_id: "ResourceSignalUniqueId", # required
  status: "SUCCESS", # required, accepts SUCCESS, FAILURE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

    The stack name or unique stack ID that includes the resource that you want to signal.

  • :logical_resource_id (required, String) —

    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 (required, String) —

    A unique ID of the signal. When you signal Amazon EC2 instances or Amazon EC2 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 (required, String) —

    The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7701
7702
7703
7704
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7701

def signal_resource(params = {}, options = {})
  req = build_request(:signal_resource, params)
  req.send_request(options)
end

#start_resource_scan(params = {}) ⇒ Types::StartResourceScanOutput

Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.

Examples:

Example: To start a resource scan


# This example shows how to start a new resource scan

resp = client.start_resource_scan({
})

resp.to_h outputs the following:
{
  resource_scan_id: "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/88f09db1-d211-4cb7-964b-434e2b8469ca", 
}

Request syntax with placeholder values


resp = client.start_resource_scan({
  client_request_token: "ClientRequestToken",
  scan_filters: [
    {
      types: ["ResourceTypeFilter"],
    },
  ],
})

Response structure


resp.resource_scan_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_request_token (String) —

    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.

  • :scan_filters (Array<Types::ScanFilter>) —

    The scan filters to use.

Returns:

See Also:



7753
7754
7755
7756
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7753

def start_resource_scan(params = {}, options = {})
  req = build_request(:start_resource_scan, params)
  req.send_request(options)
end

#stop_stack_set_operation(params = {}) ⇒ Struct

Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

Examples:

Request syntax with placeholder values


resp = client.stop_stack_set_operation({
  stack_set_name: "StackSetName", # required
  operation_id: "ClientRequestToken", # required
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

    The name or unique ID of the StackSet that you want to stop the operation for.

  • :operation_id (required, String) —

    The ID of the stack operation.

  • :call_as (String) —

    Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



7806
7807
7808
7809
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7806

def stop_stack_set_operation(params = {}, options = {})
  req = build_request(:stop_stack_set_operation, params)
  req.send_request(options)
end

#test_type(params = {}) ⇒ Types::TestTypeOutput

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

  • For resource types, this includes passing all contracts tests defined for the type.

  • For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see Testing your public extension before publishing in the CloudFormation Command Line Interface (CLI) User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType to monitor the current test status and test status description for the extension.

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 (CLI) User Guide.

Examples:

Request syntax with placeholder values


resp = client.test_type({
  arn: "TypeArn",
  type: "RESOURCE", # accepts RESOURCE, MODULE, HOOK
  type_name: "TypeName",
  version_id: "TypeVersionId",
  log_delivery_bucket: "S3Bucket",
})

Response structure


resp.type_version_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (String) —

    The Amazon Resource Name (ARN) of the extension.

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

  • :type (String) —

    The type of the extension to test.

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

  • :type_name (String) —

    The name of the extension to test.

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

  • :version_id (String) —

    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 (String) —

    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 Identity and Access Management User Guide.

Returns:

See Also:



7917
7918
7919
7920
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 7917

def test_type(params = {}, options = {})
  req = build_request(:test_type, params)
  req.send_request(options)
end

#update_generated_template(params = {}) ⇒ Types::UpdateGeneratedTemplateOutput

Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.

Examples:

Example: To update a generated template's name


# This example updates a generated template with a new name.

resp = client.update_generated_template({
  generated_template_name: "JazzyTemplate", 
  new_generated_template_name: "JazzierTemplate", 
})

resp.to_h outputs the following:
{
  generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca", 
}

Example: To remove resources from a generated template


# This example removes resources from a generated template

resp = client.update_generated_template({
  generated_template_name: "JazzyTemplate", 
  remove_resources: [
    "LogicalResourceId1", 
    "LogicalResourceId2", 
  ], 
})

resp.to_h outputs the following:
{
  generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca", 
}

Example: To add resources to a generated template


# This example adds resources to a generated template

resp = client.update_generated_template({
  add_resources: [
    {
      resource_identifier: {
        "BucketName" => "jazz-bucket", 
      }, 
      resource_type: "AWS::S3::Bucket", 
    }, 
    {
      resource_identifier: {
        "DhcpOptionsId" => "random-id123", 
      }, 
      resource_type: "AWS::EC2::DHCPOptions", 
    }, 
  ], 
  generated_template_name: "JazzyTemplate", 
})

resp.to_h outputs the following:
{
  generated_template_id: "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca", 
}

Request syntax with placeholder values


resp = client.update_generated_template({
  generated_template_name: "GeneratedTemplateName", # required
  new_generated_template_name: "GeneratedTemplateName",
  add_resources: [
    {
      resource_type: "ResourceType", # required
      logical_resource_id: "LogicalResourceId",
      resource_identifier: { # required
        "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
      },
    },
  ],
  remove_resources: ["LogicalResourceId"],
  refresh_all_resources: false,
  template_configuration: {
    deletion_policy: "DELETE", # accepts DELETE, RETAIN
    update_replace_policy: "DELETE", # accepts DELETE, RETAIN
  },
})

Response structure


resp.generated_template_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :generated_template_name (required, String) —

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

  • :new_generated_template_name (String) —

    An optional new name to assign to the generated template.

  • :add_resources (Array<Types::ResourceDefinition>) —

    An optional list of resources to be added to the generated template.

  • :remove_resources (Array<String>) —

    A list of logical ids for resources to remove from the generated template.

  • :refresh_all_resources (Boolean) —

    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 (Types::TemplateConfiguration) —

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

Returns:

See Also:



8045
8046
8047
8048
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8045

def update_generated_template(params = {}, options = {})
  req = build_request(:update_generated_template, params)
  req.send_request(options)
end

#update_stack(params = {}) ⇒ Types::UpdateStackOutput

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.

Examples:

Request syntax with placeholder values


resp = client.update_stack({
  stack_name: "StackName", # required
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  use_previous_template: false,
  stack_policy_during_update_body: "StackPolicyDuringUpdateBody",
  stack_policy_during_update_url: "StackPolicyDuringUpdateURL",
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  resource_types: ["ResourceType"],
  role_arn: "RoleARN",
  rollback_configuration: {
    rollback_triggers: [
      {
        arn: "Arn", # required
        type: "Type", # required
      },
    ],
    monitoring_time_in_minutes: 1,
  },
  stack_policy_body: "StackPolicyBody",
  stack_policy_url: "StackPolicyURL",
  notification_arns: ["NotificationARN"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  disable_rollback: false,
  client_request_token: "ClientRequestToken",
  retain_except_on_create: false,
})

Response structure


resp.stack_id #=> String
resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_name (required, String) —

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

  • :template_body (String) —

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. 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 (Boolean) —

    Reuse the existing template that is associated with the stack that you are updating.

    When using templates with the AWS::LanguageExtensions transform, provide the template instead of using UsePreviousTemplate to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see AWS::LanguageExtensions transform.

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

  • :stack_policy_during_update_body (String) —

    Structure that contains 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 (String) —

    Location of a file that contains 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://. URLs from S3 static websites are not supported.

    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 (Array<Types::Parameter>) —

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

  • :capabilities (Array<String>) —

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

    • 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 Perform custom processing on CloudFormation templates with template macros.

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

  • :resource_types (Array<String>) —

    Specifies which resource types you can work with, such as AWS::EC2::Instance 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. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control CloudFormation access with Identity and Access Management.

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

  • :role_arn (String) —

    The Amazon Resource Name (ARN) of an 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 (Types::RollbackConfiguration) —

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

  • :stack_policy_body (String) —

    Structure that contains 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 (String) —

    Location of a file that contains 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://. URLs from S3 static websites are not supported.

    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 (Array<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 (Array<Types::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 (Boolean) —

    Preserve the state of previously provisioned resources when an operation fails.

    Default: False

  • :client_request_token (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.

  • :retain_except_on_create (Boolean) —

    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

Returns:

See Also:



8400
8401
8402
8403
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8400

def update_stack(params = {}, options = {})
  req = build_request(:update_stack, params)
  req.send_request(options)
end

#update_stack_instances(params = {}) ⇒ Types::UpdateStackInstancesOutput

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.

During StackSet updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter values that are specified in the StackSet. To add or delete a parameter itself, use UpdateStackSet to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

The maximum number of organizational unit (OUs) supported by a UpdateStackInstances operation is 50.

If you need more than 50, consider the following options:

  • Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.

  • Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

Examples:

Request syntax with placeholder values


resp = client.update_stack_instances({
  stack_set_name: "StackSetNameOrId", # required
  accounts: ["Account"],
  deployment_targets: {
    accounts: ["Account"],
    accounts_url: "AccountsUrl",
    organizational_unit_ids: ["OrganizationalUnitId"],
    account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
  },
  regions: ["Region"], # required
  parameter_overrides: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  operation_id: "ClientRequestToken",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :accounts (Array<String>) —

    [Self-managed permissions] The account IDs of one or more Amazon Web Services accounts 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.

    You can specify Accounts or DeploymentTargets, but not both.

  • :deployment_targets (Types::DeploymentTargets) —

    [Service-managed permissions] The Organizations accounts in 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 (required, Array<String>) —

    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 (Array<Types::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 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 StackSet, 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 StackSet 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 StackSet. To add or delete a parameter itself, use UpdateStackSet to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

  • :operation_preferences (Types::StackSetOperationPreferences) —

    Preferences for how CloudFormation performs this StackSet operation.

  • :operation_id (String) —

    The unique identifier for this StackSet operation.

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

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :call_as (String) —

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

Returns:

See Also:



8599
8600
8601
8602
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8599

def update_stack_instances(params = {}, options = {})
  req = build_request(:update_stack_instances, params)
  req.send_request(options)
end

#update_stack_set(params = {}) ⇒ Types::UpdateStackSetOutput

Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent CreateStackInstances calls on the specified StackSet use the updated StackSet.

The maximum number of organizational unit (OUs) supported by a UpdateStackSet operation is 50.

If you need more than 50, consider the following options:

  • Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.

  • Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

Examples:

Request syntax with placeholder values


resp = client.update_stack_set({
  stack_set_name: "StackSetName", # required
  description: "Description",
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  use_previous_template: false,
  parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
      use_previous_value: false,
      resolved_value: "ParameterValue",
    },
  ],
  capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  operation_preferences: {
    region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL
    region_order: ["Region"],
    failure_tolerance_count: 1,
    failure_tolerance_percentage: 1,
    max_concurrent_count: 1,
    max_concurrent_percentage: 1,
    concurrency_mode: "STRICT_FAILURE_TOLERANCE", # accepts STRICT_FAILURE_TOLERANCE, SOFT_FAILURE_TOLERANCE
  },
  administration_role_arn: "RoleARN",
  execution_role_name: "ExecutionRoleName",
  deployment_targets: {
    accounts: ["Account"],
    accounts_url: "AccountsUrl",
    organizational_unit_ids: ["OrganizationalUnitId"],
    account_filter_type: "NONE", # accepts NONE, INTERSECTION, DIFFERENCE, UNION
  },
  permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
  auto_deployment: {
    enabled: false,
    retain_stacks_on_account_removal: false,
    depends_on: ["StackSetARN"],
  },
  operation_id: "ClientRequestToken",
  accounts: ["Account"],
  regions: ["Region"],
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
  managed_execution: {
    active: false,
  },
})

Response structure


resp.operation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :stack_set_name (required, String) —

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

  • :description (String) —

    A brief description of updates that you are making.

  • :template_body (String) —

    The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://. S3 static website URLs are not supported.

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

  • :use_previous_template (Boolean) —

    Use the existing template that's associated with the StackSet that you're updating.

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

  • :parameters (Array<Types::Parameter>) —

    A list of input parameters for the StackSet template.

  • :capabilities (Array<String>) —

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

    • CAPABILITY_AUTO_EXPAND

      Some templates reference macros. If your StackSet template references one or more macros, you must update the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To update the StackSet directly, you must acknowledge this capability. For more information, see Perform custom processing on CloudFormation templates with template macros.

      StackSets 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 StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.

  • :tags (Array<Types::Tag>) —

    The key-value pairs to associate with this StackSet 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 StackSet. 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 StackSet, even tags you've specified before (for example, when creating the StackSet or during a previous update of the StackSet.). Any tags that you don't include in the updated list of tags are removed from the StackSet, 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 StackSet from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the StackSet, 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 StackSet is not updated.

  • :operation_preferences (Types::StackSetOperationPreferences) —

    Preferences for how CloudFormation performs this StackSet operation.

  • :administration_role_arn (String) —

    [Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this StackSet.

    Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide.

    If you specified a customized administrator role when you created the StackSet, you must specify a customized administrator role, even if it is the same customized administrator role used with this StackSet previously.

  • :execution_role_name (String) —

    [Self-managed permissions] 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 StackSet 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 StackSets.

    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 StackSet, so long as you have permissions to perform operations on the StackSet.

  • :deployment_targets (Types::DeploymentTargets) —

    [Service-managed permissions] The Organizations accounts in which to update associated stack instances.

    To update all the stack instances associated with this StackSet, do not specify DeploymentTargets or Regions.

    If the StackSet 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 StackSet 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 (String) —

    Describes how the IAM roles required for StackSet operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set.

  • :auto_deployment (Types::AutoDeployment) —

    [Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see Enable or disable automatic deployments for StackSets in Organizations in the CloudFormation User Guide.

    If you specify AutoDeployment, don't specify DeploymentTargets or Regions.

  • :operation_id (String) —

    The unique ID for this StackSet operation.

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

    If you don't specify an operation ID, CloudFormation generates one automatically.

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :accounts (Array<String>) —

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

    To update all the stack instances associated with this StackSet, don't specify the Accounts or Regions properties.

    If the StackSet 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 StackSet 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 (Array<String>) —

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

    To update all the stack instances associated with this StackSet, do not specify the Accounts or Regions properties.

    If the StackSet 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 StackSet 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 (String) —

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

  • :managed_execution (Types::ManagedExecution) —

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

Returns:

See Also:



8999
9000
9001
9002
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 8999

def update_stack_set(params = {}, options = {})
  req = build_request(:update_stack_set, params)
  req.send_request(options)
end

#update_termination_protection(params = {}) ⇒ Types::UpdateTerminationProtectionOutput

Updates termination protection for 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 Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.

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

Examples:

Request syntax with placeholder values


resp = client.update_termination_protection({
  enable_termination_protection: false, # required
  stack_name: "StackNameOrId", # required
})

Response structure


resp.stack_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enable_termination_protection (required, Boolean) —

    Whether to enable termination protection on the specified stack.

  • :stack_name (required, String) —

    The name or unique ID of the stack for which you want to set termination protection.

Returns:

See Also:



9044
9045
9046
9047
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 9044

def update_termination_protection(params = {}, options = {})
  req = build_request(:update_termination_protection, params)
  req.send_request(options)
end

#validate_template(params = {}) ⇒ Types::ValidateTemplateOutput

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.

Examples:

Request syntax with placeholder values


resp = client.validate_template({
  template_body: "TemplateBody",
  template_url: "TemplateURL",
})

Response structure


resp.parameters #=> Array
resp.parameters[0].parameter_key #=> String
resp.parameters[0].default_value #=> String
resp.parameters[0].no_echo #=> Boolean
resp.parameters[0].description #=> String
resp.description #=> String
resp.capabilities #=> Array
resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
resp.capabilities_reason #=> String
resp.declared_transforms #=> Array
resp.declared_transforms[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :template_body (String) —

    Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

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

  • :template_url (String) —

    The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. 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.

Returns:

See Also:



9103
9104
9105
9106
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 9103

def validate_template(params = {}, options = {})
  req = build_request(:validate_template, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
change_set_create_complete #describe_change_set 30 120
stack_create_complete #describe_stacks 30 120
stack_delete_complete #describe_stacks 30 120
stack_exists #describe_stacks 5 20
stack_import_complete #describe_stacks 30 120
stack_refactor_create_complete #describe_stack_refactor 5 120
stack_refactor_execute_complete #describe_stack_refactor 15 120
stack_rollback_complete #describe_stacks 30 120
stack_update_complete #describe_stacks 30 120
type_registration_complete #describe_type_registration 30 120

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



9227
9228
9229
9230
9231
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/client.rb', line 9227

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end