#[non_exhaustive]pub struct RunInstancesInputBuilder { /* private fields */ }
Expand description
A builder for RunInstancesInput
.
Implementations§
Source§impl RunInstancesInputBuilder
impl RunInstancesInputBuilder
Sourcepub fn block_device_mappings(self, input: BlockDeviceMapping) -> Self
pub fn block_device_mappings(self, input: BlockDeviceMapping) -> Self
Appends an item to block_device_mappings
.
To override the contents of this collection use set_block_device_mappings
.
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.
Sourcepub fn set_block_device_mappings(
self,
input: Option<Vec<BlockDeviceMapping>>,
) -> Self
pub fn set_block_device_mappings( self, input: Option<Vec<BlockDeviceMapping>>, ) -> Self
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.
Sourcepub fn get_block_device_mappings(&self) -> &Option<Vec<BlockDeviceMapping>>
pub fn get_block_device_mappings(&self) -> &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.
Sourcepub fn image_id(self, input: impl Into<String>) -> Self
pub fn image_id(self, input: impl Into<String>) -> Self
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
Sourcepub fn set_image_id(self, input: Option<String>) -> Self
pub fn set_image_id(self, input: Option<String>) -> Self
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
Sourcepub fn get_image_id(&self) -> &Option<String>
pub fn get_image_id(&self) -> &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.
Sourcepub fn instance_type(self, input: InstanceType) -> Self
pub fn instance_type(self, input: InstanceType) -> Self
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
Sourcepub fn set_instance_type(self, input: Option<InstanceType>) -> Self
pub fn set_instance_type(self, input: Option<InstanceType>) -> Self
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
Sourcepub fn get_instance_type(&self) -> &Option<InstanceType>
pub fn get_instance_type(&self) -> &Option<InstanceType>
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
Sourcepub fn ipv6_address_count(self, input: i32) -> Self
pub fn ipv6_address_count(self, input: i32) -> Self
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.
Sourcepub fn set_ipv6_address_count(self, input: Option<i32>) -> Self
pub fn set_ipv6_address_count(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_ipv6_address_count(&self) -> &Option<i32>
pub fn get_ipv6_address_count(&self) -> &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.
Sourcepub fn ipv6_addresses(self, input: InstanceIpv6Address) -> Self
pub fn ipv6_addresses(self, input: InstanceIpv6Address) -> Self
Appends an item to ipv6_addresses
.
To override the contents of this collection use set_ipv6_addresses
.
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.
Sourcepub fn set_ipv6_addresses(self, input: Option<Vec<InstanceIpv6Address>>) -> Self
pub fn set_ipv6_addresses(self, input: Option<Vec<InstanceIpv6Address>>) -> Self
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.
Sourcepub fn get_ipv6_addresses(&self) -> &Option<Vec<InstanceIpv6Address>>
pub fn get_ipv6_addresses(&self) -> &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.
Sourcepub fn kernel_id(self, input: impl Into<String>) -> Self
pub fn kernel_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_kernel_id(self, input: Option<String>) -> Self
pub fn set_kernel_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_kernel_id(&self) -> &Option<String>
pub fn get_kernel_id(&self) -> &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.
Sourcepub fn key_name(self, input: impl Into<String>) -> Self
pub fn key_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_key_name(self, input: Option<String>) -> Self
pub fn set_key_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_key_name(&self) -> &Option<String>
pub fn get_key_name(&self) -> &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.
Sourcepub fn max_count(self, input: i32) -> Self
pub fn max_count(self, input: i32) -> Self
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.
This field is required.Sourcepub fn set_max_count(self, input: Option<i32>) -> Self
pub fn set_max_count(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_max_count(&self) -> &Option<i32>
pub fn get_max_count(&self) -> &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.
Sourcepub fn min_count(self, input: i32) -> Self
pub fn min_count(self, input: i32) -> Self
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.
This field is required.Sourcepub fn set_min_count(self, input: Option<i32>) -> Self
pub fn set_min_count(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_min_count(&self) -> &Option<i32>
pub fn get_min_count(&self) -> &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.
Sourcepub fn monitoring(self, input: RunInstancesMonitoringEnabled) -> Self
pub fn monitoring(self, input: RunInstancesMonitoringEnabled) -> Self
Specifies whether detailed monitoring is enabled for the instance.
Sourcepub fn set_monitoring(
self,
input: Option<RunInstancesMonitoringEnabled>,
) -> Self
pub fn set_monitoring( self, input: Option<RunInstancesMonitoringEnabled>, ) -> Self
Specifies whether detailed monitoring is enabled for the instance.
Sourcepub fn get_monitoring(&self) -> &Option<RunInstancesMonitoringEnabled>
pub fn get_monitoring(&self) -> &Option<RunInstancesMonitoringEnabled>
Specifies whether detailed monitoring is enabled for the instance.
Sourcepub fn set_placement(self, input: Option<Placement>) -> Self
pub fn set_placement(self, input: Option<Placement>) -> Self
The placement for the instance.
Sourcepub fn get_placement(&self) -> &Option<Placement>
pub fn get_placement(&self) -> &Option<Placement>
The placement for the instance.
Sourcepub fn ramdisk_id(self, input: impl Into<String>) -> Self
pub fn ramdisk_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_ramdisk_id(self, input: Option<String>) -> Self
pub fn set_ramdisk_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_ramdisk_id(&self) -> &Option<String>
pub fn get_ramdisk_id(&self) -> &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.
Sourcepub fn security_group_ids(self, input: impl Into<String>) -> Self
pub fn security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to security_group_ids
.
To override the contents of this collection use set_security_group_ids
.
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.
Sourcepub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_security_group_ids(&self) -> &Option<Vec<String>>
pub fn get_security_group_ids(&self) -> &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.
Sourcepub fn security_groups(self, input: impl Into<String>) -> Self
pub fn security_groups(self, input: impl Into<String>) -> Self
Appends an item to security_groups
.
To override the contents of this collection use set_security_groups
.
\[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.
Sourcepub fn set_security_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_security_groups(self, input: Option<Vec<String>>) -> Self
\[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.
Sourcepub fn get_security_groups(&self) -> &Option<Vec<String>>
pub fn get_security_groups(&self) -> &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.
Sourcepub fn subnet_id(self, input: impl Into<String>) -> Self
pub fn subnet_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_subnet_id(self, input: Option<String>) -> Self
pub fn set_subnet_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_subnet_id(&self) -> &Option<String>
pub fn get_subnet_id(&self) -> &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.
Sourcepub fn user_data(self, input: impl Into<String>) -> Self
pub fn user_data(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_user_data(self, input: Option<String>) -> Self
pub fn set_user_data(self, input: Option<String>) -> Self
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.
Sourcepub fn get_user_data(&self) -> &Option<String>
pub fn get_user_data(&self) -> &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.
Sourcepub fn elastic_gpu_specification(self, input: ElasticGpuSpecification) -> Self
pub fn elastic_gpu_specification(self, input: ElasticGpuSpecification) -> Self
Appends an item to elastic_gpu_specification
.
To override the contents of this collection use set_elastic_gpu_specification
.
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
Sourcepub fn set_elastic_gpu_specification(
self,
input: Option<Vec<ElasticGpuSpecification>>,
) -> Self
pub fn set_elastic_gpu_specification( self, input: Option<Vec<ElasticGpuSpecification>>, ) -> Self
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
Sourcepub fn get_elastic_gpu_specification(
&self,
) -> &Option<Vec<ElasticGpuSpecification>>
pub fn get_elastic_gpu_specification( &self, ) -> &Option<Vec<ElasticGpuSpecification>>
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
Sourcepub fn elastic_inference_accelerators(
self,
input: ElasticInferenceAccelerator,
) -> Self
pub fn elastic_inference_accelerators( self, input: ElasticInferenceAccelerator, ) -> Self
Appends an item to elastic_inference_accelerators
.
To override the contents of this collection use set_elastic_inference_accelerators
.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference is no longer available.
Sourcepub fn set_elastic_inference_accelerators(
self,
input: Option<Vec<ElasticInferenceAccelerator>>,
) -> Self
pub fn set_elastic_inference_accelerators( self, input: Option<Vec<ElasticInferenceAccelerator>>, ) -> Self
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference is no longer available.
Sourcepub fn get_elastic_inference_accelerators(
&self,
) -> &Option<Vec<ElasticInferenceAccelerator>>
pub fn get_elastic_inference_accelerators( &self, ) -> &Option<Vec<ElasticInferenceAccelerator>>
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference is no longer available.
Sourcepub fn tag_specifications(self, input: TagSpecification) -> Self
pub fn tag_specifications(self, input: TagSpecification) -> Self
Appends an item to tag_specifications
.
To override the contents of this collection use set_tag_specifications
.
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.
Sourcepub fn set_tag_specifications(
self,
input: Option<Vec<TagSpecification>>,
) -> Self
pub fn set_tag_specifications( self, input: Option<Vec<TagSpecification>>, ) -> Self
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.
Sourcepub fn get_tag_specifications(&self) -> &Option<Vec<TagSpecification>>
pub fn get_tag_specifications(&self) -> &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.
Sourcepub fn launch_template(self, input: LaunchTemplateSpecification) -> Self
pub fn launch_template(self, input: LaunchTemplateSpecification) -> Self
The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
Sourcepub fn set_launch_template(
self,
input: Option<LaunchTemplateSpecification>,
) -> Self
pub fn set_launch_template( self, input: Option<LaunchTemplateSpecification>, ) -> Self
The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
Sourcepub fn get_launch_template(&self) -> &Option<LaunchTemplateSpecification>
pub fn get_launch_template(&self) -> &Option<LaunchTemplateSpecification>
The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
Sourcepub fn instance_market_options(
self,
input: InstanceMarketOptionsRequest,
) -> Self
pub fn instance_market_options( self, input: InstanceMarketOptionsRequest, ) -> Self
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
.
Sourcepub fn set_instance_market_options(
self,
input: Option<InstanceMarketOptionsRequest>,
) -> Self
pub fn set_instance_market_options( self, input: Option<InstanceMarketOptionsRequest>, ) -> Self
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
.
Sourcepub fn get_instance_market_options(
&self,
) -> &Option<InstanceMarketOptionsRequest>
pub fn get_instance_market_options( &self, ) -> &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
.
Sourcepub fn credit_specification(self, input: CreditSpecificationRequest) -> Self
pub fn credit_specification(self, input: CreditSpecificationRequest) -> Self
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.
Sourcepub fn set_credit_specification(
self,
input: Option<CreditSpecificationRequest>,
) -> Self
pub fn set_credit_specification( self, input: Option<CreditSpecificationRequest>, ) -> Self
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.
Sourcepub fn get_credit_specification(&self) -> &Option<CreditSpecificationRequest>
pub fn get_credit_specification(&self) -> &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.
Sourcepub fn cpu_options(self, input: CpuOptionsRequest) -> Self
pub fn cpu_options(self, input: CpuOptionsRequest) -> Self
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
Sourcepub fn set_cpu_options(self, input: Option<CpuOptionsRequest>) -> Self
pub fn set_cpu_options(self, input: Option<CpuOptionsRequest>) -> Self
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
Sourcepub fn get_cpu_options(&self) -> &Option<CpuOptionsRequest>
pub fn get_cpu_options(&self) -> &Option<CpuOptionsRequest>
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
Sourcepub fn capacity_reservation_specification(
self,
input: CapacityReservationSpecification,
) -> Self
pub fn capacity_reservation_specification( self, input: CapacityReservationSpecification, ) -> Self
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).
Sourcepub fn set_capacity_reservation_specification(
self,
input: Option<CapacityReservationSpecification>,
) -> Self
pub fn set_capacity_reservation_specification( self, input: Option<CapacityReservationSpecification>, ) -> Self
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).
Sourcepub fn get_capacity_reservation_specification(
&self,
) -> &Option<CapacityReservationSpecification>
pub fn get_capacity_reservation_specification( &self, ) -> &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).
Sourcepub fn hibernation_options(self, input: HibernationOptionsRequest) -> Self
pub fn hibernation_options(self, input: HibernationOptionsRequest) -> Self
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.
Sourcepub fn set_hibernation_options(
self,
input: Option<HibernationOptionsRequest>,
) -> Self
pub fn set_hibernation_options( self, input: Option<HibernationOptionsRequest>, ) -> Self
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.
Sourcepub fn get_hibernation_options(&self) -> &Option<HibernationOptionsRequest>
pub fn get_hibernation_options(&self) -> &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.
Sourcepub fn license_specifications(self, input: LicenseConfigurationRequest) -> Self
pub fn license_specifications(self, input: LicenseConfigurationRequest) -> Self
Appends an item to license_specifications
.
To override the contents of this collection use set_license_specifications
.
The license configurations.
Sourcepub fn set_license_specifications(
self,
input: Option<Vec<LicenseConfigurationRequest>>,
) -> Self
pub fn set_license_specifications( self, input: Option<Vec<LicenseConfigurationRequest>>, ) -> Self
The license configurations.
Sourcepub fn get_license_specifications(
&self,
) -> &Option<Vec<LicenseConfigurationRequest>>
pub fn get_license_specifications( &self, ) -> &Option<Vec<LicenseConfigurationRequest>>
The license configurations.
Sourcepub fn metadata_options(self, input: InstanceMetadataOptionsRequest) -> Self
pub fn metadata_options(self, input: InstanceMetadataOptionsRequest) -> Self
The metadata options for the instance. For more information, see Instance metadata and user data.
Sourcepub fn set_metadata_options(
self,
input: Option<InstanceMetadataOptionsRequest>,
) -> Self
pub fn set_metadata_options( self, input: Option<InstanceMetadataOptionsRequest>, ) -> Self
The metadata options for the instance. For more information, see Instance metadata and user data.
Sourcepub fn get_metadata_options(&self) -> &Option<InstanceMetadataOptionsRequest>
pub fn get_metadata_options(&self) -> &Option<InstanceMetadataOptionsRequest>
The metadata options for the instance. For more information, see Instance metadata and user data.
Sourcepub fn enclave_options(self, input: EnclaveOptionsRequest) -> Self
pub fn enclave_options(self, input: EnclaveOptionsRequest) -> Self
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.
Sourcepub fn set_enclave_options(self, input: Option<EnclaveOptionsRequest>) -> Self
pub fn set_enclave_options(self, input: Option<EnclaveOptionsRequest>) -> Self
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.
Sourcepub fn get_enclave_options(&self) -> &Option<EnclaveOptionsRequest>
pub fn get_enclave_options(&self) -> &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.
Sourcepub fn private_dns_name_options(
self,
input: PrivateDnsNameOptionsRequest,
) -> Self
pub fn private_dns_name_options( self, input: PrivateDnsNameOptionsRequest, ) -> Self
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.
Sourcepub fn set_private_dns_name_options(
self,
input: Option<PrivateDnsNameOptionsRequest>,
) -> Self
pub fn set_private_dns_name_options( self, input: Option<PrivateDnsNameOptionsRequest>, ) -> Self
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.
Sourcepub fn get_private_dns_name_options(
&self,
) -> &Option<PrivateDnsNameOptionsRequest>
pub fn get_private_dns_name_options( &self, ) -> &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.
Sourcepub fn maintenance_options(
self,
input: InstanceMaintenanceOptionsRequest,
) -> Self
pub fn maintenance_options( self, input: InstanceMaintenanceOptionsRequest, ) -> Self
The maintenance and recovery options for the instance.
Sourcepub fn set_maintenance_options(
self,
input: Option<InstanceMaintenanceOptionsRequest>,
) -> Self
pub fn set_maintenance_options( self, input: Option<InstanceMaintenanceOptionsRequest>, ) -> Self
The maintenance and recovery options for the instance.
Sourcepub fn get_maintenance_options(
&self,
) -> &Option<InstanceMaintenanceOptionsRequest>
pub fn get_maintenance_options( &self, ) -> &Option<InstanceMaintenanceOptionsRequest>
The maintenance and recovery options for the instance.
Sourcepub fn disable_api_stop(self, input: bool) -> Self
pub fn disable_api_stop(self, input: bool) -> Self
Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
Sourcepub fn set_disable_api_stop(self, input: Option<bool>) -> Self
pub fn set_disable_api_stop(self, input: Option<bool>) -> Self
Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
Sourcepub fn get_disable_api_stop(&self) -> &Option<bool>
pub fn get_disable_api_stop(&self) -> &Option<bool>
Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
Sourcepub fn enable_primary_ipv6(self, input: bool) -> Self
pub fn enable_primary_ipv6(self, input: bool) -> Self
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.
Sourcepub fn set_enable_primary_ipv6(self, input: Option<bool>) -> Self
pub fn set_enable_primary_ipv6(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_enable_primary_ipv6(&self) -> &Option<bool>
pub fn get_enable_primary_ipv6(&self) -> &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.
Sourcepub fn network_performance_options(
self,
input: InstanceNetworkPerformanceOptionsRequest,
) -> Self
pub fn network_performance_options( self, input: InstanceNetworkPerformanceOptionsRequest, ) -> Self
Contains settings for the network performance options for the instance.
Sourcepub fn set_network_performance_options(
self,
input: Option<InstanceNetworkPerformanceOptionsRequest>,
) -> Self
pub fn set_network_performance_options( self, input: Option<InstanceNetworkPerformanceOptionsRequest>, ) -> Self
Contains settings for the network performance options for the instance.
Sourcepub fn get_network_performance_options(
&self,
) -> &Option<InstanceNetworkPerformanceOptionsRequest>
pub fn get_network_performance_options( &self, ) -> &Option<InstanceNetworkPerformanceOptionsRequest>
Contains settings for the network performance options for the instance.
Sourcepub fn operator(self, input: OperatorRequest) -> Self
pub fn operator(self, input: OperatorRequest) -> Self
Reserved for internal use.
Sourcepub fn set_operator(self, input: Option<OperatorRequest>) -> Self
pub fn set_operator(self, input: Option<OperatorRequest>) -> Self
Reserved for internal use.
Sourcepub fn get_operator(&self) -> &Option<OperatorRequest>
pub fn get_operator(&self) -> &Option<OperatorRequest>
Reserved for internal use.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
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
.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &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
.
Sourcepub fn disable_api_termination(self, input: bool) -> Self
pub fn disable_api_termination(self, input: bool) -> Self
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.
Sourcepub fn set_disable_api_termination(self, input: Option<bool>) -> Self
pub fn set_disable_api_termination(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_disable_api_termination(&self) -> &Option<bool>
pub fn get_disable_api_termination(&self) -> &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.
Sourcepub fn instance_initiated_shutdown_behavior(
self,
input: ShutdownBehavior,
) -> Self
pub fn instance_initiated_shutdown_behavior( self, input: ShutdownBehavior, ) -> Self
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
Sourcepub fn set_instance_initiated_shutdown_behavior(
self,
input: Option<ShutdownBehavior>,
) -> Self
pub fn set_instance_initiated_shutdown_behavior( self, input: Option<ShutdownBehavior>, ) -> Self
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
Sourcepub fn get_instance_initiated_shutdown_behavior(
&self,
) -> &Option<ShutdownBehavior>
pub fn get_instance_initiated_shutdown_behavior( &self, ) -> &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
Sourcepub fn private_ip_address(self, input: impl Into<String>) -> Self
pub fn private_ip_address(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_private_ip_address(self, input: Option<String>) -> Self
pub fn set_private_ip_address(self, input: Option<String>) -> Self
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.
Sourcepub fn get_private_ip_address(&self) -> &Option<String>
pub fn get_private_ip_address(&self) -> &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.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
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
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &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
Sourcepub fn additional_info(self, input: impl Into<String>) -> Self
pub fn additional_info(self, input: impl Into<String>) -> Self
Reserved.
Sourcepub fn set_additional_info(self, input: Option<String>) -> Self
pub fn set_additional_info(self, input: Option<String>) -> Self
Reserved.
Sourcepub fn get_additional_info(&self) -> &Option<String>
pub fn get_additional_info(&self) -> &Option<String>
Reserved.
Sourcepub fn network_interfaces(
self,
input: InstanceNetworkInterfaceSpecification,
) -> Self
pub fn network_interfaces( self, input: InstanceNetworkInterfaceSpecification, ) -> Self
Appends an item to network_interfaces
.
To override the contents of this collection use set_network_interfaces
.
The network interfaces to associate with the instance.
Sourcepub fn set_network_interfaces(
self,
input: Option<Vec<InstanceNetworkInterfaceSpecification>>,
) -> Self
pub fn set_network_interfaces( self, input: Option<Vec<InstanceNetworkInterfaceSpecification>>, ) -> Self
The network interfaces to associate with the instance.
Sourcepub fn get_network_interfaces(
&self,
) -> &Option<Vec<InstanceNetworkInterfaceSpecification>>
pub fn get_network_interfaces( &self, ) -> &Option<Vec<InstanceNetworkInterfaceSpecification>>
The network interfaces to associate with the instance.
Sourcepub fn iam_instance_profile(
self,
input: IamInstanceProfileSpecification,
) -> Self
pub fn iam_instance_profile( self, input: IamInstanceProfileSpecification, ) -> Self
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Sourcepub fn set_iam_instance_profile(
self,
input: Option<IamInstanceProfileSpecification>,
) -> Self
pub fn set_iam_instance_profile( self, input: Option<IamInstanceProfileSpecification>, ) -> Self
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Sourcepub fn get_iam_instance_profile(
&self,
) -> &Option<IamInstanceProfileSpecification>
pub fn get_iam_instance_profile( &self, ) -> &Option<IamInstanceProfileSpecification>
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Sourcepub fn ebs_optimized(self, input: bool) -> Self
pub fn ebs_optimized(self, input: bool) -> Self
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
Sourcepub fn set_ebs_optimized(self, input: Option<bool>) -> Self
pub fn set_ebs_optimized(self, input: Option<bool>) -> Self
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
Sourcepub fn get_ebs_optimized(&self) -> &Option<bool>
pub fn get_ebs_optimized(&self) -> &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
Sourcepub fn build(self) -> Result<RunInstancesInput, BuildError>
pub fn build(self) -> Result<RunInstancesInput, BuildError>
Consumes the builder and constructs a RunInstancesInput
.
Source§impl RunInstancesInputBuilder
impl RunInstancesInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<RunInstancesOutput, SdkError<RunInstancesError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<RunInstancesOutput, SdkError<RunInstancesError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for RunInstancesInputBuilder
impl Clone for RunInstancesInputBuilder
Source§fn clone(&self) -> RunInstancesInputBuilder
fn clone(&self) -> RunInstancesInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RunInstancesInputBuilder
impl Debug for RunInstancesInputBuilder
Source§impl Default for RunInstancesInputBuilder
impl Default for RunInstancesInputBuilder
Source§fn default() -> RunInstancesInputBuilder
fn default() -> RunInstancesInputBuilder
Source§impl PartialEq for RunInstancesInputBuilder
impl PartialEq for RunInstancesInputBuilder
impl StructuralPartialEq for RunInstancesInputBuilder
Auto Trait Implementations§
impl Freeze for RunInstancesInputBuilder
impl RefUnwindSafe for RunInstancesInputBuilder
impl Send for RunInstancesInputBuilder
impl Sync for RunInstancesInputBuilder
impl Unpin for RunInstancesInputBuilder
impl UnwindSafe for RunInstancesInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);