Struct RunInstancesInput

Source

#[non_exhaustive]
pub struct RunInstancesInput {Show 43 fields
    pub block_device_mappings: Option<Vec<BlockDeviceMapping>>,
    pub image_id: Option<String>,
    pub instance_type: Option<InstanceType>,
    pub ipv6_address_count: Option<i32>,
    pub ipv6_addresses: Option<Vec<InstanceIpv6Address>>,
    pub kernel_id: Option<String>,
    pub key_name: Option<String>,
    pub max_count: Option<i32>,
    pub min_count: Option<i32>,
    pub monitoring: Option<RunInstancesMonitoringEnabled>,
    pub placement: Option<Placement>,
    pub ramdisk_id: Option<String>,
    pub security_group_ids: Option<Vec<String>>,
    pub security_groups: Option<Vec<String>>,
    pub subnet_id: Option<String>,
    pub user_data: Option<String>,
    pub elastic_gpu_specification: Option<Vec<ElasticGpuSpecification>>,
    pub elastic_inference_accelerators: Option<Vec<ElasticInferenceAccelerator>>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub launch_template: Option<LaunchTemplateSpecification>,
    pub instance_market_options: Option<InstanceMarketOptionsRequest>,
    pub credit_specification: Option<CreditSpecificationRequest>,
    pub cpu_options: Option<CpuOptionsRequest>,
    pub capacity_reservation_specification: Option<CapacityReservationSpecification>,
    pub hibernation_options: Option<HibernationOptionsRequest>,
    pub license_specifications: Option<Vec<LicenseConfigurationRequest>>,
    pub metadata_options: Option<InstanceMetadataOptionsRequest>,
    pub enclave_options: Option<EnclaveOptionsRequest>,
    pub private_dns_name_options: Option<PrivateDnsNameOptionsRequest>,
    pub maintenance_options: Option<InstanceMaintenanceOptionsRequest>,
    pub disable_api_stop: Option<bool>,
    pub enable_primary_ipv6: Option<bool>,
    pub network_performance_options: Option<InstanceNetworkPerformanceOptionsRequest>,
    pub operator: Option<OperatorRequest>,
    pub dry_run: Option<bool>,
    pub disable_api_termination: Option<bool>,
    pub instance_initiated_shutdown_behavior: Option<ShutdownBehavior>,
    pub private_ip_address: Option<String>,
    pub client_token: Option<String>,
    pub additional_info: Option<String>,
    pub network_interfaces: Option<Vec<InstanceNetworkInterfaceSpecification>>,
    pub iam_instance_profile: Option<IamInstanceProfileSpecification>,
    pub ebs_optimized: Option<bool>,
}

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§block_device_mappings: Option<Vec<BlockDeviceMapping>>

The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

§image_id: Option<String>

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

§instance_type: Option<InstanceType>

The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

§ipv6_address_count: Option<i32>

The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

§ipv6_addresses: Option<Vec<InstanceIpv6Address>>

The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

§kernel_id: Option<String>

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

§key_name: Option<String>

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

§max_count: Option<i32>

The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count.

Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas.

§min_count: Option<i32>

The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.

Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see Amazon EC2 instance type quotas.

§monitoring: Option<RunInstancesMonitoringEnabled>

Specifies whether detailed monitoring is enabled for the instance.

§placement: Option<Placement>

The placement for the instance.

§ramdisk_id: Option<String>

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

§security_group_ids: Option<Vec<String>>

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

§security_groups: Option<Vec<String>>

\[Default VPC\] The names of the security groups.

If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.

Default: Amazon EC2 uses the default security group.

§subnet_id: Option<String>

The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

§user_data: Option<String>

The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.

§elastic_gpu_specification: Option<Vec<ElasticGpuSpecification>>

An elastic GPU to associate with the instance.

Amazon Elastic Graphics reached end of life on January 8, 2024.

§elastic_inference_accelerators: Option<Vec<ElasticInferenceAccelerator>>

An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference is no longer available.

§tag_specifications: Option<Vec<TagSpecification>>

The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

Instances
Volumes
Spot Instance requests
Network interfaces

To tag a resource after it has been created, see CreateTags.

§launch_template: Option<LaunchTemplateSpecification>

The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

§instance_market_options: Option<InstanceMarketOptionsRequest>

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

§credit_specification: Option<CreditSpecificationRequest>

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

§cpu_options: Option<CpuOptionsRequest>

The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

§capacity_reservation_specification: Option<CapacityReservationSpecification>

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy).

§hibernation_options: Option<HibernationOptionsRequest>

Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

§license_specifications: Option<Vec<LicenseConfigurationRequest>>

The license configurations.

§metadata_options: Option<InstanceMetadataOptionsRequest>

The metadata options for the instance. For more information, see Instance metadata and user data.

§enclave_options: Option<EnclaveOptionsRequest>

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

§private_dns_name_options: Option<PrivateDnsNameOptionsRequest>

The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.

§maintenance_options: Option<InstanceMaintenanceOptionsRequest>

