aws_sdk_opsworks/client/

create_layer.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateLayer`](crate::operation::create_layer::builders::CreateLayerFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`stack_id(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::stack_id) / [`set_stack_id(Option<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_stack_id):<br>required: **true**<br><p>The layer stack ID.</p><br>
    ///   - [`r#type(LayerType)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::type) / [`set_type(Option<LayerType>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_type):<br>required: **true**<br><p>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.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_name):<br>required: **true**<br><p>The layer name, which is used by the console. Layer names can be a maximum of 32 characters.</p><br>
    ///   - [`shortname(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::shortname) / [`set_shortname(Option<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_shortname):<br>required: **true**<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 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 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.</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>.</p><br>
    ///   - [`attributes(LayerAttributesKeys, impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<LayerAttributesKeys, String>>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_attributes):<br>required: **false**<br><p>One or more user-defined key-value pairs to be added to the stack attributes.</p> <p>To create a cluster layer, set the <code>EcsClusterArn</code> attribute to the cluster's ARN.</p><br>
    ///   - [`cloud_watch_logs_configuration(CloudWatchLogsConfiguration)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::cloud_watch_logs_configuration) / [`set_cloud_watch_logs_configuration(Option<CloudWatchLogsConfiguration>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::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>
    ///   - [`custom_instance_profile_arn(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::custom_instance_profile_arn) / [`set_custom_instance_profile_arn(Option<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_custom_instance_profile_arn):<br>required: **false**<br><p>The ARN of an IAM profile to be used for 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>
    ///   - [`custom_json(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::custom_json) / [`set_custom_json(Option<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::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>. This feature is supported as of version 1.7.42 of the CLI.</p><br>
    ///   - [`custom_security_group_ids(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::custom_security_group_ids) / [`set_custom_security_group_ids(Option<Vec::<String>>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_custom_security_group_ids):<br>required: **false**<br><p>An array containing the layer custom security group IDs.</p><br>
    ///   - [`packages(impl Into<String>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::packages) / [`set_packages(Option<Vec::<String>>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_packages):<br>required: **false**<br><p>An array of <code>Package</code> objects that describes the layer packages.</p><br>
    ///   - [`volume_configurations(VolumeConfiguration)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::volume_configurations) / [`set_volume_configurations(Option<Vec::<VolumeConfiguration>>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_volume_configurations):<br>required: **false**<br><p>A <code>VolumeConfigurations</code> object that describes the layer's Amazon EBS volumes.</p><br>
    ///   - [`enable_auto_healing(bool)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::enable_auto_healing) / [`set_enable_auto_healing(Option<bool>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_enable_auto_healing):<br>required: **false**<br><p>Whether to disable auto healing for the layer.</p><br>
    ///   - [`auto_assign_elastic_ips(bool)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::auto_assign_elastic_ips) / [`set_auto_assign_elastic_ips(Option<bool>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::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>
    ///   - [`auto_assign_public_ips(bool)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::auto_assign_public_ips) / [`set_auto_assign_public_ips(Option<bool>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::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>
    ///   - [`custom_recipes(Recipes)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::custom_recipes) / [`set_custom_recipes(Option<Recipes>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_custom_recipes):<br>required: **false**<br><p>A <code>LayerCustomRecipes</code> object that specifies the layer custom recipes.</p><br>
    ///   - [`install_updates_on_boot(bool)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::install_updates_on_boot) / [`set_install_updates_on_boot(Option<bool>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::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 by manually running <code>yum</code> (Amazon Linux) or <code>apt-get</code> (Ubuntu) on the instances.</p><note>  <p>To ensure that your instances have the latest security updates, we strongly recommend using the default value of <code>true</code>.</p> </note><br>
    ///   - [`use_ebs_optimized_instances(bool)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::use_ebs_optimized_instances) / [`set_use_ebs_optimized_instances(Option<bool>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_use_ebs_optimized_instances):<br>required: **false**<br><p>Whether to use Amazon EBS-optimized instances.</p><br>
    ///   - [`lifecycle_event_configuration(LifecycleEventConfiguration)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::lifecycle_event_configuration) / [`set_lifecycle_event_configuration(Option<LifecycleEventConfiguration>)`](crate::operation::create_layer::builders::CreateLayerFluentBuilder::set_lifecycle_event_configuration):<br>required: **false**<br><p>A <code>LifeCycleEventConfiguration</code> object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.</p><br>
    /// - On success, responds with [`CreateLayerOutput`](crate::operation::create_layer::CreateLayerOutput) with field(s):
    ///   - [`layer_id(Option<String>)`](crate::operation::create_layer::CreateLayerOutput::layer_id): <p>The layer ID.</p>
    /// - On failure, responds with [`SdkError<CreateLayerError>`](crate::operation::create_layer::CreateLayerError)
    pub fn create_layer(&self) -> crate::operation::create_layer::builders::CreateLayerFluentBuilder {
        crate::operation::create_layer::builders::CreateLayerFluentBuilder::new(self.handle.clone())
    }
}