Class: Aws::OpsWorks::Stack

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-opsworks/stack.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Stack #initialize(options = {}) ⇒ Stack

Returns a new instance of Stack.

Overloads:

  • #initialize(id, options = {}) ⇒ Stack

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Stack

    Options Hash (options):

    • :id (required, String)
    • :client (Client) 


19
20
21
22
23
24
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#agent_version ⇒ String

The agent version. This parameter is set to ‘LATEST` for auto-update. or a version number for a fixed agent version.

Returns:

  • (String) 


213
214
215
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 213

def agent_version
  data.agent_version
end

#arn ⇒ String

The stack’s ARN.

Returns:

  • (String) 


47
48
49
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 47

def arn
  data.arn
end

#attributes ⇒ Hash<String,String>

The stack’s attributes.

Returns:

  • (Hash<String,String>) 


70
71
72
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 70

def attributes
  data.attributes
end

#chef_configuration ⇒ Types::ChefConfiguration

A ‘ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see [Create a New Stack].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html

Returns:



155
156
157
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 155

def chef_configuration
  data.chef_configuration
end

#client ⇒ Client

Returns:



220
221
222
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 220

def client
  @client
end

#configuration_manager ⇒ Types::StackConfigurationManager

The configuration manager.

Returns:



143
144
145
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 143

def configuration_manager
  data.configuration_manager
end

#create_layer(options = {}) ⇒ Layer

Examples:

Request syntax with placeholder values


layer = stack.create_layer({
  type: "aws-flow-ruby", # required, accepts aws-flow-ruby, ecs-cluster, java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
  name: "String", # required
  shortname: "String", # required
  attributes: {
    "EcsClusterArn" => "String",
  },
  cloud_watch_logs_configuration: {
    enabled: false,
    log_streams: [
      {
        log_group_name: "String",
        datetime_format: "String",
        time_zone: "LOCAL", # accepts LOCAL, UTC
        file: "String",
        file_fingerprint_lines: "String",
        multi_line_start_pattern: "String",
        initial_position: "start_of_file", # accepts start_of_file, end_of_file
        encoding: "ascii", # accepts ascii, big5, big5hkscs, cp037, cp424, cp437, cp500, cp720, cp737, cp775, cp850, cp852, cp855, cp856, cp857, cp858, cp860, cp861, cp862, cp863, cp864, cp865, cp866, cp869, cp874, cp875, cp932, cp949, cp950, cp1006, cp1026, cp1140, cp1250, cp1251, cp1252, cp1253, cp1254, cp1255, cp1256, cp1257, cp1258, euc_jp, euc_jis_2004, euc_jisx0213, euc_kr, gb2312, gbk, gb18030, hz, iso2022_jp, iso2022_jp_1, iso2022_jp_2, iso2022_jp_2004, iso2022_jp_3, iso2022_jp_ext, iso2022_kr, latin_1, iso8859_2, iso8859_3, iso8859_4, iso8859_5, iso8859_6, iso8859_7, iso8859_8, iso8859_9, iso8859_10, iso8859_13, iso8859_14, iso8859_15, iso8859_16, johab, koi8_r, koi8_u, mac_cyrillic, mac_greek, mac_iceland, mac_latin2, mac_roman, mac_turkish, ptcp154, shift_jis, shift_jis_2004, shift_jisx0213, utf_32, utf_32_be, utf_32_le, utf_16, utf_16_be, utf_16_le, utf_7, utf_8, utf_8_sig
        buffer_duration: 1,
        batch_count: 1,
        batch_size: 1,
      },
    ],
  },
  custom_instance_profile_arn: "String",
  custom_json: "String",
  custom_security_group_ids: ["String"],
  packages: ["String"],
  volume_configurations: [
    {
      mount_point: "String", # required
      raid_level: 1,
      number_of_disks: 1, # required
      size: 1, # required
      volume_type: "String",
      iops: 1,
    },
  ],
  enable_auto_healing: false,
  auto_assign_elastic_ips: false,
  auto_assign_public_ips: false,
  custom_recipes: {
    setup: ["String"],
    configure: ["String"],
    deploy: ["String"],
    undeploy: ["String"],
    shutdown: ["String"],
  },
  install_updates_on_boot: false,
  use_ebs_optimized_instances: false,
  lifecycle_event_configuration: {
    shutdown: {
      execution_timeout: 1,
      delay_until_elb_connections_drained: false,
    },
  },
})

Parameters:

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

    ({})

Options Hash (options):

  • :type (required, String) —

    The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

  • :name (required, String) —

    The layer name, which is used by the console.

  • :shortname (required, String) —

    For custom layers only, use this parameter to specify the layer’s short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, ‘-’, ‘_’, and ‘.’.

    The built-in layers’ short names are defined by AWS OpsWorks Stacks. For more information, see the [Layer Reference].

    [1]: docs.aws.amazon.com/opsworks/latest/userguide/layers.html

  • :attributes (Hash<String,String>) —

    One or more user-defined key-value pairs to be added to the stack attributes.

    To create a cluster layer, set the ‘EcsClusterArn` attribute to the cluster’s ARN.

  • :cloud_watch_logs_configuration (Types::CloudWatchLogsConfiguration) —

    Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

  • :custom_instance_profile_arn (String) —

    The ARN of an IAM profile to be used for the layer’s EC2 instances. For more information about IAM ARNs, see [Using Identifiers].

    [1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

  • :custom_json (String) —

    A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer’s instances. For more information, see [ Using Custom JSON]. This feature is supported as of version 1.7.42 of the AWS CLI.

    [1]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html

  • :custom_security_group_ids (Array<String>) —

    An array containing the layer custom security group IDs.

  • :packages (Array<String>) —

    An array of ‘Package` objects that describes the layer packages.

  • :volume_configurations (Array<Types::VolumeConfiguration>) —

    A ‘VolumeConfigurations` object that describes the layer’s Amazon EBS volumes.

  • :enable_auto_healing (Boolean) —

    Whether to disable auto healing for the layer.

  • :auto_assign_elastic_ips (Boolean) —

    Whether to automatically assign an [Elastic IP address] to the layer’s instances. For more information, see [How to Edit a Layer].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html

  • :auto_assign_public_ips (Boolean) —

    For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer’s instances. For more information, see [How to Edit a Layer].

    [1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html

  • :custom_recipes (Types::Recipes) —

    A ‘LayerCustomRecipes` object that specifies the layer custom recipes.

  • :install_updates_on_boot (Boolean) —

    Whether to install operating system and package updates when the instance boots. The default value is ‘true`. To control when updates are installed, set this value to `false`. You must then update your instances manually by using CreateDeployment to run the `update_dependencies` stack command or by manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on the instances.

    <note markdown=“1”> To ensure that your instances have the latest security updates, we strongly recommend using the default value of ‘true`.

    </note>
  • :use_ebs_optimized_instances (Boolean) —

    Whether to use Amazon EBS-optimized instances.

  • :lifecycle_event_configuration (Types::LifecycleEventConfiguration) —

    A ‘LifeCycleEventConfiguration` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

Returns:



407
408
409
410
411
412
413
414
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 407

def create_layer(options = {})
  options = options.merge(stack_id: @id)
  resp = @client.create_layer(options)
  Layer.new(
    id: resp.data.layer_id,
    client: @client
  )
end

#created_at ⇒ String

The date when the stack was created.

Returns:

  • (String) 


194
195
196
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 194

def created_at
  data.created_at
end

#custom_cookbooks_source ⇒ Types::Source

Contains the information required to retrieve an app or cookbook from a repository. For more information, see [Creating Apps] or [Custom Recipes and Cookbooks].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html

Returns:



181
182
183
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 181

def custom_cookbooks_source
  data.custom_cookbooks_source
end

#custom_json ⇒ String

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

‘“”value1“, ”key2“: ”value2“,…”`

For more information on custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html

Returns:

  • (String) 


137
138
139
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 137

def custom_json
  data.custom_json
end

#data ⇒ Types::Stack

Returns the data for this Aws::OpsWorks::Stack. Calls Client#describe_stacks if #data_loaded? is ‘false`.

Returns:



240
241
242
243
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 240

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



248
249
250
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 248

def data_loaded?
  !!@data
end

#default_availability_zone ⇒ String

The stack’s default Availability Zone. For more information, see [Regions and Endpoints].

[1]: docs.aws.amazon.com/general/latest/gr/rande.html

Returns:

  • (String) 


111
112
113
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 111

def default_availability_zone
  data.default_availability_zone
end

#default_instance_profile_arn ⇒ String

The ARN of an IAM profile that is the default profile for all of the stack’s EC2 instances. For more information about IAM ARNs, see [Using Identifiers].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String) 


88
89
90
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 88

def default_instance_profile_arn
  data.default_instance_profile_arn
end

#default_os ⇒ String

The stack’s default operating system.

Returns:

  • (String) 


94
95
96
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 94

def default_os
  data.default_os
end

#default_root_device_type ⇒ String

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see [Storage for the Root Device].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device

Returns:

  • (String) 


206
207
208
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 206

def default_root_device_type
  data.default_root_device_type
end

#default_ssh_key_name ⇒ String

A default Amazon EC2 key pair for the stack’s instances. You can override this value when you create or update an instance.

Returns:

  • (String) 


188
189
190
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 188

def default_ssh_key_name
  data.default_ssh_key_name
end

#default_subnet_id ⇒ String

The default subnet ID; applicable only if the stack is running in a VPC.

Returns:

  • (String) 


118
119
120
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 118

def default_subnet_id
  data.default_subnet_id
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


stack.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


421
422
423
424
425
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 421

def delete(options = {})
  options = options.merge(stack_id: @id)
  resp = @client.delete_stack(options)
  resp.data
end

#hostname_theme ⇒ String

The stack host name theme, with spaces replaced by underscores.

Returns:

  • (String) 


100
101
102
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 100

def hostname_theme
  data.hostname_theme
end

#id ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 29

def id
  @id
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


467
468
469
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 467

def identifiers
  { id: @id }
end

#layers(options = {}) ⇒ Layer::Collection

Examples:

Request syntax with placeholder values


layers = stack.layers({
  layer_ids: ["String"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :layer_ids (Array<String>) —

    An array of layer IDs that specify the layers to be described. If you omit this parameter, ‘DescribeLayers` returns a description of every layer in the specified stack.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 440

def layers(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(stack_id: @id)
    resp = @client.describe_layers(options)
    resp.data.layers.each do |l|
      batch << Layer.new(
        id: l.layer_id,
        data: l,
        client: @client
      )
    end
    y.yield(batch)
  end
  Layer::Collection.new(batches)
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::OpsWorks::Stack. Returns ‘self` making it possible to chain methods.

stack.reload.data

Returns:

  • (self) 


230
231
232
233
234
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 230

def load
  resp = @client.describe_stacks(stack_ids: [@id])
  @data = resp.stacks[0]
  self
end

#name ⇒ String

The stack name.

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 41

def name
  data.name
end

#region ⇒ String

The stack AWS region, such as “ap-northeast-2”. For more information about AWS regions, see [Regions and Endpoints].

[1]: docs.aws.amazon.com/general/latest/gr/rande.html

Returns:

  • (String) 


58
59
60
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 58

def region
  data.region
end

#service_role_arn ⇒ String

The stack AWS Identity and Access Management (IAM) role.

Returns:

  • (String) 


76
77
78
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 76

def service_role_arn
  data.service_role_arn
end

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) 


35
36
37
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 35

def stack_id
  data.stack_id
end

#summary ⇒ StackSummary

Returns:



458
459
460
461
462
463
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 458

def summary
  StackSummary.new(
    stack_id: @id,
    client: @client
  )
end

#use_custom_cookbooks ⇒ Boolean

Whether the stack uses custom cookbooks.

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 161

def use_custom_cookbooks
  data.use_custom_cookbooks
end

#use_opsworks_security_groups ⇒ Boolean

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack’s layers.

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 168

def use_opsworks_security_groups
  data.use_opsworks_security_groups
end

#vpc_id ⇒ String

The VPC ID; applicable only if the stack is running in a VPC.

Returns:

  • (String) 


64
65
66
 
# File 'lib/aws-sdk-opsworks/stack.rb', line 64

def vpc_id
  data.vpc_id
end