The maintenance and recovery options for the instance.

§disable_api_stop: Option<bool>

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

§enable_primary_ipv6: Option<bool>

If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

§network_performance_options: Option<InstanceNetworkPerformanceOptionsRequest>

Contains settings for the network performance options for the instance.

§operator: Option<OperatorRequest>

Reserved for internal use.

§dry_run: Option<bool>

Checks whether you have the required permissions for the operation, 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.

§disable_api_termination: Option<bool>

Indicates whether termination protection is enabled for the instance. The default is false, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

§instance_initiated_shutdown_behavior: Option<ShutdownBehavior>

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

Default: stop

§private_ip_address: Option<String>

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

§client_token: Option<String>

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

§additional_info: Option<String>

Reserved.

§network_interfaces: Option<Vec<InstanceNetworkInterfaceSpecification>>

The network interfaces to associate with the instance.

§iam_instance_profile: Option<IamInstanceProfileSpecification>

The name or Amazon Resource Name (ARN) of an IAM instance profile.

§ebs_optimized: Option<bool>

Indicates 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 Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

Struct RunInstancesInputCopy item path

Fields (Non-exhaustive)§

Implementations§

impl RunInstancesInput

pub fn block_device_mappings(&self) -> &[BlockDeviceMapping]

pub fn image_id(&self) -> Option<&str>

pub fn instance_type(&self) -> Option<&InstanceType>

pub fn ipv6_address_count(&self) -> Option<i32>

pub fn ipv6_addresses(&self) -> &[InstanceIpv6Address]

pub fn kernel_id(&self) -> Option<&str>

pub fn key_name(&self) -> Option<&str>

pub fn max_count(&self) -> Option<i32>

pub fn min_count(&self) -> Option<i32>

pub fn monitoring(&self) -> Option<&RunInstancesMonitoringEnabled>

pub fn placement(&self) -> Option<&Placement>

pub fn ramdisk_id(&self) -> Option<&str>

pub fn security_group_ids(&self) -> &[String]

pub fn security_groups(&self) -> &[String]

pub fn subnet_id(&self) -> Option<&str>

pub fn user_data(&self) -> Option<&str>

pub fn elastic_gpu_specification(&self) -> &[ElasticGpuSpecification]

pub fn elastic_inference_accelerators(&self) -> &[ElasticInferenceAccelerator]

pub fn tag_specifications(&self) -> &[TagSpecification]

pub fn launch_template(&self) -> Option<&LaunchTemplateSpecification>

pub fn instance_market_options(&self) -> Option<&InstanceMarketOptionsRequest>

pub fn credit_specification(&self) -> Option<&CreditSpecificationRequest>

pub fn cpu_options(&self) -> Option<&CpuOptionsRequest>

pub fn capacity_reservation_specification( &self, ) -> Option<&CapacityReservationSpecification>

pub fn hibernation_options(&self) -> Option<&HibernationOptionsRequest>

pub fn license_specifications(&self) -> &[LicenseConfigurationRequest]

pub fn metadata_options(&self) -> Option<&InstanceMetadataOptionsRequest>

pub fn enclave_options(&self) -> Option<&EnclaveOptionsRequest>

pub fn private_dns_name_options(&self) -> Option<&PrivateDnsNameOptionsRequest>

pub fn maintenance_options(&self) -> Option<&InstanceMaintenanceOptionsRequest>

pub fn disable_api_stop(&self) -> Option<bool>

pub fn enable_primary_ipv6(&self) -> Option<bool>

pub fn network_performance_options( &self, ) -> Option<&InstanceNetworkPerformanceOptionsRequest>

pub fn operator(&self) -> Option<&OperatorRequest>

pub fn dry_run(&self) -> Option<bool>

pub fn disable_api_termination(&self) -> Option<bool>

pub fn instance_initiated_shutdown_behavior(&self) -> Option<&ShutdownBehavior>

pub fn private_ip_address(&self) -> Option<&str>

pub fn client_token(&self) -> Option<&str>

pub fn additional_info(&self) -> Option<&str>

pub fn network_interfaces(&self) -> &[InstanceNetworkInterfaceSpecification]

pub fn iam_instance_profile(&self) -> Option<&IamInstanceProfileSpecification>

pub fn ebs_optimized(&self) -> Option<bool>

impl RunInstancesInput

pub fn builder() -> RunInstancesInputBuilder

Trait Implementations§

impl Clone for RunInstancesInput

fn clone(&self) -> RunInstancesInput

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

impl Debug for RunInstancesInput

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

impl PartialEq for RunInstancesInput

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

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

impl StructuralPartialEq for RunInstancesInput

Auto Trait Implementations§

impl Freeze for RunInstancesInput

impl RefUnwindSafe for RunInstancesInput

impl Send for RunInstancesInput

impl Sync for RunInstancesInput

impl Unpin for RunInstancesInput

impl UnwindSafe for RunInstancesInput

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

Struct RunInstancesInput

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,