Class: Aws::OpsWorks::Types::Layer

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::Layer

Includes:

Structure

Defined in:

lib/aws-sdk-opsworks/types.rb

Overview

Describes a layer.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Number (ARN) of a layer.

• #attributes ⇒ Hash<String,String>

  The layer attributes.

• #auto_assign_elastic_ips ⇒ Boolean

  Whether to automatically assign an [Elastic IP address] to the layer’s instances.

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

• #cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfiguration

  The Amazon CloudWatch Logs configuration settings for the layer.

• #created_at ⇒ String

  Date when the layer was created.

• #custom_instance_profile_arn ⇒ String

  The ARN of the default IAM profile to be used for the layer’s EC2 instances.

• #custom_json ⇒ String

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

• #custom_recipes ⇒ Types::Recipes

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

• #custom_security_group_ids ⇒ Array<String>

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

• #default_recipes ⇒ Types::Recipes

  OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown.

• #default_security_group_names ⇒ Array<String>

  An array containing the layer’s security group names.

• #enable_auto_healing ⇒ Boolean

  Whether auto healing is disabled for the layer.

• #install_updates_on_boot ⇒ Boolean

  Whether to install operating system and package updates when the instance boots.

• #layer_id ⇒ String

  The layer ID.

• #lifecycle_event_configuration ⇒ Types::LifecycleEventConfiguration

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

• #name ⇒ String

  The layer name.

• #packages ⇒ Array<String>

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

• #shortname ⇒ String

  The layer short name.

• #stack_id ⇒ String

  The layer stack ID.

• #type ⇒ String

  The layer type.

• #use_ebs_optimized_instances ⇒ Boolean

  Whether the layer uses Amazon EBS-optimized instances.

• #volume_configurations ⇒ Array<Types::VolumeConfiguration>

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

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Number (ARN) of a layer.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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>)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cloud_watch_logs_configuration ⇒ Types::CloudWatchLogsConfiguration

The Amazon CloudWatch Logs configuration settings for the layer.

Returns:

• (Types::CloudWatchLogsConfiguration)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ String

Date when the layer was created.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_json ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_recipes ⇒ Types::Recipes

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

Returns:

• (Types::Recipes)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_security_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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:

• (Types::Recipes)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#default_security_group_names ⇒ Array<String>

An array containing the layer’s security group names.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_auto_healing ⇒ Boolean

Whether auto healing is disabled for the layer.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
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)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#layer_id ⇒ String

The layer ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle_event_configuration ⇒ Types::LifecycleEventConfiguration

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

Returns:

• (Types::LifecycleEventConfiguration)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#packages ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#shortname ⇒ String

The layer short name.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The layer stack ID.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The layer type.

Returns:

• (String)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_ebs_optimized_instances ⇒ Boolean

Whether the layer uses Amazon EBS-optimized instances.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_configurations ⇒ Array<Types::VolumeConfiguration>

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

Returns:

• (Array<Types::VolumeConfiguration>)

# File 'lib/aws-sdk-opsworks/types.rb', line 3905

class Layer < Struct.new(
  :arn,
  :stack_id,
  :layer_id,
  :type,
  :name,
  :shortname,
  :attributes,
  :cloud_watch_logs_configuration,
  :custom_instance_profile_arn,
  :custom_json,
  :custom_security_group_ids,
  :default_security_group_names,
  :packages,
  :volume_configurations,
  :enable_auto_healing,
  :auto_assign_elastic_ips,
  :auto_assign_public_ips,
  :default_recipes,
  :custom_recipes,
  :created_at,
  :install_updates_on_boot,
  :use_ebs_optimized_instances,
  :lifecycle_event_configuration)
  SENSITIVE = []
  include Aws::Structure
end