Struct aws_sdk_opsworks::client::fluent_builders::RegisterInstance

pub struct RegisterInstance<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to RegisterInstance.

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

Required Permissions: 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 Managing User Permissions.

Implementations

impl<C, M, R> RegisterInstance<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<RegisterInstanceOutput, SdkError<RegisterInstanceError>> where
    R::Policy: SmithyRetryPolicy<RegisterInstanceInputOperationOutputAlias, RegisterInstanceOutput, RegisterInstanceError, RegisterInstanceInputOperationRetryAlias>, 

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, which can be set when configuring the client.

pub fn stack_id(self, input: impl Into<String>) -> Self

The ID of the stack that the instance is to be registered with.

pub fn set_stack_id(self, input: Option<String>) -> Self

The ID of the stack that the instance is to be registered with.

pub fn hostname(self, input: impl Into<String>) -> Self

The instance's hostname.

pub fn set_hostname(self, input: Option<String>) -> Self

The instance's hostname.

pub fn public_ip(self, input: impl Into<String>) -> Self

The instance's public IP address.

pub fn set_public_ip(self, input: Option<String>) -> Self

The instance's public IP address.

pub fn private_ip(self, input: impl Into<String>) -> Self

The instance's private IP address.

pub fn set_private_ip(self, input: Option<String>) -> Self

The instance's private IP address.

pub fn rsa_public_key(self, input: impl Into<String>) -> Self

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

pub fn set_rsa_public_key(self, input: Option<String>) -> Self

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

pub fn rsa_public_key_fingerprint(self, input: impl Into<String>) -> Self

The instances public RSA key fingerprint.

pub fn set_rsa_public_key_fingerprint(self, input: Option<String>) -> Self

The instances public RSA key fingerprint.

pub fn instance_identity(self, input: InstanceIdentity) -> Self

An InstanceIdentity object that contains the instance's identity.

pub fn set_instance_identity(self, input: Option<InstanceIdentity>) -> Self

An InstanceIdentity object that contains the instance's identity.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for RegisterInstance<C, M, R>

fn clone(&self) -> RegisterInstance<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for RegisterInstance<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.