software.amazon.awssdk.services.opsworks.model

Interface UpdateLayerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<UpdateLayerRequest.Builder,UpdateLayerRequest>, OpsWorksRequest.Builder, SdkBuilder<UpdateLayerRequest.Builder,UpdateLayerRequest>, SdkRequest.Builder

Enclosing class:

UpdateLayerRequest

public static interface UpdateLayerRequest.Builder
extends OpsWorksRequest.Builder, CopyableBuilder<UpdateLayerRequest.Builder,UpdateLayerRequest>

Method Summary

Modifier and Type	Method and Description
UpdateLayerRequest.Builder	attributes(Map<LayerAttributesKeys,String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.
UpdateLayerRequest.Builder	attributesWithStrings(Map<String,String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.
UpdateLayerRequest.Builder	autoAssignElasticIps(Boolean autoAssignElasticIps) Whether to automatically assign an Elastic IP address to the layer's instances.
UpdateLayerRequest.Builder	autoAssignPublicIps(Boolean autoAssignPublicIps) For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.
UpdateLayerRequest.Builder	cloudWatchLogsConfiguration(CloudWatchLogsConfiguration cloudWatchLogsConfiguration) Specifies CloudWatch Logs configuration options for the layer.
default UpdateLayerRequest.Builder	cloudWatchLogsConfiguration(Consumer<CloudWatchLogsConfiguration.Builder> cloudWatchLogsConfiguration) Specifies CloudWatch Logs configuration options for the layer.
UpdateLayerRequest.Builder	customInstanceProfileArn(String customInstanceProfileArn) The ARN of an IAM profile to be used for all of the layer's EC2 instances.
UpdateLayerRequest.Builder	customJson(String customJson) A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances.
default UpdateLayerRequest.Builder	customRecipes(Consumer<Recipes.Builder> customRecipes) A LayerCustomRecipes object that specifies the layer's custom recipes.
UpdateLayerRequest.Builder	customRecipes(Recipes customRecipes) A LayerCustomRecipes object that specifies the layer's custom recipes.
UpdateLayerRequest.Builder	customSecurityGroupIds(Collection<String> customSecurityGroupIds) An array containing the layer's custom security group IDs.
UpdateLayerRequest.Builder	customSecurityGroupIds(String... customSecurityGroupIds) An array containing the layer's custom security group IDs.
UpdateLayerRequest.Builder	enableAutoHealing(Boolean enableAutoHealing) Whether to disable auto healing for the layer.
UpdateLayerRequest.Builder	installUpdatesOnBoot(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.
UpdateLayerRequest.Builder	layerId(String layerId) The layer ID.
default UpdateLayerRequest.Builder	lifecycleEventConfiguration(Consumer<LifecycleEventConfiguration.Builder> lifecycleEventConfiguration) This is a convenience that creates an instance of the LifecycleEventConfiguration.Builder avoiding the need to create one manually via LifecycleEventConfiguration.builder().
UpdateLayerRequest.Builder	lifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)
UpdateLayerRequest.Builder	name(String name) The layer name, which is used by the console.
UpdateLayerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateLayerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateLayerRequest.Builder	packages(Collection<String> packages) An array of Package objects that describe the layer's packages.
UpdateLayerRequest.Builder	packages(String... packages) An array of Package objects that describe the layer's packages.
UpdateLayerRequest.Builder	shortname(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	useEbsOptimizedInstances(Boolean useEbsOptimizedInstances) Whether to use Amazon EBS-optimized instances.
UpdateLayerRequest.Builder	volumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
UpdateLayerRequest.Builder	volumeConfigurations(Consumer<VolumeConfiguration.Builder>... volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
UpdateLayerRequest.Builder	volumeConfigurations(VolumeConfiguration... volumeConfigurations) A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Methods inherited from interface software.amazon.awssdk.services.opsworks.model.OpsWorksRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Method Detail

layerId

UpdateLayerRequest.Builder layerId(String layerId)

The layer ID.

Parameters:

layerId - The layer ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

UpdateLayerRequest.Builder name(String name)

The layer name, which is used by the console.

Parameters:

name - The layer name, which is used by the console.

Returns:

Returns a reference to this object so that method calls can be chained together.

shortname

UpdateLayerRequest.Builder shortname(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

attributesWithStrings

UpdateLayerRequest.Builder attributesWithStrings(Map<String,String> attributes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

attributes

UpdateLayerRequest.Builder attributes(Map<LayerAttributesKeys,String> attributes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLogsConfiguration

UpdateLayerRequest.Builder cloudWatchLogsConfiguration(CloudWatchLogsConfiguration cloudWatchLogsConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLogsConfiguration

default UpdateLayerRequest.Builder cloudWatchLogsConfiguration(Consumer<CloudWatchLogsConfiguration.Builder> cloudWatchLogsConfiguration)

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

This is a convenience that creates an instance of the CloudWatchLogsConfiguration.Builder avoiding the need to create one manually via CloudWatchLogsConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLogsConfiguration(CloudWatchLogsConfiguration).

Parameters:

cloudWatchLogsConfiguration - a consumer that will call methods on CloudWatchLogsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cloudWatchLogsConfiguration(CloudWatchLogsConfiguration)

customInstanceProfileArn

UpdateLayerRequest.Builder customInstanceProfileArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customJson

UpdateLayerRequest.Builder customJson(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customSecurityGroupIds

UpdateLayerRequest.Builder customSecurityGroupIds(Collection<String> customSecurityGroupIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

customSecurityGroupIds

UpdateLayerRequest.Builder customSecurityGroupIds(String... customSecurityGroupIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

packages

UpdateLayerRequest.Builder packages(Collection<String> packages)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

packages

UpdateLayerRequest.Builder packages(String... packages)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeConfigurations

UpdateLayerRequest.Builder volumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeConfigurations

UpdateLayerRequest.Builder volumeConfigurations(VolumeConfiguration... volumeConfigurations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

volumeConfigurations

UpdateLayerRequest.Builder volumeConfigurations(Consumer<VolumeConfiguration.Builder>... volumeConfigurations)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #volumeConfigurations(List).

Parameters:

volumeConfigurations - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#volumeConfigurations(List)

enableAutoHealing

UpdateLayerRequest.Builder enableAutoHealing(Boolean enableAutoHealing)

Whether to disable auto healing for the layer.

Parameters:

enableAutoHealing - Whether to disable auto healing for the layer.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoAssignElasticIps

UpdateLayerRequest.Builder autoAssignElasticIps(Boolean autoAssignElasticIps)

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

Parameters:

autoAssignElasticIps - Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoAssignPublicIps

UpdateLayerRequest.Builder autoAssignPublicIps(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customRecipes

UpdateLayerRequest.Builder customRecipes(Recipes customRecipes)

A LayerCustomRecipes object that specifies the layer's custom recipes.

Parameters:

customRecipes - A LayerCustomRecipes object that specifies the layer's custom recipes.

Returns:

Returns a reference to this object so that method calls can be chained together.

customRecipes

default UpdateLayerRequest.Builder customRecipes(Consumer<Recipes.Builder> customRecipes)

A LayerCustomRecipes object that specifies the layer's custom recipes.

This is a convenience that creates an instance of the Recipes.Builder avoiding the need to create one manually via Recipes.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customRecipes(Recipes).

Parameters:

customRecipes - a consumer that will call methods on Recipes.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

customRecipes(Recipes)

installUpdatesOnBoot

UpdateLayerRequest.Builder installUpdatesOnBoot(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

useEbsOptimizedInstances

UpdateLayerRequest.Builder useEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

Whether to use Amazon EBS-optimized instances.

Parameters:

useEbsOptimizedInstances - Whether to use Amazon EBS-optimized instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleEventConfiguration

UpdateLayerRequest.Builder lifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

Parameters:

lifecycleEventConfiguration -

Returns:

Returns a reference to this object so that method calls can be chained together.

lifecycleEventConfiguration

default UpdateLayerRequest.Builder lifecycleEventConfiguration(Consumer<LifecycleEventConfiguration.Builder> lifecycleEventConfiguration)

This is a convenience that creates an instance of the LifecycleEventConfiguration.Builder avoiding the need to create one manually via LifecycleEventConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifecycleEventConfiguration(LifecycleEventConfiguration).

Parameters:

lifecycleEventConfiguration - a consumer that will call methods on LifecycleEventConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lifecycleEventConfiguration(LifecycleEventConfiguration)

overrideConfiguration

UpdateLayerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateLayerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.