Documentation

Describes a layer.

See: newLayer smart constructor.

Create a value of Layer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Layer', layer_arn - The Amazon Resource Number (ARN) of a layer.

$sel:attributes:Layer', layer_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.

$sel:autoAssignElasticIps:Layer', layer_autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

$sel:autoAssignPublicIps:Layer', layer_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.

$sel:cloudWatchLogsConfiguration:Layer', layer_cloudWatchLogsConfiguration - The Amazon CloudWatch Logs configuration settings for the layer.

$sel:createdAt:Layer', layer_createdAt - Date when the layer was created.

$sel:customInstanceProfileArn:Layer', layer_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.

$sel:customJson:Layer', layer_customJson - A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

$sel:customRecipes:Layer', layer_customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.

$sel:customSecurityGroupIds:Layer', layer_customSecurityGroupIds - An array containing the layer's custom security group IDs.

$sel:defaultRecipes:Layer', layer_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. You can also 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.

$sel:defaultSecurityGroupNames:Layer', layer_defaultSecurityGroupNames - An array containing the layer's security group names.

$sel:enableAutoHealing:Layer', layer_enableAutoHealing - Whether auto healing is disabled for the layer.

$sel:installUpdatesOnBoot:Layer', layer_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.

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

$sel:layerId:Layer', layer_layerId - The layer ID.

$sel:lifecycleEventConfiguration:Layer', layer_lifecycleEventConfiguration - A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

$sel:name:Layer', layer_name - The layer name.

$sel:packages:Layer', layer_packages - An array of Package objects that describe the layer's packages.

$sel:shortname:Layer', layer_shortname - The layer short name.

$sel:stackId:Layer', layer_stackId - The layer stack ID.

$sel:type':Layer', layer_type - The layer type.

$sel:useEbsOptimizedInstances:Layer', layer_useEbsOptimizedInstances - Whether the layer uses Amazon EBS-optimized instances.

$sel:volumeConfigurations:Layer', layer_volumeConfigurations - A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

The Amazon Resource Number (ARN) of a layer.

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.

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

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.

The Amazon CloudWatch Logs configuration settings for the layer.

Date when the layer was created.

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.

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

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

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

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. You can also 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.

An array containing the layer's security group names.

Whether auto healing is disabled for the layer.

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.

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

The layer ID.

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

The layer name.

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

The layer short name.

The layer stack ID.

The layer type.

Whether the layer uses Amazon EBS-optimized instances.

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