Class: Aws::CloudFormation::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-cloudformation/resource.rb

Overview

This class provides a resource oriented interface for CloudFormation. To create a resource object:

resource = Aws::CloudFormation::Resource.new(region: 'us-west-2')

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass ‘:client`, a default client will be constructed.

client = Aws::CloudFormation::Client.new(region: 'us-west-2')
resource = Aws::CloudFormation::Resource.new(client: client)

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Resource

Returns a new instance of Resource.

Parameters:

  • options ({}) (defaults to: {})

Options Hash (options):



27
28
29
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 27

def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Instance Method Details

#client ⇒ Client

Returns:



32
33
34
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 32

def client
  @client
end

#create_stack(options = {}) ⇒ Stack

Examples:

Request syntax with placeholder values


stack = cloud_formation.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,
})

Parameters:

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

    ({})

Options Hash (options):

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

    <note markdown=“1”> 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.

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

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html

  • :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][1
      • AWS::IAM::Group][2
      • AWS::IAM::InstanceProfile][3
      • AWS::IAM::ManagedPolicy][4
      • AWS::IAM::Policy][5
      • AWS::IAM::Role][6
      • AWS::IAM::User][7
      • AWS::IAM::UserToGroupAddition][8

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

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html [3]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html [4]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html [5]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html [6]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html [7]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html [8]: docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html [9]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities [10]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html [11]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html [12]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html

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

    <note markdown=“1”> Only one of the ‘Capabilities` and `ResourceType` parameters can be specified.

    </note>

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html

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

    <note markdown=“1”> 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`.

    </note>

    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.

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html

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

    [1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 332

def create_stack(options = {})
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_stack(options)
  end
  Stack.new(
    name: options[:stack_name],
    client: @client
  )
end

#event(id) ⇒ Event

Parameters:

  • id (String)

Returns:



346
347
348
349
350
351
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 346

def event(id)
  Event.new(
    id: id,
    client: @client
  )
end

#stack(name) ⇒ Stack

Parameters:

  • name (String)

Returns:



355
356
357
358
359
360
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 355

def stack(name)
  Stack.new(
    name: name,
    client: @client
  )
end

#stacks(options = {}) ⇒ Stack::Collection

Examples:

Request syntax with placeholder values


stacks = cloud_formation.stacks({
  stack_name: "StackName",
})

Parameters:

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

    ({})

Options Hash (options):

  • :stack_name (String) —

    <note markdown=“1”> 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//” }] }

    </note>

    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.

Returns:



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/aws-sdk-cloudformation/resource.rb', line 395

def stacks(options = {})
  batches = Enumerator.new do |y|
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_stacks(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.stacks.each do |s|
        batch << Stack.new(
          name: s.stack_name,
          data: s,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Stack::Collection.new(batches)
end