software.amazon.awssdk.services.opsworks.model

Interface CreateLayerRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateLayerRequest

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

Method Summary

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

stackId

CreateLayerRequest.Builder stackId(String stackId)

The layer stack ID.

Parameters:

stackId - The layer stack ID.

Returns:

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

type

CreateLayerRequest.Builder type(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.

Parameters:

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:

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

See Also:

LayerType, LayerType

type

CreateLayerRequest.Builder type(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.

Parameters:

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:

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

See Also:

LayerType, LayerType

name

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

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

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 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:

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

attributesWithStrings

CreateLayerRequest.Builder attributesWithStrings(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.

Parameters:

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:

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

attributes

CreateLayerRequest.Builder attributes(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.

Parameters:

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:

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

cloudWatchLogsConfiguration

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

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

Parameters:

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:

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

customJson

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

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

Returns:

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

customSecurityGroupIds

CreateLayerRequest.Builder customSecurityGroupIds(Collection<String> customSecurityGroupIds)

An array containing the layer custom security group IDs.

Parameters:

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

Returns:

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

customSecurityGroupIds

CreateLayerRequest.Builder customSecurityGroupIds(String... customSecurityGroupIds)

An array containing the layer custom security group IDs.

Parameters:

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

Returns:

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

packages

CreateLayerRequest.Builder packages(Collection<String> packages)

An array of Package objects that describes the layer packages.

Parameters:

packages - An array of Package objects that describes the layer packages.

Returns:

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

packages

CreateLayerRequest.Builder packages(String... packages)

An array of Package objects that describes the layer packages.

Parameters:

packages - An array of Package objects that describes the layer packages.

Returns:

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

volumeConfigurations

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

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

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

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

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

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

CreateLayerRequest.Builder customRecipes(Recipes customRecipes)

A LayerCustomRecipes object that specifies the layer custom recipes.

Parameters:

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

Returns:

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

customRecipes

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

A LayerCustomRecipes object that specifies the layer 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

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

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 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:

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

useEbsOptimizedInstances

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

CreateLayerRequest.Builder lifecycleEventConfiguration(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.

Parameters:

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:

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

lifecycleEventConfiguration

default CreateLayerRequest.Builder lifecycleEventConfiguration(Consumer<LifecycleEventConfiguration.Builder> 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.

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

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

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