CreateLayerRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLayerRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`boolean`	`hasCustomSecurityGroupIds()` For responses, this returns true if the service returned a value for the CustomSecurityGroupIds property.
`int`	`hashCode()`
`boolean`	`hasPackages()` For responses, this returns true if the service returned a value for the Packages property.
`boolean`	`hasVolumeConfigurations()` For responses, this returns true if the service returned a value for the VolumeConfigurations property.
`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.
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()` Returns a string representation of this object.
`LayerType`	`type()` The layer type.
`String`	`typeAsString()` 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.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - stackId
```
public final String stackId()
```
    The layer stack ID.
    
    Returns:
    
    The layer stack ID.
  - type
```
public final LayerType 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.
    
    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. 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
  - typeAsString
```
public final String typeAsString()
```
    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.
    
    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. 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 final String name()
```
    The layer name, which is used by the console.
    
    Returns:
    
    The layer name, which is used by the console.
  - shortname
```
public final 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 final Map<LayerAttributesKeys,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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    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.
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributesAsStrings
```
public final Map<String,String> attributesAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    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 final 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 final 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 final 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.
  - hasCustomSecurityGroupIds
```
public final boolean hasCustomSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the CustomSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - customSecurityGroupIds
```
public final List<String> customSecurityGroupIds()
```
    An array containing the layer custom security group IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomSecurityGroupIds() method.
    
    Returns:
    
    An array containing the layer custom security group IDs.
  - hasPackages
```
public final boolean hasPackages()
```
    For responses, this returns true if the service returned a value for the Packages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - packages
```
public final List<String> packages()
```
    An array of Package objects that describes the layer packages.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPackages() method.
    
    Returns:
    
    An array of Package objects that describes the layer packages.
  - hasVolumeConfigurations
```
public final boolean hasVolumeConfigurations()
```
    For responses, this returns true if the service returned a value for the VolumeConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVolumeConfigurations() method.
    
    Returns:
    
    A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
  - enableAutoHealing
```
public final Boolean enableAutoHealing()
```
    Whether to disable auto healing for the layer.
    
    Returns:
    
    Whether to disable auto healing 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.
  - customRecipes
```
public final Recipes customRecipes()
```
    A LayerCustomRecipes object that specifies the layer custom recipes.
    
    Returns:
    
    A LayerCustomRecipes object that specifies the layer custom recipes.
  - installUpdatesOnBoot
```
public final 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 final Boolean useEbsOptimizedInstances()
```
    Whether to use Amazon EBS-optimized instances.
    
    Returns:
    
    Whether to use Amazon EBS-optimized instances.
  - lifecycleEventConfiguration
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>
    
    Specified by:
    
    toBuilder in class OpsWorksRequest
  - builder
```
public static CreateLayerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLayerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateLayerRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

stackId

type

typeAsString

name

shortname

attributes

hasAttributes

attributesAsStrings

cloudWatchLogsConfiguration

customInstanceProfileArn

customJson

hasCustomSecurityGroupIds

customSecurityGroupIds

hasPackages

packages

hasVolumeConfigurations

volumeConfigurations

enableAutoHealing

autoAssignElasticIps

autoAssignPublicIps

customRecipes

installUpdatesOnBoot

useEbsOptimizedInstances

lifecycleEventConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields