// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_instance::_create_instance_output::CreateInstanceOutputBuilder;
pub use crate::operation::create_instance::_create_instance_input::CreateInstanceInputBuilder;
/// Fluent builder constructing a request to `CreateInstance`.
///
/// <p>Creates an instance in a specified stack. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html">Adding an Instance to a Layer</a>.</p>
/// <p> <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User Permissions</a>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateInstanceFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_instance::builders::CreateInstanceInputBuilder,
}
impl CreateInstanceFluentBuilder {
/// Creates a new `CreateInstance`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_instance::CreateInstance,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::create_instance::CreateInstanceError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::create_instance::CreateInstanceOutput,
aws_smithy_http::result::SdkError<crate::operation::create_instance::CreateInstanceError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The stack ID.</p>
pub fn stack_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.stack_id(input.into());
self
}
/// <p>The stack ID.</p>
pub fn set_stack_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_stack_id(input);
self
}
/// Appends an item to `LayerIds`.
///
/// To override the contents of this collection use [`set_layer_ids`](Self::set_layer_ids).
///
/// <p>An array that contains the instance's layer IDs.</p>
pub fn layer_ids(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.layer_ids(input.into());
self
}
/// <p>An array that contains the instance's layer IDs.</p>
pub fn set_layer_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_layer_ids(input);
self
}
/// <p>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</p>
pub fn instance_type(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.instance_type(input.into());
self
}
/// <p>The instance type, such as <code>t2.micro</code>. For a list of supported instance types, open the stack in the console, choose <b>Instances</b>, and choose <b>+ Instance</b>. The <b>Size</b> list contains the currently supported types. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>. The parameter values that you use to specify the various types are in the <b>API Name</b> column of the <b>Available Instance Types</b> table.</p>
pub fn set_instance_type(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_instance_type(input);
self
}
/// <p>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</p>
pub fn auto_scaling_type(mut self, input: crate::types::AutoScalingType) -> Self {
self.inner = self.inner.auto_scaling_type(input);
self
}
/// <p>For load-based or time-based instances, the type. Windows stacks can use only time-based instances.</p>
pub fn set_auto_scaling_type(
mut self,
input: std::option::Option<crate::types::AutoScalingType>,
) -> Self {
self.inner = self.inner.set_auto_scaling_type(input);
self
}
/// <p>The instance host name.</p>
pub fn hostname(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.hostname(input.into());
self
}
/// <p>The instance host name.</p>
pub fn set_hostname(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_hostname(input);
self
}
/// <p>The instance's operating system, which must be set to one of the following.</p>
/// <ul>
/// <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li>
/// <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li>
/// <li> <p> <code>CentOS Linux 7</code> </p> </li>
/// <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li>
/// <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li>
/// <li> <p>A custom AMI: <code>Custom</code>.</p> </li>
/// </ul>
/// <p>For more information about the supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</p>
/// <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <code>CreateInstance</code> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information about how to use custom AMIs with AWS OpsWorks Stacks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</p>
pub fn os(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.os(input.into());
self
}
/// <p>The instance's operating system, which must be set to one of the following.</p>
/// <ul>
/// <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2018.03</code>, <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li>
/// <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li>
/// <li> <p> <code>CentOS Linux 7</code> </p> </li>
/// <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li>
/// <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li>
/// <li> <p>A custom AMI: <code>Custom</code>.</p> </li>
/// </ul>
/// <p>For more information about the supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">AWS OpsWorks Stacks Operating Systems</a>.</p>
/// <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <code>CreateInstance</code> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information about supported operating systems, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html">Operating Systems</a>For more information about how to use custom AMIs with AWS OpsWorks Stacks, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</p>
pub fn set_os(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_os(input);
self
}
/// <p>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</p> <note>
/// <p>If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>.</p>
/// </note>
pub fn ami_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ami_id(input.into());
self
}
/// <p>A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html">Using Custom AMIs</a>.</p> <note>
/// <p>If you specify a custom AMI, you must set <code>Os</code> to <code>Custom</code>.</p>
/// </note>
pub fn set_ami_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ami_id(input);
self
}
/// <p>The instance's Amazon EC2 key-pair name.</p>
pub fn ssh_key_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.ssh_key_name(input.into());
self
}
/// <p>The instance's Amazon EC2 key-pair name.</p>
pub fn set_ssh_key_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_ssh_key_name(input);
self
}
/// <p>The instance Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</p>
pub fn availability_zone(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.availability_zone(input.into());
self
}
/// <p>The instance Availability Zone. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>.</p>
pub fn set_availability_zone(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_availability_zone(input);
self
}
/// <p>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>.</p>
pub fn virtualization_type(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.virtualization_type(input.into());
self
}
/// <p>The instance's virtualization type, <code>paravirtual</code> or <code>hvm</code>.</p>
pub fn set_virtualization_type(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_virtualization_type(input);
self
}
/// <p>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.</p>
pub fn subnet_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.subnet_id(input.into());
self
}
/// <p>The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.</p>
pub fn set_subnet_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_subnet_id(input);
self
}
/// <p>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</p>
pub fn architecture(mut self, input: crate::types::Architecture) -> Self {
self.inner = self.inner.architecture(input);
self
}
/// <p>The instance architecture. The default option is <code>x86_64</code>. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Families and Types</a>.</p>
pub fn set_architecture(
mut self,
input: std::option::Option<crate::types::Architecture>,
) -> Self {
self.inner = self.inner.set_architecture(input);
self
}
/// <p>The instance root device type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</p>
pub fn root_device_type(mut self, input: crate::types::RootDeviceType) -> Self {
self.inner = self.inner.root_device_type(input);
self
}
/// <p>The instance root device type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device">Storage for the Root Device</a>.</p>
pub fn set_root_device_type(
mut self,
input: std::option::Option<crate::types::RootDeviceType>,
) -> Self {
self.inner = self.inner.set_root_device_type(input);
self
}
/// Appends an item to `BlockDeviceMappings`.
///
/// To override the contents of this collection use [`set_block_device_mappings`](Self::set_block_device_mappings).
///
/// <p>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>. Note that block device mappings are not supported for custom AMIs.</p>
pub fn block_device_mappings(mut self, input: crate::types::BlockDeviceMapping) -> Self {
self.inner = self.inner.block_device_mappings(input);
self
}
/// <p>An array of <code>BlockDeviceMapping</code> objects that specify the instance's block devices. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a>. Note that block device mappings are not supported for custom AMIs.</p>
pub fn set_block_device_mappings(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::BlockDeviceMapping>>,
) -> Self {
self.inner = self.inner.set_block_device_mappings(input);
self
}
/// <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>We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates.</p>
/// </note>
pub fn install_updates_on_boot(mut self, input: bool) -> Self {
self.inner = self.inner.install_updates_on_boot(input);
self
}
/// <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>We strongly recommend using the default value of <code>true</code> to ensure that your instances have the latest security updates.</p>
/// </note>
pub fn set_install_updates_on_boot(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_install_updates_on_boot(input);
self
}
/// <p>Whether to create an Amazon EBS-optimized instance.</p>
pub fn ebs_optimized(mut self, input: bool) -> Self {
self.inner = self.inner.ebs_optimized(input);
self
}
/// <p>Whether to create an Amazon EBS-optimized instance.</p>
pub fn set_ebs_optimized(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_ebs_optimized(input);
self
}
/// <p>The default AWS OpsWorks Stacks agent version. You have the following options:</p>
/// <ul>
/// <li> <p> <code>INHERIT</code> - Use the stack's default agent version setting.</p> </li>
/// <li> <p> <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.</p> </li>
/// </ul>
/// <p>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <code>DescribeAgentVersions</code>. AgentVersion cannot be set to Chef 12.2.</p>
pub fn agent_version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.agent_version(input.into());
self
}
/// <p>The default AWS OpsWorks Stacks agent version. You have the following options:</p>
/// <ul>
/// <li> <p> <code>INHERIT</code> - Use the stack's default agent version setting.</p> </li>
/// <li> <p> <i>version_number</i> - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.</p> </li>
/// </ul>
/// <p>The default setting is <code>INHERIT</code>. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call <code>DescribeAgentVersions</code>. AgentVersion cannot be set to Chef 12.2.</p>
pub fn set_agent_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_agent_version(input);
self
}
/// <p>The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: <code>dedicated</code>, <code>default</code>, or <code>host</code>. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Dedicated Hosts Overview</a> and <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Amazon EC2 Dedicated Hosts</a>. For more information about dedicated instances, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> and <a href="http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/">Amazon EC2 Dedicated Instances</a>.</p>
pub fn tenancy(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.tenancy(input.into());
self
}
/// <p>The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: <code>dedicated</code>, <code>default</code>, or <code>host</code>. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Dedicated Hosts Overview</a> and <a href="http://aws.amazon.com/ec2/dedicated-hosts/">Amazon EC2 Dedicated Hosts</a>. For more information about dedicated instances, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html">Dedicated Instances</a> and <a href="http://aws.amazon.com/ec2/purchasing-options/dedicated-instances/">Amazon EC2 Dedicated Instances</a>.</p>
pub fn set_tenancy(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_tenancy(input);
self
}
}