@Generated(value="software.amazon.awssdk:codegen") public final class CreateLayerRequest extends OpsWorksRequest implements ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateLayerRequest.Builder |
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) |
<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.
|
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() |
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. |
overrideConfiguration
copy
public String stackId()
The layer stack ID.
public 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()
.
LayerType
public 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()
.
LayerType
public String name()
The layer name, which is used by the console.
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.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.
public 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.
To create a cluster layer, set the EcsClusterArn
attribute to the cluster's ARN.
public 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.
To create a cluster layer, set the EcsClusterArn
attribute to the cluster's ARN.
public CloudWatchLogsConfiguration cloudWatchLogsConfiguration()
Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.
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.
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.
public 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.
public 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.
Package
objects that describes the layer packages.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.
VolumeConfigurations
object that describes the layer's Amazon EBS volumes.public Boolean enableAutoHealing()
Whether to disable auto healing for the layer.
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.
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.
public Recipes customRecipes()
A LayerCustomRecipes
object that specifies the layer custom recipes.
LayerCustomRecipes
object that specifies the layer custom recipes.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
.
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
.
public Boolean useEbsOptimizedInstances()
Whether to use Amazon EBS-optimized instances.
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.
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.public CreateLayerRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateLayerRequest.Builder,CreateLayerRequest>
toBuilder
in class OpsWorksRequest
public static CreateLayerRequest.Builder builder()
public static Class<? extends CreateLayerRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.