software.amazon.awssdk.services.opsworks.model

Class Layer

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

Method Summary

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.

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 final String arn()

The Amazon Resource Number (ARN) of a layer.

Returns:

The Amazon Resource Number (ARN) of a layer.

stackId

public final String stackId()

The layer stack ID.

Returns:

The layer stack ID.

layerId

public final String layerId()

The layer ID.

Returns:

The layer ID.

type

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().

Returns:

The layer type.

See Also:

LayerType

typeAsString

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().

Returns:

The layer type.

See Also:

LayerType

name

public final String name()

The layer name.

Returns:

The layer name.

shortname

public final String shortname()

The layer short name.

Returns:

The layer short name.

attributes

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.

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.

hasAttributes

public final 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). For responses returned by the SDK, the sender is the AWS service.

attributesAsStrings

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.

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 final CloudWatchLogsConfiguration cloudWatchLogsConfiguration()

The Amazon CloudWatch Logs configuration settings for the layer.

Returns:

The Amazon CloudWatch Logs configuration settings for the layer.

customInstanceProfileArn

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.

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 final 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.

hasCustomSecurityGroupIds

public final 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). For responses returned by the SDK, the sender is the AWS service.

customSecurityGroupIds

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.

Returns:

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

hasDefaultSecurityGroupNames

public final 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). For responses returned by the SDK, the sender is the AWS service.

defaultSecurityGroupNames

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.

Returns:

An array containing the layer's security group names.

hasPackages

public final 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). For responses returned by the SDK, the sender is the AWS service.

packages

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.

Returns:

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

hasVolumeConfigurations

public final 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). For responses returned by the SDK, the sender is the AWS service.

volumeConfigurations

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.

Returns:

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

enableAutoHealing

public final Boolean enableAutoHealing()

Whether auto healing is disabled for the layer.

Returns:

Whether auto healing is disabled for the layer.

autoAssignElasticIps

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.

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 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.

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 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.

Returns:

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.

customRecipes

public final 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 final String createdAt()

Date when the layer was created.

Returns:

Date when the layer was created.

installUpdatesOnBoot

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.

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 final Boolean useEbsOptimizedInstances()

Whether the layer uses Amazon EBS-optimized instances.

Returns:

Whether the layer uses Amazon EBS-optimized instances.

lifecycleEventConfiguration

public final 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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final 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.