Package software.amazon.awssdk.services.opsworks.model

Class CreateLayerRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.opsworks.model.CreateLayerRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateLayerRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateLayerRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	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 CreateLayerRequest.Builder	builder()
CloudWatchLogsConfiguration	cloudWatchLogsConfiguration()	Specifies CloudWatch Logs configuration options for the layer.
String	customInstanceProfileArn()	The ARN of an IAM profile to be used for 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 custom recipes.
List<String>	customSecurityGroupIds()	An array containing the layer custom security group IDs.
Boolean	enableAutoHealing()	Whether to disable auto healing for the layer.
boolean	equals(Object obj)
int	hashCode()
Boolean	installUpdatesOnBoot()	Whether to install operating system and package updates when the instance boots.
LifecycleEventConfiguration	lifecycleEventConfiguration()	A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
String	name()	The layer name, which is used by the console.
List<String>	packages()	An array of Package objects that describes the layer packages.
static Class<? extends CreateLayerRequest.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 recipes.
String	stackId()	The layer stack ID.
CreateLayerRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The layer type.
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

stackId

public String stackId()

The layer stack ID.

Returns:

The layer stack ID.

type

public String type()

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

Returns:

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

See Also:

LayerType

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 recipes. 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, which are limited to the alphanumeric characters, '-', '_', and '.'.

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 recipes. 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, which are limited to the alphanumeric characters, '-', '_', and '.'.

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

attributes

public Map<String,String> attributes()

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

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

Returns:

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

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

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 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 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. This feature is supported as of version 1.7.42 of the AWS CLI.

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. This feature is supported as of version 1.7.42 of the AWS CLI.

customSecurityGroupIds

public List<String> customSecurityGroupIds()

An array containing the layer custom security group IDs.

Returns:

An array containing the layer custom security group IDs.

packages

public List<String> packages()

An array of Package objects that describes the layer packages.

Returns:

An array of Package objects that describes the layer packages.

volumeConfigurations

public List<VolumeConfiguration> volumeConfigurations()

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

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

Returns:

A LayerCustomRecipes object that specifies the layer 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 by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

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 by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

useEbsOptimizedInstances

public Boolean useEbsOptimizedInstances()

Whether to use Amazon EBS-optimized instances.

Returns:

Whether to use Amazon EBS-optimized instances.

lifecycleEventConfiguration

public LifecycleEventConfiguration lifecycleEventConfiguration()

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

Returns:

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

toBuilder

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

Returns:

a builder for type T

builder

public static CreateLayerRequest.Builder builder()

serializableBuilderClass

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