Class: Aws::OpsWorks::Layer

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Layer.

Overloads:

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

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Layer

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 22

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)
  @waiter_block_warned = false
end

Instance Method Details

#arn ⇒ String

The Amazon Resource Number (ARN) of a layer.

Returns:

  • (String) 


39
40
41
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 39

def arn
  data[:arn]
end

#attributes ⇒ Hash<String,String>

The layer attributes.

For the ‘HaproxyStatsPassword`, `MysqlRootPassword`, and `GangliaPassword` attributes, OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value

For an ECS Cluster layer, OpsWorks Stacks the ‘EcsClusterArn` attribute is set to the cluster’s ARN.

Returns:

  • (Hash<String,String>) 


82
83
84
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 82

def attributes
  data[:attributes]
end

#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

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 151

def auto_assign_elastic_ips
  data[:auto_assign_elastic_ips]
end

#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

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 163

def auto_assign_public_ips
  data[:auto_assign_public_ips]
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfiguration

The Amazon CloudWatch Logs configuration settings for the layer.

Returns:



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

def cloud_watch_logs_configuration
  data[:cloud_watch_logs_configuration]
end

#created_at ⇒ String

Date when the layer was created.

Returns:

  • (String) 


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

def created_at
  data[:created_at]
end

#custom_instance_profile_arn ⇒ String

The ARN of the default 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

Returns:

  • (String) 


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

def custom_instance_profile_arn
  data[:custom_instance_profile_arn]
end

#custom_json ⇒ String

A JSON formatted string containing the layer’s custom stack configuration and deployment attributes.

Returns:

  • (String) 


107
108
109
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 107

def custom_json
  data[:custom_json]
end

#custom_recipes ⇒ Types::Recipes

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

Returns:



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

def custom_recipes
  data[:custom_recipes]
end

#custom_security_group_ids ⇒ Array<String>

An array containing the layer’s custom security group IDs.

Returns:

  • (Array<String>) 


113
114
115
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 113

def custom_security_group_ids
  data[:custom_security_group_ids]
end

#data ⇒ Types::Layer

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

Returns:



252
253
254
255
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 252

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.



260
261
262
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 260

def data_loaded?
  !!@data
end

#default_recipes ⇒ Types::Recipes

OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard recipes. ‘LayerCustomRecipes` specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook’s directory name in the repository followed by two colons and the recipe name, which is the recipe’s file name without the ‘.rb` extension. For example: `phpapp2::dbsetup` specifies the `dbsetup.rb` recipe in the repository’s ‘phpapp2` folder.

Returns:



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

def default_recipes
  data[:default_recipes]
end

#default_security_group_names ⇒ Array<String>

An array containing the layer’s security group names.

Returns:

  • (Array<String>) 


119
120
121
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 119

def default_security_group_names
  data[:default_security_group_names]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


layer.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


370
371
372
373
374
375
376
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 370

def delete(options = {})
  options = options.merge(layer_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_layer(options)
  end
  resp.data
end

#enable_auto_healing ⇒ Boolean

Whether auto healing is disabled for the layer.

Returns:

  • (Boolean) 


138
139
140
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 138

def enable_auto_healing
  data[:enable_auto_healing]
end

#id ⇒ String

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 33

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. 


394
395
396
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 394

def identifiers
  { id: @id }
end

#install_updates_on_boot ⇒ Boolean

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

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

</note>

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 210

def install_updates_on_boot
  data[:install_updates_on_boot]
end

#layer_id ⇒ String

The layer ID.

Returns:

  • (String) 


51
52
53
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 51

def layer_id
  data[:layer_id]
end

#lifecycle_event_configuration ⇒ Types::LifecycleEventConfiguration

A ‘LifeCycleEventConfiguration` object that specifies the Shutdown event configuration.

Returns:



223
224
225
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 223

def lifecycle_event_configuration
  data[:lifecycle_event_configuration]
end

#load ⇒ self Also known as: reload

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

layer.reload.data

Returns:

  • (self) 


240
241
242
243
244
245
246
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 240

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_layers(layer_ids: [@id])
  end
  @data = resp.layers[0]
  self
end

#name ⇒ String

The layer name. Layer names can be a maximum of 32 characters.

Returns:

  • (String) 


63
64
65
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 63

def name
  data[:name]
end

#packages ⇒ Array<String>

An array of ‘Package` objects that describe the layer’s packages.

Returns:

  • (Array<String>) 


125
126
127
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 125

def packages
  data[:packages]
end

#shortname ⇒ String

The layer short name.

Returns:

  • (String) 


69
70
71
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 69

def shortname
  data[:shortname]
end

#stack ⇒ Stack?

Returns:



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 381

def stack
  if data[:stack_id]
    Stack.new(
      id: data[:stack_id],
      client: @client
    )
  else
    nil
  end
end

#stack_id ⇒ String

The layer stack ID.

Returns:

  • (String) 


45
46
47
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 45

def stack_id
  data[:stack_id]
end

#type ⇒ String

The layer type.

Returns:

  • (String) 


57
58
59
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 57

def type
  data[:type]
end

#use_ebs_optimized_instances ⇒ Boolean

Whether the layer uses Amazon EBS-optimized instances.

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 216

def use_ebs_optimized_instances
  data[:use_ebs_optimized_instances]
end

#volume_configurations ⇒ Array<Types::VolumeConfiguration>

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

Returns:



132
133
134
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 132

def volume_configurations
  data[:volume_configurations]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::OpsWorks::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/aws-sdk-opsworks/layer.rb', line 344

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end