Struct CreateImageInput

#[non_exhaustive]
pub struct CreateImageInput {
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub dry_run: Option<bool>,
    pub instance_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub no_reboot: Option<bool>,
    pub block_device_mappings: Option<Vec<BlockDeviceMapping>>,
}

Fields (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.

tag_specifications: Option<Vec<TagSpecification>>

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

• To tag the AMI, the value for ResourceType must be image.

• To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

dry_run: Option<bool>

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.

instance_id: Option<String>

The ID of the instance.

name: Option<String>

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets (\[\]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

description: Option<String>

A description for the new image.

no_reboot: Option<bool>

Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:

• true - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.

• false - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.

Default: false

block_device_mappings: Option<Vec<BlockDeviceMapping>>

The block device mappings.

When using the CreateImage action:

• You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.

• You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.

• The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.

Implementations

impl CreateImageInput

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

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

• To tag the AMI, the value for ResourceType must be image.

• To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_specifications.is_none().

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

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.

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

The ID of the instance.

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

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets (\[\]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

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

A description for the new image.

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

Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:

• true - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.

• false - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.

Default: false

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

The block device mappings.

When using the CreateImage action:

• You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.

• You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.

• The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .block_device_mappings.is_none().

impl CreateImageInput

pub fn builder() -> CreateImageInputBuilder

Creates a new builder-style object to manufacture CreateImageInput.

Trait Implementations

impl Clone for CreateImageInput

fn clone(&self) -> CreateImageInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateImageInput

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

Formats the value using the given formatter.

impl PartialEq for CreateImageInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateImageInput