/AWS1/CL_OWXLAYER

Describes a layer.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_arn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The Amazon Resource Number (ARN) of a layer.

iv_stackid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The layer stack ID.

iv_layerid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The layer ID.

iv_type TYPE /AWS1/OWXLAYERTYPE /AWS1/OWXLAYERTYPE

The layer type.

iv_name TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

iv_shortname TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The layer short name.

it_attributes TYPE /AWS1/CL_OWXLAYERATTRIBUTES_W=>TT_LAYERATTRIBUTES TT_LAYERATTRIBUTES

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.

io_cloudwatchlogsconf TYPE REF TO /AWS1/CL_OWXCLOUDWATCHLOGSCONF /AWS1/CL_OWXCLOUDWATCHLOGSCONF

The Amazon CloudWatch Logs configuration settings for the layer.

iv_custominstanceprofilearn TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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.

iv_customjson TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

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

it_customsecuritygroupids TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS TT_STRINGS

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

it_defaultsecuritygroupnames TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS TT_STRINGS

An array containing the layer's security group names.

it_packages TYPE /AWS1/CL_OWXSTRINGS_W=>TT_STRINGS TT_STRINGS

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

it_volumeconfigurations TYPE /AWS1/CL_OWXVOLUMECONF=>TT_VOLUMECONFIGURATIONS TT_VOLUMECONFIGURATIONS

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

iv_enableautohealing TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

Whether auto healing is disabled for the layer.

iv_autoassignelasticips TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

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

iv_autoassignpublicips TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

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.

io_defaultrecipes TYPE REF TO /AWS1/CL_OWXRECIPES /AWS1/CL_OWXRECIPES

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.

io_customrecipes TYPE REF TO /AWS1/CL_OWXRECIPES /AWS1/CL_OWXRECIPES

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

iv_createdat TYPE /AWS1/OWXDATETIME /AWS1/OWXDATETIME

Date when the layer was created.

iv_installupdatesonboot TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

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.

iv_useebsoptimizedinstances TYPE /AWS1/OWXBOOLEAN /AWS1/OWXBOOLEAN

Whether the layer uses Amazon EBS-optimized instances.

io_lifecycleeventconf TYPE REF TO /AWS1/CL_OWXLIFECYCLEEVENTCONF /AWS1/CL_OWXLIFECYCLEEVENTCONF

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

---

Queryable Attributes

Arn

The Amazon Resource Number (ARN) of a layer.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

StackId

The layer stack ID.

Accessible with the following methods

Method	Description
GET_STACKID()	Getter for STACKID, with configurable default
ASK_STACKID()	Getter for STACKID w/ exceptions if field has no value
HAS_STACKID()	Determine if STACKID has a value

LayerId

The layer ID.

Accessible with the following methods

Method	Description
GET_LAYERID()	Getter for LAYERID, with configurable default
ASK_LAYERID()	Getter for LAYERID w/ exceptions if field has no value
HAS_LAYERID()	Determine if LAYERID has a value

Type

The layer type.

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

Name

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

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

Shortname

The layer short name.

Accessible with the following methods

Method	Description
GET_SHORTNAME()	Getter for SHORTNAME, with configurable default
ASK_SHORTNAME()	Getter for SHORTNAME w/ exceptions if field has no value
HAS_SHORTNAME()	Determine if SHORTNAME has a value

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.

Accessible with the following methods

Method	Description
GET_ATTRIBUTES()	Getter for ATTRIBUTES, with configurable default
ASK_ATTRIBUTES()	Getter for ATTRIBUTES w/ exceptions if field has no value
HAS_ATTRIBUTES()	Determine if ATTRIBUTES has a value

CloudWatchLogsConfiguration

The Amazon CloudWatch Logs configuration settings for the layer.

Accessible with the following methods

Method	Description
GET_CLOUDWATCHLOGSCONF()	Getter for CLOUDWATCHLOGSCONFIGURATION

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.

Accessible with the following methods

Method	Description
GET_CUSTOMINSTANCEPROFILEARN()	Getter for CUSTOMINSTANCEPROFILEARN, with configurable defau
ASK_CUSTOMINSTANCEPROFILEARN()	Getter for CUSTOMINSTANCEPROFILEARN w/ exceptions if field h
HAS_CUSTOMINSTANCEPROFILEARN()	Determine if CUSTOMINSTANCEPROFILEARN has a value

CustomJson

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

Accessible with the following methods

Method	Description
GET_CUSTOMJSON()	Getter for CUSTOMJSON, with configurable default
ASK_CUSTOMJSON()	Getter for CUSTOMJSON w/ exceptions if field has no value
HAS_CUSTOMJSON()	Determine if CUSTOMJSON has a value

