Layer (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.opsworks.model.Layer

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Layer.Builder,Layer>

@Generated(value="software.amazon.awssdk:codegen")
public final class Layer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Layer.Builder,Layer>

Describes a layer.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Layer.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Layer.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns the value of the DefaultRecipes property for this object.
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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()`
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public String arn()
```
    The Amazon Resource Number (ARN) of a layer.
    
    Returns:
    
    The Amazon Resource Number (ARN) of a layer.
  - stackId
```
public String stackId()
```
    The layer stack ID.
    
    Returns:
    
    The layer stack ID.
  - layerId
```
public String layerId()
```
    The layer ID.
    
    Returns:
    
    The layer ID.
  - type
```
public 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().
    
    Returns:
    
    The layer type.
    
    See Also:
    
    LayerType
  - typeAsString
```
public 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().
    
    Returns:
    
    The layer type.
    
    See Also:
    
    LayerType
  - name
```
public String name()
```
    The layer name.
    
    Returns:
    
    The layer name.
  - shortname
```
public String shortname()
```
    The layer short name.
    
    Returns:
    
    The layer short name.
  - attributes
```
public 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.
    
    Returns:
    
    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.
  - attributesAsStrings
```
public 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.
    
    Returns:
    
    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.
  - cloudWatchLogsConfiguration
```
public CloudWatchLogsConfiguration cloudWatchLogsConfiguration()
```
    The Amazon CloudWatch Logs configuration settings for the layer.
    
    Returns:
    
    The Amazon CloudWatch Logs configuration settings for the layer.
  - customInstanceProfileArn
```
public 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.
    
    Returns:
    
    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.
  - customJson
```
public String customJson()
```
    A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
    
    Returns:
    
    A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
  - customSecurityGroupIds
```
public 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.
    
    Returns:
    
    An array containing the layer's custom security group IDs.
  - defaultSecurityGroupNames
```
public 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.
    
    Returns:
    
    An array containing the layer's security group names.
  - packages
```
public 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.
    
    Returns:
    
    An array of Package objects that describe the layer's packages.
  - volumeConfigurations
```
public 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.
    
    Returns:
    
    A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
  - enableAutoHealing
```
public Boolean enableAutoHealing()
```
    Whether auto healing is disabled for the layer.
    
    Returns:
    
    Whether auto healing is disabled for the layer.
  - autoAssignElasticIps
```
public Boolean autoAssignElasticIps()
```
    Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
    
    Returns:
    
    Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
  - autoAssignPublicIps
```
public 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.
    
    Returns:
    
    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.
  - defaultRecipes
```
public Recipes defaultRecipes()
```
    Returns the value of the DefaultRecipes property for this object.
    
    Returns:
    
    The value of the DefaultRecipes property for this object.
  - customRecipes
```
public Recipes customRecipes()
```
    A LayerCustomRecipes object that specifies the layer's custom recipes.
    
    Returns:
    
    A LayerCustomRecipes object that specifies the layer's custom recipes.
  - createdAt
```
public String createdAt()
```
    Date when the layer was created.
    
    Returns:
    
    Date when the layer was created.
  - installUpdatesOnBoot
```
public 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.
    
    Returns:
    
    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.
  - useEbsOptimizedInstances
```
public Boolean useEbsOptimizedInstances()
```
    Whether the layer uses Amazon EBS-optimized instances.
    
    Returns:
    
    Whether the layer uses Amazon EBS-optimized instances.
  - lifecycleEventConfiguration
```
public LifecycleEventConfiguration lifecycleEventConfiguration()
```
    A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
    
    Returns:
    
    A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
  - toBuilder
```
public Layer.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Layer.Builder,Layer>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Layer.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Layer.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Layer

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

stackId

layerId

type

typeAsString

name

shortname

attributes

attributesAsStrings

cloudWatchLogsConfiguration

customInstanceProfileArn

customJson

customSecurityGroupIds

defaultSecurityGroupNames

packages

volumeConfigurations

enableAutoHealing

autoAssignElasticIps

autoAssignPublicIps

defaultRecipes

customRecipes

createdAt

installUpdatesOnBoot

useEbsOptimizedInstances

lifecycleEventConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields