Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

Layer

Describes a layer.

Contents

Arn

The Amazon Resource Number (ARN) of a layer.

Type: String

Required: No

Attributes

The layer attributes.

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

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

Type: String to string map

Valid Keys: EcsClusterArn | EnableHaproxyStats | HaproxyStatsUrl | HaproxyStatsUser | HaproxyStatsPassword | HaproxyHealthCheckUrl | HaproxyHealthCheckMethod | MysqlRootPassword | MysqlRootPasswordUbiquitous | GangliaUrl | GangliaUser | GangliaPassword | MemcachedMemory | NodejsVersion | RubyVersion | RubygemsVersion | ManageBundler | BundlerVersion | RailsStack | PassengerVersion | Jvm | JvmVersion | JvmOptions | JavaAppServer | JavaAppServerVersion

Required: No

AutoAssignElasticIps

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

Type: Boolean

Required: No

AutoAssignPublicIps

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.

Type: Boolean

Required: No

CloudWatchLogsConfiguration

The Amazon CloudWatch Logs configuration settings for the layer.

Type: CloudWatchLogsConfiguration object

Required: No

CreatedAt

Date when the layer was created.

Type: String

Required: No

CustomInstanceProfileArn

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.

Type: String

Required: No

CustomJson

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

Type: String

Required: No

CustomRecipes

A LayerCustomRecipes object that specifies the layer's custom recipes.

Type: Recipes object

Required: No

CustomSecurityGroupIds

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

Type: Array of strings

Required: No

DefaultRecipes

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS 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.

Type: Recipes object

Required: No

DefaultSecurityGroupNames

An array containing the layer's security group names.

Type: Array of strings

Required: No

EnableAutoHealing

Whether auto healing is disabled for the layer.

Type: Boolean

Required: No

InstallUpdatesOnBoot

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

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

Type: Boolean

Required: No

LayerId

The layer ID.

Type: String

Required: No

LifecycleEventConfiguration

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

Type: LifecycleEventConfiguration object

Required: No

Name

The layer name.

Type: String

Required: No

Packages

An array of Package objects that describe the layer's packages.

Type: Array of strings

Required: No

Shortname

The layer short name.

Type: String

Required: No

StackId

The layer stack ID.

Type: String

Required: No

Type

The layer type.

Type: String

Valid Values: aws-flow-ruby | ecs-cluster | java-app | lb | web | php-app | rails-app | nodejs-app | memcached | db-master | monitoring-master | custom

Required: No

UseEbsOptimizedInstances

Whether the layer uses Amazon EBS-optimized instances.

Type: Boolean

Required: No

VolumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Type: Array of VolumeConfiguration objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: