@Generated(value="software.amazon.awssdk:codegen") public final class Layer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Layer.Builder,Layer>
Describes a layer.
Modifier and Type | Class and Description |
---|---|
static interface |
Layer.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The Amazon Resource Number (ARN) of a layer.
|
Map<LayerAttributesKeys,String> |
attributes()
The layer attributes.
|
Map<String,String> |
attributesAsStrings()
The layer attributes.
|
Boolean |
autoAssignElasticIps()
Whether to automatically assign an Elastic IP address
to the layer's instances.
|
Boolean |
autoAssignPublicIps()
For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's
instances.
|
static Layer.Builder |
builder() |
CloudWatchLogsConfiguration |
cloudWatchLogsConfiguration()
The Amazon CloudWatch Logs configuration settings for the layer.
|
String |
createdAt()
Date when the layer was created.
|
String |
customInstanceProfileArn()
The ARN of the default IAM profile to be used for the layer's EC2 instances.
|
String |
customJson()
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
|
Recipes |
customRecipes()
A
LayerCustomRecipes object that specifies the layer's custom recipes. |
List<String> |
customSecurityGroupIds()
An array containing the layer's custom security group IDs.
|
Recipes |
defaultRecipes()
AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy,
undeploy, and shutdown.
|
List<String> |
defaultSecurityGroupNames()
An array containing the layer's security group names.
|
Boolean |
enableAutoHealing()
Whether auto healing is disabled for the layer.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAttributes()
Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasCustomSecurityGroupIds()
Returns true if the CustomSecurityGroupIds property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasDefaultSecurityGroupNames()
Returns true if the DefaultSecurityGroupNames property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasPackages()
Returns true if the Packages property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasVolumeConfigurations()
Returns true if the VolumeConfigurations property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Boolean |
installUpdatesOnBoot()
Whether to install operating system and package updates when the instance boots.
|
String |
layerId()
The layer ID.
|
LifecycleEventConfiguration |
lifecycleEventConfiguration()
A
LifeCycleEventConfiguration object that specifies the Shutdown event configuration. |
String |
name()
The layer name.
|
List<String> |
packages()
An array of
Package objects that describe the layer's packages. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends Layer.Builder> |
serializableBuilderClass() |
String |
shortname()
The layer short name.
|
String |
stackId()
The layer stack ID.
|
Layer.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
LayerType |
type()
The layer type.
|
String |
typeAsString()
The layer type.
|
Boolean |
useEbsOptimizedInstances()
Whether the layer uses Amazon EBS-optimized instances.
|
List<VolumeConfiguration> |
volumeConfigurations()
A
VolumeConfigurations object that describes the layer's Amazon EBS volumes. |
copy
public final String arn()
The Amazon Resource Number (ARN) of a layer.
public final String stackId()
The layer stack ID.
public final String layerId()
The layer ID.
public final LayerType type()
The layer type.
If the service returns an enum value that is not available in the current SDK version, type
will return
LayerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
LayerType
public final String typeAsString()
The layer type.
If the service returns an enum value that is not available in the current SDK version, type
will return
LayerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
LayerType
public final String name()
The layer name.
public final String shortname()
The layer short name.
public final Map<LayerAttributesKeys,String> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
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.
public final boolean hasAttributes()
public final Map<String,String> attributesAsStrings()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAttributes()
to see if a value was sent in this field.
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.
public final CloudWatchLogsConfiguration cloudWatchLogsConfiguration()
The Amazon CloudWatch Logs configuration settings for the layer.
public final String 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 final String customJson()
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
public final boolean hasCustomSecurityGroupIds()
public final List<String> customSecurityGroupIds()
An array containing the layer's custom security group IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasCustomSecurityGroupIds()
to see if a value was sent in this field.
public final boolean hasDefaultSecurityGroupNames()
public final List<String> defaultSecurityGroupNames()
An array containing the layer's security group names.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDefaultSecurityGroupNames()
to see if a value was sent in this field.
public final boolean hasPackages()
public final List<String> packages()
An array of Package
objects that describe the layer's packages.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPackages()
to see if a value was sent in this field.
Package
objects that describe the layer's packages.public final boolean hasVolumeConfigurations()
public final List<VolumeConfiguration> volumeConfigurations()
A VolumeConfigurations
object that describes the layer's Amazon EBS volumes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVolumeConfigurations()
to see if a value was sent in this field.
VolumeConfigurations
object that describes the layer's Amazon EBS volumes.public final Boolean enableAutoHealing()
Whether auto healing is disabled for the layer.
public final Boolean autoAssignElasticIps()
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
public final Boolean 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 final Recipes 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.
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 final Recipes customRecipes()
A LayerCustomRecipes
object that specifies the layer's custom recipes.
LayerCustomRecipes
object that specifies the layer's custom recipes.public final String createdAt()
Date when the layer was created.
public final Boolean 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.
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 final Boolean useEbsOptimizedInstances()
Whether the layer uses Amazon EBS-optimized instances.
public final LifecycleEventConfiguration lifecycleEventConfiguration()
A LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.
LifeCycleEventConfiguration
object that specifies the Shutdown event configuration.public Layer.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Layer.Builder,Layer>
public static Layer.Builder builder()
public static Class<? extends Layer.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.