aws_sdk_ec2/client/

modify_instance_placement.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyInstancePlacement`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`group_name(impl Into<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_group_name):<br>required: **false**<br><p>The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of <code>default</code>. For cluster and partition placement groups, the instance must have a tenancy of <code>default</code> or <code>dedicated</code>.</p> <p>To remove an instance from a placement group, specify an empty string ("").</p><br>
    ///   - [`partition_number(i32)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::partition_number) / [`set_partition_number(Option<i32>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_partition_number):<br>required: **false**<br><p>The number of the partition in which to place the instance. Valid only if the placement group strategy is set to <code>partition</code>.</p><br>
    ///   - [`host_resource_group_arn(impl Into<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::host_resource_group_arn) / [`set_host_resource_group_arn(Option<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_host_resource_group_arn):<br>required: **false**<br><p>The ARN of the host resource group in which to place the instance. The instance must have a tenancy of <code>host</code> to specify this parameter.</p><br>
    ///   - [`group_id(impl Into<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::group_id) / [`set_group_id(Option<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_group_id):<br>required: **false**<br><p>The Group Id of a placement group. You must specify the Placement Group <b>Group Id</b> to launch an instance in a shared placement group.</p><br>
    ///   - [`instance_id(impl Into<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_instance_id):<br>required: **true**<br><p>The ID of the instance that you are modifying.</p><br>
    ///   - [`tenancy(HostTenancy)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::tenancy) / [`set_tenancy(Option<HostTenancy>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_tenancy):<br>required: **false**<br><p>The tenancy for the instance.</p><note>  <p>For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of <code>host</code>. You can't change the tenancy from <code>host</code> to <code>dedicated</code> or <code>default</code>. Attempting to make one of these unsupported tenancy changes results in an <code>InvalidRequest</code> error code.</p> </note><br>
    ///   - [`affinity(Affinity)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::affinity) / [`set_affinity(Option<Affinity>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_affinity):<br>required: **false**<br><p>The affinity setting for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity">Host affinity</a> in the <i>Amazon EC2 User Guide</i>.</p><br>
    ///   - [`host_id(impl Into<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::host_id) / [`set_host_id(Option<String>)`](crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::set_host_id):<br>required: **false**<br><p>The ID of the Dedicated Host with which to associate the instance.</p><br>
    /// - On success, responds with [`ModifyInstancePlacementOutput`](crate::operation::modify_instance_placement::ModifyInstancePlacementOutput) with field(s):
    ///   - [`r#return(Option<bool>)`](crate::operation::modify_instance_placement::ModifyInstancePlacementOutput::return): <p>Is <code>true</code> if the request succeeds, and an error otherwise.</p>
    /// - On failure, responds with [`SdkError<ModifyInstancePlacementError>`](crate::operation::modify_instance_placement::ModifyInstancePlacementError)
    pub fn modify_instance_placement(&self) -> crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder {
        crate::operation::modify_instance_placement::builders::ModifyInstancePlacementFluentBuilder::new(self.handle.clone())
    }
}