Class: Aws::CloudFormation::Client

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,
})

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:

• (Types::ActivateTypeOutput) —

  Returns a response object which responds to the following methods:

  • #arn => String

See Also:

• AWS API Documentation

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",
    },
  ],
})

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

• :type_configuration_identifiers (required, Array<Types::TypeConfigurationIdentifier>) —

  The list of identifiers for the desired extension configurations.

Returns:

• (Types::BatchDescribeTypeConfigurationsOutput) —

  Returns a response object which responds to the following methods:

  • #errors => Array<Types::BatchDescribeTypeConfigurationsError>
  • #unprocessed_type_configurations => Array<Types::TypeConfigurationIdentifier>
  • #type_configurations => Array<Types::TypeConfigurationDetails>

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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:

• AWS API Documentation

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,
})

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 TemplateBody or TemplateURL.

• :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 TemplateBody or TemplateURL.

• :use_previous_template (Boolean) —

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

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

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

    • AWS::IAM::AccessKey

    • AWS::IAM::Group

    • AWS::IAM::InstanceProfile

    • AWS::IAM::ManagedPolicy

    • AWS::IAM::Policy

    • AWS::IAM::Role

    • AWS::IAM::User

    • AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates.

  • CAPABILITY_AUTO_EXPAND

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

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

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

    For more information about macros, see Perform custom processing on CloudFormation templates with template macros.

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

• :resource_types (Array<String>) —

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

  If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Control 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.

Returns:

• (Types::CreateChangeSetOutput) —

  Returns a response object which responds to the following methods:

  • #id => String
  • #stack_id => String

See Also:

• AWS API Documentation

# 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", 
}

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
  },
})

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:

• (Types::CreateGeneratedTemplateOutput) —

  Returns a response object which responds to the following methods:

  • #generated_template_id => String

See Also:

• AWS API Documentation

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,
})

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

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    • AWS::IAM::AccessKey

    • AWS::IAM::Group

    • AWS::IAM::InstanceProfile

    • AWS::IAM::ManagedPolicy

    • AWS::IAM::Policy

    • AWS::IAM::Role

    • AWS::IAM::User

    • AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates.

  • CAPABILITY_AUTO_EXPAND

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

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

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

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

    For more information, see Perform custom processing on CloudFormation templates with template macros.

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

• :resource_types (Array<String>) —

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

  If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Control 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.

  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:

• (Types::CreateStackOutput) —

  Returns a response object which responds to the following methods:

  • #stack_id => String

See Also:

• AWS API Documentation

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

resp.operation_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :stack_set_name (required, String) —

  The name or unique ID of the stack set 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 for 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 stack set parameters whose values you want to override in the selected stack instances.

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

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

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

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

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

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

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

• :operation_preferences (Types::StackSetOperationPreferences) —

  Preferences for how CloudFormation performs this stack set operation.

• :operation_id (String) —

  The unique identifier for this stack set operation.

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

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

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

  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 stack sets with self-managed permissions.

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

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

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

Returns:

• (Types::CreateStackInstancesOutput) —

  Returns a response object which responds to the following methods:

  • #operation_id => String

See Also:

• AWS API Documentation

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",
    },
  ],
})

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:

• (Types::CreateStackRefactorOutput) —

  Returns a response object which responds to the following methods:

  • #stack_refactor_id => String

See Also:

• AWS API Documentation

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,
  },
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
  client_request_token: "ClientRequestToken",
  managed_execution: {
    active: false,
  },
})

resp.stack_set_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :stack_set_name (required, String) —

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

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

• :description (String) —

  A description of the stack set. You can use the description to identify the stack set'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 stack set. Specify the Amazon Resource Name (ARN) of the stack.

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

  The input parameters for the stack set template.

• :capabilities (Array<String>) —

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

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    • AWS::IAM::AccessKey

    • AWS::IAM::Group

    • AWS::IAM::InstanceProfile

    • AWS::IAM::Policy

    • AWS::IAM::Role

    • AWS::IAM::User

    • AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM resources in CloudFormation templates.

  • CAPABILITY_AUTO_EXPAND

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

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

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

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

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

• :administration_role_arn (String) —

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

  Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see 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 stack set. If you do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

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

  Valid only if the permissions model is SELF_MANAGED.

• :permission_model (String) —

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

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

  • With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see Activate trusted access for stack sets with Organizations.

• :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 Manage automatic deployments for CloudFormation StackSets that use service-managed permissions 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 stack sets with self-managed permissions.

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

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

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

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

  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 stack set with the same name. You might retry CreateStackSet requests to ensure that CloudFormation successfully received them.

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

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

• :managed_execution (Types::ManagedExecution) —

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

Returns:

• (Types::CreateStackSetOutput) —

  Returns a response object which responds to the following methods:

  • #stack_set_id => String

See Also:

• AWS API Documentation

Parameters:

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

  ({})

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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:

• AWS API Documentation

# This example deletes a generated template

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

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:

• AWS API Documentation

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:

• AWS API Documentation

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

resp.operation_id #=> String

Parameters:

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

  ({})

Options Hash (params):

• :stack_set_name (required, String) —

  The name or unique ID of the stack set 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 stack set instances.

• :operation_preferences (Types::StackSetOperationPreferences) —

  Preferences for how CloudFormation performs this stack set operation.

• :retain_stacks (required, Boolean) —

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

  For more information, see Stack set operation options.

• :operation_id (String) —

  The unique identifier for this stack set operation.

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

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

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

  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 stack sets with self-managed permissions.

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

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

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

Returns:

• (Types::DeleteStackInstancesOutput) —

  Returns a response object which responds to the following methods:

  • #operation_id => String

See Also:

• AWS API Documentation

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 stack set 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 stack sets with self-managed permissions.

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

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

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

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

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:

• AWS API Documentation

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

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

Parameters:

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

  ({})

Options Hash (params):

• :next_token (String) —

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

Returns:

• (Types::DescribeAccountLimitsOutput) —

  Returns a response object which responds to the following methods:

  • #account_limits => Array<Types::AccountLimit>
  • #next_token => String

See Also:

• AWS API Documentation

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

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.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"
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.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.attribute_change_type #=> String, one of "Add", "Remove", "Modify"
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"
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.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

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

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

• :include_property_values (Boolean) —

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

Returns:

• (Types::DescribeChangeSetOutput) —

  Returns a response object which responds to the following methods:

  • #change_set_name => String
  • #change_set_id => String
  • #stack_id => String
  • #stack_name => String
  • #description => String
  • #parameters => Array<Types::Parameter>
  • #creation_time => Time
  • #execution_status => String
  • #status => String
  • #status_reason => String
  • #notification_arns => Array<String>
  • #rollback_configuration => Types::RollbackConfiguration
  • #capabilities => Array<String>
  • #tags => Array<Types::Tag>
  • #changes => Array<Types::Change>
  • #next_token => String
  • #include_nested_stacks => Boolean
  • #parent_change_set_id => String
  • #root_change_set_id => String
  • #on_stack_failure => String
  • #import_existing_resources => Boolean

See Also:

• AWS API Documentation

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

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"
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) —

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

• :logical_resource_id (String) —

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