Struct aws_sdk_ec2::input::modify_instance_attribute_input::Builder

pub struct Builder { /* private fields */ }

A builder for ModifyInstanceAttributeInput.

Implementations

impl Builder

pub fn source_dest_check(self, input: AttributeBooleanValue) -> Self

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Examples found in repository

src/client.rs (line 64676)

        pub fn source_dest_check(mut self, input: crate::model::AttributeBooleanValue) -> Self {
            self.inner = self.inner.source_dest_check(input);
            self
        }

pub fn set_source_dest_check(self, input: Option<AttributeBooleanValue>) -> Self

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Examples found in repository

src/client.rs (line 64684)

        pub fn set_source_dest_check(
            mut self,
            input: std::option::Option<crate::model::AttributeBooleanValue>,
        ) -> Self {
            self.inner = self.inner.set_source_dest_check(input);
            self
        }

pub fn attribute(self, input: InstanceAttributeName) -> Self

The name of the attribute to modify.

You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions

Examples found in repository

src/client.rs (line 64691)

        pub fn attribute(mut self, input: crate::model::InstanceAttributeName) -> Self {
            self.inner = self.inner.attribute(input);
            self
        }

pub fn set_attribute(self, input: Option<InstanceAttributeName>) -> Self

The name of the attribute to modify.

You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions

Examples found in repository

src/client.rs (line 64701)

        pub fn set_attribute(
            mut self,
            input: std::option::Option<crate::model::InstanceAttributeName>,
        ) -> Self {
            self.inner = self.inner.set_attribute(input);
            self
        }

pub fn block_device_mappings(
    self,
    input: InstanceBlockDeviceMappingSpecification
) -> Self

Appends an item to block_device_mappings.

To override the contents of this collection use set_block_device_mappings.

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.

Examples found in repository

src/client.rs (line 64714)

        pub fn block_device_mappings(
            mut self,
            input: crate::model::InstanceBlockDeviceMappingSpecification,
        ) -> Self {
            self.inner = self.inner.block_device_mappings(input);
            self
        }

pub fn set_block_device_mappings(
    self,
    input: Option<Vec<InstanceBlockDeviceMappingSpecification>>
) -> Self

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.

Examples found in repository

src/client.rs (line 64725)

        pub fn set_block_device_mappings(
            mut self,
            input: std::option::Option<
                std::vec::Vec<crate::model::InstanceBlockDeviceMappingSpecification>,
            >,
        ) -> Self {
            self.inner = self.inner.set_block_device_mappings(input);
            self
        }

pub fn disable_api_termination(self, input: AttributeBooleanValue) -> Self

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

Examples found in repository

src/client.rs (line 64733)

        pub fn disable_api_termination(
            mut self,
            input: crate::model::AttributeBooleanValue,
        ) -> Self {
            self.inner = self.inner.disable_api_termination(input);
            self
        }

pub fn set_disable_api_termination(
    self,
    input: Option<AttributeBooleanValue>
) -> Self

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

Examples found in repository

src/client.rs (line 64741)

        pub fn set_disable_api_termination(
            mut self,
            input: std::option::Option<crate::model::AttributeBooleanValue>,
        ) -> Self {
            self.inner = self.inner.set_disable_api_termination(input);
            self
        }

pub fn dry_run(self, input: bool) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 64746)

        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

pub fn set_dry_run(self, input: Option<bool>) -> Self

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Examples found in repository

src/client.rs (line 64751)

        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

pub fn ebs_optimized(self, input: AttributeBooleanValue) -> Self

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Examples found in repository

src/client.rs (line 64756)

        pub fn ebs_optimized(mut self, input: crate::model::AttributeBooleanValue) -> Self {
            self.inner = self.inner.ebs_optimized(input);
            self
        }

pub fn set_ebs_optimized(self, input: Option<AttributeBooleanValue>) -> Self

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Examples found in repository

src/client.rs (line 64764)

        pub fn set_ebs_optimized(
            mut self,
            input: std::option::Option<crate::model::AttributeBooleanValue>,
        ) -> Self {
            self.inner = self.inner.set_ebs_optimized(input);
            self
        }

pub fn ena_support(self, input: AttributeBooleanValue) -> Self

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Examples found in repository

src/client.rs (line 64770)

        pub fn ena_support(mut self, input: crate::model::AttributeBooleanValue) -> Self {
            self.inner = self.inner.ena_support(input);
            self
        }

pub fn set_ena_support(self, input: Option<AttributeBooleanValue>) -> Self

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Examples found in repository

src/client.rs (line 64779)

        pub fn set_ena_support(
            mut self,
            input: std::option::Option<crate::model::AttributeBooleanValue>,
        ) -> Self {
            self.inner = self.inner.set_ena_support(input);
            self
        }

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

Appends an item to groups.

To override the contents of this collection use set_groups.

[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

Examples found in repository

src/client.rs (line 64788)

        pub fn groups(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.groups(input.into());
            self
        }

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

[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

Examples found in repository

src/client.rs (line 64796)

        pub fn set_groups(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_groups(input);
            self
        }

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

The ID of the instance.

Examples found in repository

src/client.rs (line 64801)

        pub fn instance_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.instance_id(input.into());
            self
        }

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

The ID of the instance.

Examples found in repository

src/client.rs (line 64806)

        pub fn set_instance_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_instance_id(input);
            self
        }

