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

Interface Layer.Builder

All Superinterfaces:

CopyableBuilder<Layer.Builder,Layer>, SdkBuilder<Layer.Builder,Layer>

Enclosing class:

Layer

public static interface Layer.Builder
extends CopyableBuilder<Layer.Builder,Layer>

Method Summary

Modifier and Type	Method	Description
Layer.Builder	arn(String arn)
Layer.Builder	attributes(Map<String,String> attributes)	The layer attributes.
Layer.Builder	autoAssignElasticIps(Boolean autoAssignElasticIps)	Whether to automatically assign an Elastic IP address to the layer's instances.
Layer.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.
Layer.Builder	cloudWatchLogsConfiguration(CloudWatchLogsConfiguration cloudWatchLogsConfiguration)	The Amazon CloudWatch Logs configuration settings for the layer.
Layer.Builder	createdAt(String createdAt)	Date when the layer was created.
Layer.Builder	customInstanceProfileArn(String customInstanceProfileArn)	The ARN of the default IAM profile to be used for the layer's EC2 instances.
Layer.Builder	customJson(String customJson)	A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
Layer.Builder	customRecipes(Recipes customRecipes)	A LayerCustomRecipes object that specifies the layer's custom recipes.
Layer.Builder	customSecurityGroupIds(String... customSecurityGroupIds)	An array containing the layer's custom security group IDs.
Layer.Builder	customSecurityGroupIds(Collection<String> customSecurityGroupIds)	An array containing the layer's custom security group IDs.
Layer.Builder	defaultRecipes(Recipes defaultRecipes)
Layer.Builder	defaultSecurityGroupNames(String... defaultSecurityGroupNames)	An array containing the layer's security group names.
Layer.Builder	defaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)	An array containing the layer's security group names.
Layer.Builder	enableAutoHealing(Boolean enableAutoHealing)	Whether auto healing is disabled for the layer.
Layer.Builder	installUpdatesOnBoot(Boolean installUpdatesOnBoot)	Whether to install operating system and package updates when the instance boots.
Layer.Builder	layerId(String layerId)	The layer ID.
Layer.Builder	lifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)	A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Layer.Builder	name(String name)	The layer name.
Layer.Builder	packages(String... packages)	An array of Package objects that describe the layer's packages.
Layer.Builder	packages(Collection<String> packages)	An array of Package objects that describe the layer's packages.
Layer.Builder	shortname(String shortname)	The layer short name.
Layer.Builder	stackId(String stackId)	The layer stack ID.
Layer.Builder	type(String type)	The layer type.
Layer.Builder	type(LayerType type)	The layer type.
Layer.Builder	useEbsOptimizedInstances(Boolean useEbsOptimizedInstances)	Whether the layer uses Amazon EBS-optimized instances.
Layer.Builder	volumeConfigurations(Collection<VolumeConfiguration> volumeConfigurations)	A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
Layer.Builder	volumeConfigurations(VolumeConfiguration... volumeConfigurations)	A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

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

copy

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

apply, build

Method Detail

arn

Layer.Builder arn(String arn)

Parameters:

arn -

Returns:

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

stackId

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

layerId

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

type

Layer.Builder type(String type)

The layer type.

Parameters:

type - The layer type.

Returns:

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

See Also:

LayerType

type

Layer.Builder type(LayerType type)

The layer type.

Parameters:

type - The layer type.

Returns:

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

See Also:

LayerType

name

Layer.Builder name(String name)

The layer name.

Parameters:

name - The layer name.

Returns:

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

shortname

Layer.Builder shortname(String shortname)

The layer short name.

Parameters:

shortname - The layer short name.

Returns:

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

attributes

Layer.Builder attributes(Map<String,String> attributes)

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

Parameters:

attributes - The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

Returns:

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

cloudWatchLogsConfiguration

Layer.Builder cloudWatchLogsConfiguration(CloudWatchLogsConfiguration cloudWatchLogsConfiguration)

The Amazon CloudWatch Logs configuration settings for the layer.

Parameters:

cloudWatchLogsConfiguration - The Amazon CloudWatch Logs configuration settings for the layer.

Returns:

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

customInstanceProfileArn

Layer.Builder customInstanceProfileArn(String customInstanceProfileArn)

The ARN of the default 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 the default 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

Layer.Builder customJson(String customJson)

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

Parameters:

customJson - A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

Returns:

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

customSecurityGroupIds

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

Layer.Builder customSecurityGroupIds(String... customSecurityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use #setCustomSecurityGroupIds(java.util.Collection) or #withCustomSecurityGroupIds(java.util.Collection) if you want to override the existing values.

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.

defaultSecurityGroupNames

Layer.Builder defaultSecurityGroupNames(Collection<String> defaultSecurityGroupNames)

An array containing the layer's security group names.

Parameters:

defaultSecurityGroupNames - An array containing the layer's security group names.

Returns:

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

defaultSecurityGroupNames

Layer.Builder defaultSecurityGroupNames(String... defaultSecurityGroupNames)

An array containing the layer's security group names.

NOTE: This method appends the values to the existing list (if any). Use #setDefaultSecurityGroupNames(java.util.Collection) or #withDefaultSecurityGroupNames(java.util.Collection) if you want to override the existing values.

Parameters:

defaultSecurityGroupNames - An array containing the layer's security group names.

Returns:

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

packages

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

Layer.Builder packages(String... packages)

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

NOTE: This method appends the values to the existing list (if any). Use #setPackages(java.util.Collection) or #withPackages(java.util.Collection) if you want to override the existing values.

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

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

Layer.Builder volumeConfigurations(VolumeConfiguration... volumeConfigurations)

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

NOTE: This method appends the values to the existing list (if any). Use #setVolumeConfigurations(java.util.Collection) or #withVolumeConfigurations(java.util.Collection) if you want to override the existing values.

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.

enableAutoHealing

Layer.Builder enableAutoHealing(Boolean enableAutoHealing)

Whether auto healing is disabled for the layer.

Parameters:

enableAutoHealing - Whether auto healing is disabled for the layer.

Returns:

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

autoAssignElasticIps

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

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

defaultRecipes

Layer.Builder defaultRecipes(Recipes defaultRecipes)

Parameters:

defaultRecipes -

Returns:

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

customRecipes

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

createdAt

Layer.Builder createdAt(String createdAt)

Date when the layer was created.

Parameters:

createdAt - Date when the layer was created.

Returns:

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

installUpdatesOnBoot

Layer.Builder installUpdatesOnBoot(Boolean installUpdatesOnBoot)

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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. If this value is set 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

Layer.Builder useEbsOptimizedInstances(Boolean useEbsOptimizedInstances)

Whether the layer uses Amazon EBS-optimized instances.

Parameters:

useEbsOptimizedInstances - Whether the layer uses Amazon EBS-optimized instances.

Returns:

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

lifecycleEventConfiguration

Layer.Builder lifecycleEventConfiguration(LifecycleEventConfiguration lifecycleEventConfiguration)

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

Parameters:

lifecycleEventConfiguration - A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

Returns:

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