aws_sdk_opsworks/client/update_layer.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`UpdateLayer`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`layer_id(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::layer_id) / [`set_layer_id(Option<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_layer_id):<br>required: **true**<br><p>The layer ID.</p><br>
7 /// - [`name(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_name):<br>required: **false**<br><p>The layer name, which is used by the console. Layer names can be a maximum of 32 characters.</p><br>
8 /// - [`shortname(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::shortname) / [`set_shortname(Option<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_shortname):<br>required: **false**<br><p>For custom layers only, use this parameter to specify the layer's short name, which is used internally by 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 32 characters and must be in the following format: /\A\[a-z0-9\-\_\.\]+\Z/.</p> <p>Built-in layer short names are defined by OpsWorks Stacks. For more information, see the <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html">Layer reference</a> in the OpsWorks User Guide.</p><br>
9 /// - [`attributes(LayerAttributesKeys, impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<LayerAttributesKeys, String>>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_attributes):<br>required: **false**<br><p>One or more user-defined key/value pairs to be added to the stack attributes.</p><br>
10 /// - [`cloud_watch_logs_configuration(CloudWatchLogsConfiguration)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::cloud_watch_logs_configuration) / [`set_cloud_watch_logs_configuration(Option<CloudWatchLogsConfiguration>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_cloud_watch_logs_configuration):<br>required: **false**<br><p>Specifies CloudWatch Logs configuration options for the layer. For more information, see <code>CloudWatchLogsLogStream</code>.</p><br>
11 /// - [`custom_instance_profile_arn(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::custom_instance_profile_arn) / [`set_custom_instance_profile_arn(Option<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_custom_instance_profile_arn):<br>required: **false**<br><p>The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html">Using Identifiers</a>.</p><br>
12 /// - [`custom_json(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::custom_json) / [`set_custom_json(Option<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_custom_json):<br>required: **false**<br><p>A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html"> Using Custom JSON</a>.</p><br>
13 /// - [`custom_security_group_ids(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::custom_security_group_ids) / [`set_custom_security_group_ids(Option<Vec::<String>>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_custom_security_group_ids):<br>required: **false**<br><p>An array containing the layer's custom security group IDs.</p><br>
14 /// - [`packages(impl Into<String>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::packages) / [`set_packages(Option<Vec::<String>>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_packages):<br>required: **false**<br><p>An array of <code>Package</code> objects that describe the layer's packages.</p><br>
15 /// - [`volume_configurations(VolumeConfiguration)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::volume_configurations) / [`set_volume_configurations(Option<Vec::<VolumeConfiguration>>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_volume_configurations):<br>required: **false**<br><p>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</p><br>
16 /// - [`enable_auto_healing(bool)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::enable_auto_healing) / [`set_enable_auto_healing(Option<bool>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_enable_auto_healing):<br>required: **false**<br><p>Whether to disable auto healing for the layer.</p><br>
17 /// - [`auto_assign_elastic_ips(bool)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::auto_assign_elastic_ips) / [`set_auto_assign_elastic_ips(Option<bool>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_auto_assign_elastic_ips):<br>required: **false**<br><p>Whether to automatically assign an <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP address</a> to the layer's instances. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</p><br>
18 /// - [`auto_assign_public_ips(bool)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::auto_assign_public_ips) / [`set_auto_assign_public_ips(Option<bool>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_auto_assign_public_ips):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html">How to Edit a Layer</a>.</p><br>
19 /// - [`custom_recipes(Recipes)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::custom_recipes) / [`set_custom_recipes(Option<Recipes>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_custom_recipes):<br>required: **false**<br><p>A <code>LayerCustomRecipes</code> object that specifies the layer's custom recipes.</p><br>
20 /// - [`install_updates_on_boot(bool)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::install_updates_on_boot) / [`set_install_updates_on_boot(Option<bool>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_install_updates_on_boot):<br>required: **false**<br><p>Whether to install operating system and package updates when the instance boots. The default value is <code>true</code>. To control when updates are installed, set this value to <code>false</code>. You must then update your instances manually by using <code>CreateDeployment</code> to run the <code>update_dependencies</code> stack command or manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances.</p><note> <p>We strongly recommend using the default value of <code>true</code>, to ensure that your instances have the latest security updates.</p> </note><br>
21 /// - [`use_ebs_optimized_instances(bool)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::use_ebs_optimized_instances) / [`set_use_ebs_optimized_instances(Option<bool>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_use_ebs_optimized_instances):<br>required: **false**<br><p>Whether to use Amazon EBS-optimized instances.</p><br>
22 /// - [`lifecycle_event_configuration(LifecycleEventConfiguration)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::lifecycle_event_configuration) / [`set_lifecycle_event_configuration(Option<LifecycleEventConfiguration>)`](crate::operation::update_layer::builders::UpdateLayerFluentBuilder::set_lifecycle_event_configuration):<br>required: **false**<br><p></p><br>
23 /// - On success, responds with [`UpdateLayerOutput`](crate::operation::update_layer::UpdateLayerOutput)
24 /// - On failure, responds with [`SdkError<UpdateLayerError>`](crate::operation::update_layer::UpdateLayerError)
25 pub fn update_layer(&self) -> crate::operation::update_layer::builders::UpdateLayerFluentBuilder {
26 crate::operation::update_layer::builders::UpdateLayerFluentBuilder::new(self.handle.clone())
27 }
28}