pub fn instance_initiated_shutdown_behavior(self, input: AttributeValue) -> Self

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Examples found in repository

src/client.rs (line 64814)

        pub fn instance_initiated_shutdown_behavior(
            mut self,
            input: crate::model::AttributeValue,
        ) -> Self {
            self.inner = self.inner.instance_initiated_shutdown_behavior(input);
            self
        }

pub fn set_instance_initiated_shutdown_behavior(
    self,
    input: Option<AttributeValue>
) -> Self

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Examples found in repository

src/client.rs (line 64822)

        pub fn set_instance_initiated_shutdown_behavior(
            mut self,
            input: std::option::Option<crate::model::AttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_instance_initiated_shutdown_behavior(input);
            self
        }

pub fn instance_type(self, input: AttributeValue) -> Self

Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

Examples found in repository

src/client.rs (line 64827)

        pub fn instance_type(mut self, input: crate::model::AttributeValue) -> Self {
            self.inner = self.inner.instance_type(input);
            self
        }

pub fn set_instance_type(self, input: Option<AttributeValue>) -> Self

Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

Examples found in repository

src/client.rs (line 64835)

        pub fn set_instance_type(
            mut self,
            input: std::option::Option<crate::model::AttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_instance_type(input);
            self
        }

pub fn kernel(self, input: AttributeValue) -> Self

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

Examples found in repository

src/client.rs (line 64840)

        pub fn kernel(mut self, input: crate::model::AttributeValue) -> Self {
            self.inner = self.inner.kernel(input);
            self
        }

pub fn set_kernel(self, input: Option<AttributeValue>) -> Self

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

Examples found in repository

src/client.rs (line 64848)

        pub fn set_kernel(
            mut self,
            input: std::option::Option<crate::model::AttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_kernel(input);
            self
        }

pub fn ramdisk(self, input: AttributeValue) -> Self

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

Examples found in repository

src/client.rs (line 64853)

        pub fn ramdisk(mut self, input: crate::model::AttributeValue) -> Self {
            self.inner = self.inner.ramdisk(input);
            self
        }

pub fn set_ramdisk(self, input: Option<AttributeValue>) -> Self

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

Examples found in repository

src/client.rs (line 64861)

        pub fn set_ramdisk(
            mut self,
            input: std::option::Option<crate::model::AttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_ramdisk(input);
            self
        }

pub fn sriov_net_support(self, input: AttributeValue) -> Self

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Examples found in repository

src/client.rs (line 64868)

        pub fn sriov_net_support(mut self, input: crate::model::AttributeValue) -> Self {
            self.inner = self.inner.sriov_net_support(input);
            self
        }

pub fn set_sriov_net_support(self, input: Option<AttributeValue>) -> Self

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Examples found in repository

src/client.rs (line 64878)

        pub fn set_sriov_net_support(
            mut self,
            input: std::option::Option<crate::model::AttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_sriov_net_support(input);
            self
        }

pub fn user_data(self, input: BlobAttributeValue) -> Self

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

Examples found in repository

src/client.rs (line 64883)

        pub fn user_data(mut self, input: crate::model::BlobAttributeValue) -> Self {
            self.inner = self.inner.user_data(input);
            self
        }

pub fn set_user_data(self, input: Option<BlobAttributeValue>) -> Self

Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

Examples found in repository

src/client.rs (line 64891)

        pub fn set_user_data(
            mut self,
            input: std::option::Option<crate::model::BlobAttributeValue>,
        ) -> Self {
            self.inner = self.inner.set_user_data(input);
            self
        }

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

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

Examples found in repository

src/client.rs (line 64896)

        pub fn value(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.value(input.into());
            self
        }

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

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

Examples found in repository

src/client.rs (line 64901)

        pub fn set_value(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_value(input);
            self
        }

pub fn disable_api_stop(self, input: AttributeBooleanValue) -> Self

Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

Examples found in repository

src/client.rs (line 64907)

        pub fn disable_api_stop(mut self, input: crate::model::AttributeBooleanValue) -> Self {
            self.inner = self.inner.disable_api_stop(input);
            self
        }

pub fn set_disable_api_stop(self, input: Option<AttributeBooleanValue>) -> Self

Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

Examples found in repository

src/client.rs (line 64916)

        pub fn set_disable_api_stop(
            mut self,
            input: std::option::Option<crate::model::AttributeBooleanValue>,
        ) -> Self {
            self.inner = self.inner.set_disable_api_stop(input);
            self
        }

pub fn build(self) -> Result<ModifyInstanceAttributeInput, BuildError>

Consumes the builder and constructs a ModifyInstanceAttributeInput.

Examples found in repository

src/client.rs (line 64643)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ModifyInstanceAttribute,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ModifyInstanceAttributeError>,
        > {
            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::operation::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::output::ModifyInstanceAttributeOutput,
            aws_smithy_http::result::SdkError<crate::error::ModifyInstanceAttributeError>,
        > {
            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
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder