AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a layer.

Inheritance Hierarchy

System.Object
  Amazon.OpsWorks.Model.Layer

Namespace: Amazon.OpsWorks.Model
Assembly: AWSSDK.OpsWorks.dll
Version: 3.x.y.z

Syntax

C#
public class Layer

The Layer type exposes the following members

Constructors

NameDescription
Public Method Layer()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The Amazon Resource Number (ARN) of a layer.

Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Attributes.

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.

Public Property AutoAssignElasticIps System.Boolean

Gets and sets the property AutoAssignElasticIps.

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

Public Property AutoAssignPublicIps System.Boolean

Gets and sets the property 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.

Public Property CloudWatchLogsConfiguration Amazon.OpsWorks.Model.CloudWatchLogsConfiguration

Gets and sets the property CloudWatchLogsConfiguration.

The Amazon CloudWatch Logs configuration settings for the layer.

Public Property CreatedAt System.String

Gets and sets the property CreatedAt.

Date when the layer was created.

Public Property CustomInstanceProfileArn System.String

Gets and sets the property 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.

Public Property CustomJson System.String

Gets and sets the property CustomJson.

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

Public Property CustomRecipes Amazon.OpsWorks.Model.Recipes

Gets and sets the property CustomRecipes.

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

Public Property CustomSecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property CustomSecurityGroupIds.

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

Public Property DefaultRecipes Amazon.OpsWorks.Model.Recipes

Gets and sets the property DefaultRecipes.

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.

Public Property DefaultSecurityGroupNames System.Collections.Generic.List<System.String>

Gets and sets the property DefaultSecurityGroupNames.

An array containing the layer's security group names.

Public Property EnableAutoHealing System.Boolean

Gets and sets the property EnableAutoHealing.

Whether auto healing is disabled for the layer.

Public Property InstallUpdatesOnBoot System.Boolean

Gets and sets the property 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.

Public Property LayerId System.String

Gets and sets the property LayerId.

The layer ID.

Public Property LifecycleEventConfiguration Amazon.OpsWorks.Model.LifecycleEventConfiguration

Gets and sets the property LifecycleEventConfiguration.

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

Public Property Name System.String

Gets and sets the property Name.

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

Public Property Packages System.Collections.Generic.List<System.String>

Gets and sets the property Packages.

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

Public Property Shortname System.String

Gets and sets the property Shortname.

The layer short name.

Public Property StackId System.String

Gets and sets the property StackId.

The layer stack ID.

Public Property Type Amazon.OpsWorks.LayerType

Gets and sets the property Type.

The layer type.

Public Property UseEbsOptimizedInstances System.Boolean

Gets and sets the property UseEbsOptimizedInstances.

Whether the layer uses Amazon EBS-optimized instances.

Public Property VolumeConfigurations System.Collections.Generic.List<Amazon.OpsWorks.Model.VolumeConfiguration>

Gets and sets the property VolumeConfigurations.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5