CustomSecurityGroupIds

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

Accessible with the following methods

Method	Description
GET_CUSTOMSECURITYGROUPIDS()	Getter for CUSTOMSECURITYGROUPIDS, with configurable default
ASK_CUSTOMSECURITYGROUPIDS()	Getter for CUSTOMSECURITYGROUPIDS w/ exceptions if field has
HAS_CUSTOMSECURITYGROUPIDS()	Determine if CUSTOMSECURITYGROUPIDS has a value

DefaultSecurityGroupNames

An array containing the layer's security group names.

Accessible with the following methods

Method	Description
GET_DEFAULTSECGROUPNAMES()	Getter for DEFAULTSECURITYGROUPNAMES, with configurable defa
ASK_DEFAULTSECGROUPNAMES()	Getter for DEFAULTSECURITYGROUPNAMES w/ exceptions if field
HAS_DEFAULTSECGROUPNAMES()	Determine if DEFAULTSECURITYGROUPNAMES has a value

Packages

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

Accessible with the following methods

Method	Description
GET_PACKAGES()	Getter for PACKAGES, with configurable default
ASK_PACKAGES()	Getter for PACKAGES w/ exceptions if field has no value
HAS_PACKAGES()	Determine if PACKAGES has a value

VolumeConfigurations

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

Accessible with the following methods

Method	Description
GET_VOLUMECONFIGURATIONS()	Getter for VOLUMECONFIGURATIONS, with configurable default
ASK_VOLUMECONFIGURATIONS()	Getter for VOLUMECONFIGURATIONS w/ exceptions if field has n
HAS_VOLUMECONFIGURATIONS()	Determine if VOLUMECONFIGURATIONS has a value

EnableAutoHealing

Whether auto healing is disabled for the layer.

Accessible with the following methods

Method	Description
GET_ENABLEAUTOHEALING()	Getter for ENABLEAUTOHEALING, with configurable default
ASK_ENABLEAUTOHEALING()	Getter for ENABLEAUTOHEALING w/ exceptions if field has no v
HAS_ENABLEAUTOHEALING()	Determine if ENABLEAUTOHEALING has a value

AutoAssignElasticIps

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

Accessible with the following methods

Method	Description
GET_AUTOASSIGNELASTICIPS()	Getter for AUTOASSIGNELASTICIPS, with configurable default
ASK_AUTOASSIGNELASTICIPS()	Getter for AUTOASSIGNELASTICIPS w/ exceptions if field has n
HAS_AUTOASSIGNELASTICIPS()	Determine if AUTOASSIGNELASTICIPS has a value

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.

Accessible with the following methods

Method	Description
GET_AUTOASSIGNPUBLICIPS()	Getter for AUTOASSIGNPUBLICIPS, with configurable default
ASK_AUTOASSIGNPUBLICIPS()	Getter for AUTOASSIGNPUBLICIPS w/ exceptions if field has no
HAS_AUTOASSIGNPUBLICIPS()	Determine if AUTOASSIGNPUBLICIPS has a value

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.

Accessible with the following methods

Method	Description
GET_DEFAULTRECIPES()	Getter for DEFAULTRECIPES

CustomRecipes

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

Accessible with the following methods

Method	Description
GET_CUSTOMRECIPES()	Getter for CUSTOMRECIPES

CreatedAt

Date when the layer was created.

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

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.

Accessible with the following methods

Method	Description
GET_INSTALLUPDATESONBOOT()	Getter for INSTALLUPDATESONBOOT, with configurable default
ASK_INSTALLUPDATESONBOOT()	Getter for INSTALLUPDATESONBOOT w/ exceptions if field has n
HAS_INSTALLUPDATESONBOOT()	Determine if INSTALLUPDATESONBOOT has a value

UseEbsOptimizedInstances

Whether the layer uses Amazon EBS-optimized instances.

Accessible with the following methods

Method	Description
GET_USEEBSOPTIMIZEDINSTANCES()	Getter for USEEBSOPTIMIZEDINSTANCES, with configurable defau
ASK_USEEBSOPTIMIZEDINSTANCES()	Getter for USEEBSOPTIMIZEDINSTANCES w/ exceptions if field h
HAS_USEEBSOPTIMIZEDINSTANCES()	Determine if USEEBSOPTIMIZEDINSTANCES has a value

LifecycleEventConfiguration

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

Accessible with the following methods

Method	Description
GET_LIFECYCLEEVENTCONF()	Getter for LIFECYCLEEVENTCONFIGURATION

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_LAYERS

TYPES TT_LAYERS TYPE STANDARD TABLE OF REF TO /AWS1/CL_OWXLAYER WITH DEFAULT KEY
.