aws_sdk_opsworks/client/
register_instance.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 [`RegisterInstance`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_id(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::stack_id) / [`set_stack_id(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_stack_id):<br>required: **true**<br><p>The ID of the stack that the instance is to be registered with.</p><br>
7    ///   - [`hostname(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::hostname) / [`set_hostname(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_hostname):<br>required: **false**<br><p>The instance's host name. The following are character limits for instance host names.</p> <ul>  <li>   <p>Linux-based instances: 63 characters</p></li>  <li>   <p>Windows-based instances: 15 characters</p></li> </ul><br>
8    ///   - [`public_ip(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::public_ip) / [`set_public_ip(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_public_ip):<br>required: **false**<br><p>The instance's public IP address.</p><br>
9    ///   - [`private_ip(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::private_ip) / [`set_private_ip(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_private_ip):<br>required: **false**<br><p>The instance's private IP address.</p><br>
10    ///   - [`rsa_public_key(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::rsa_public_key) / [`set_rsa_public_key(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_rsa_public_key):<br>required: **false**<br><p>The instances public RSA key. This key is used to encrypt communication between the instance and the service.</p><br>
11    ///   - [`rsa_public_key_fingerprint(impl Into<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::rsa_public_key_fingerprint) / [`set_rsa_public_key_fingerprint(Option<String>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_rsa_public_key_fingerprint):<br>required: **false**<br><p>The instances public RSA key fingerprint.</p><br>
12    ///   - [`instance_identity(InstanceIdentity)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::instance_identity) / [`set_instance_identity(Option<InstanceIdentity>)`](crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::set_instance_identity):<br>required: **false**<br><p>An InstanceIdentity object that contains the instance's identity.</p><br>
13    /// - On success, responds with [`RegisterInstanceOutput`](crate::operation::register_instance::RegisterInstanceOutput) with field(s):
14    ///   - [`instance_id(Option<String>)`](crate::operation::register_instance::RegisterInstanceOutput::instance_id): <p>The registered instance's OpsWorks Stacks ID.</p>
15    /// - On failure, responds with [`SdkError<RegisterInstanceError>`](crate::operation::register_instance::RegisterInstanceError)
16    pub fn register_instance(&self) -> crate::operation::register_instance::builders::RegisterInstanceFluentBuilder {
17        crate::operation::register_instance::builders::RegisterInstanceFluentBuilder::new(self.handle.clone())
18    }
19}