Interface UpdateLayerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateLayerRequest.Builder,
,UpdateLayerRequest> OpsWorksRequest.Builder
,SdkBuilder<UpdateLayerRequest.Builder,
,UpdateLayerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateLayerRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributes
(Map<LayerAttributesKeys, String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.attributesWithStrings
(Map<String, String> attributes) One or more user-defined key/value pairs to be added to the stack attributes.autoAssignElasticIps
(Boolean autoAssignElasticIps) Whether to automatically assign an Elastic IP address to the layer's instances.autoAssignPublicIps
(Boolean autoAssignPublicIps) For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.default UpdateLayerRequest.Builder
cloudWatchLogsConfiguration
(Consumer<CloudWatchLogsConfiguration.Builder> cloudWatchLogsConfiguration) Specifies CloudWatch Logs configuration options for the layer.cloudWatchLogsConfiguration
(CloudWatchLogsConfiguration cloudWatchLogsConfiguration) Specifies CloudWatch Logs configuration options for the layer.customInstanceProfileArn
(String customInstanceProfileArn) The ARN of an IAM profile to be used for all of the layer's EC2 instances.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) ALayerCustomRecipes
object that specifies the layer's custom recipes.customRecipes
(Recipes customRecipes) ALayerCustomRecipes
object that specifies the layer's custom recipes.customSecurityGroupIds
(String... customSecurityGroupIds) An array containing the layer's custom security group IDs.customSecurityGroupIds
(Collection<String> customSecurityGroupIds) An array containing the layer's custom security group IDs.enableAutoHealing
(Boolean enableAutoHealing) Whether to disable auto healing for the layer.installUpdatesOnBoot
(Boolean installUpdatesOnBoot) Whether to install operating system and package updates when the instance boots.The layer ID.default UpdateLayerRequest.Builder
lifecycleEventConfiguration
(Consumer<LifecycleEventConfiguration.Builder> lifecycleEventConfiguration) This is a convenience method that creates an instance of theLifecycleEventConfiguration.Builder
avoiding the need to create one manually viaLifecycleEventConfiguration.builder()
.lifecycleEventConfiguration
(LifecycleEventConfiguration lifecycleEventConfiguration) The layer name, which is used by the console.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.An array ofPackage
objects that describe the layer's packages.packages
(Collection<String> packages) An array ofPackage
objects that describe the layer's packages.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.useEbsOptimizedInstances
(Boolean useEbsOptimizedInstances) Whether to use Amazon EBS-optimized instances.volumeConfigurations
(Collection<VolumeConfiguration> volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.volumeConfigurations
(Consumer<VolumeConfiguration.Builder>... volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.volumeConfigurations
(VolumeConfiguration... volumeConfigurations) AVolumeConfigurations
object that describes the layer's Amazon EBS volumes.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.services.opsworks.model.OpsWorksRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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 method that creates an instance of theCloudWatchLogsConfiguration.Builder
avoiding the need to create one manually viaCloudWatchLogsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchLogsConfiguration(CloudWatchLogsConfiguration)
.- Parameters:
cloudWatchLogsConfiguration
- a consumer that will call methods onCloudWatchLogsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
An array of
Package
objects that describe the layer's packages.- Parameters:
packages
- An array ofPackage
objects that describe the layer's packages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
packages
An array of
Package
objects that describe the layer's packages.- Parameters:
packages
- An array ofPackage
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
- AVolumeConfigurations
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
A
VolumeConfigurations
object that describes the layer's Amazon EBS volumes.- Parameters:
volumeConfigurations
- AVolumeConfigurations
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
This is a convenience method that creates an instance of theVolumeConfigurations
object that describes the layer's Amazon EBS volumes.VolumeConfiguration.Builder
avoiding the need to create one manually viaVolumeConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovolumeConfigurations(List<VolumeConfiguration>)
.- Parameters:
volumeConfigurations
- a consumer that will call methods onVolumeConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
A
LayerCustomRecipes
object that specifies the layer's custom recipes.- Parameters:
customRecipes
- ALayerCustomRecipes
object that specifies the layer's custom recipes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customRecipes
A
This is a convenience method that creates an instance of theLayerCustomRecipes
object that specifies the layer's custom recipes.Recipes.Builder
avoiding the need to create one manually viaRecipes.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomRecipes(Recipes)
.- Parameters:
customRecipes
- a consumer that will call methods onRecipes.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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 istrue
. To control when updates are installed, set this value tofalse
. You must then update your instances manually by using CreateDeployment to run theupdate_dependencies
stack command or manually runningyum
(Amazon Linux) orapt-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
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 method that creates an instance of theLifecycleEventConfiguration.Builder
avoiding the need to create one manually viaLifecycleEventConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolifecycleEventConfiguration(LifecycleEventConfiguration)
.- Parameters:
lifecycleEventConfiguration
- a consumer that will call methods onLifecycleEventConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateLayerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-