software.amazon.awssdk.services.opsworks.model

Class UpdateLayerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.UpdateLayerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateLayerRequest.Builder,UpdateLayerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateLayerRequest
extends OpsWorksRequest
implements ToCopyableBuilder<UpdateLayerRequest.Builder,UpdateLayerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateLayerRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<LayerAttributesKeys,String>	attributes() One or more user-defined key/value pairs to be added to the stack attributes.
Map<String,String>	attributesAsStrings() One or more user-defined key/value pairs to be added to the stack 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 UpdateLayerRequest.Builder	builder()
CloudWatchLogsConfiguration	cloudWatchLogsConfiguration() Specifies CloudWatch Logs configuration options for the layer.
String	customInstanceProfileArn() The ARN of an IAM profile to be used for all of the layer's EC2 instances.
String	customJson() A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.
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.
Boolean	enableAutoHealing() Whether to disable auto healing for the layer.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	installUpdatesOnBoot() Whether to install operating system and package updates when the instance boots.
String	layerId() The layer ID.
LifecycleEventConfiguration	lifecycleEventConfiguration()
String	name() The layer name, which is used by the console.
List<String>	packages() An array of Package objects that describe the layer's packages.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateLayerRequest.Builder>	serializableBuilderClass()
String	shortname() For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef.
UpdateLayerRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	useEbsOptimizedInstances() Whether to use Amazon EBS-optimized instances.
List<VolumeConfiguration>	volumeConfigurations() A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

layerId

public String layerId()

The layer ID.

Returns:

The layer ID.

name

public String name()

The layer name, which is used by the console.

Returns:

The layer name, which is used by the console.

shortname

public String shortname()

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference

Returns:

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9\-\_\.]+\Z/.

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference

attributes

public Map<LayerAttributesKeys,String> attributes()

One or more user-defined key/value pairs to be added to the stack attributes.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more user-defined key/value pairs to be added to the stack attributes.

attributesAsStrings

public Map<String,String> attributesAsStrings()

One or more user-defined key/value pairs to be added to the stack attributes.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more user-defined key/value pairs to be added to the stack attributes.

cloudWatchLogsConfiguration

public CloudWatchLogsConfiguration cloudWatchLogsConfiguration()

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

Returns:

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

customInstanceProfileArn

public String customInstanceProfileArn()

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

Returns:

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

customJson

public String customJson()

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

Returns:

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

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.

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 to disable auto healing for the layer.

Returns:

Whether to disable auto healing 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.

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.

installUpdatesOnBoot

public Boolean installUpdatesOnBoot()

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value 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. To control when updates are installed, set this value 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 to use Amazon EBS-optimized instances.

Returns:

Whether to use Amazon EBS-optimized instances.

lifecycleEventConfiguration

public LifecycleEventConfiguration lifecycleEventConfiguration()

Returns:

toBuilder

public UpdateLayerRequest.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<UpdateLayerRequest.Builder,UpdateLayerRequest>

Specified by:

toBuilder in class OpsWorksRequest

Returns:

a builder for type T

builder

public static UpdateLayerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateLayerRequest.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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.