outscale_api/models/
create_image_request.rs

1/*
2 * 3DS OUTSCALE API
3 *
4 * Welcome to the OUTSCALE API documentation.<br /> The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br /> Throttling: To protect against overloads, the number of identical requests allowed in a given time period is limited.<br /> Brute force: To protect against brute force attacks, the number of failed authentication attempts in a given time period is limited.<br /><br /> Note that the OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but there are [differences in resource names](https://docs.outscale.com/en/userguide/About-the-APIs.html) between AWS and the OUTSCALE API.<br /> You can also manage your resources using the [Cockpit](https://docs.outscale.com/en/userguide/About-Cockpit.html) web interface.<br /><br /> An OpenAPI description of the OUTSCALE API is also available in this [GitHub repository](https://github.com/outscale/osc-api).<br /> # Authentication Schemes ### Access Key/Secret Key The main way to authenticate your requests to the OUTSCALE API is to use an access key and a secret key.<br /> The mechanism behind this is based on AWS Signature Version 4, whose technical implementation details are described in [Signature of API Requests](https://docs.outscale.com/en/userguide/Signature-of-API-Requests.html).<br /><br /> In practice, the way to specify your access key and secret key depends on the tool or SDK you want to use to interact with the API.<br />  > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify your access key, secret key, and the Region of your account. > 2. You then specify the `--profile` option when executing OSC CLI commands. > > For more information, see [Installing and Configuring OSC CLI](https://docs.outscale.com/en/userguide/Installing-and-Configuring-OSC-CLI.html).  See the code samples in each section of this documentation for specific examples in different programming languages.<br /> For more information about access keys, see [About Access Keys](https://docs.outscale.com/en/userguide/About-Access-Keys.html).  > If you try to sign requests with an invalid access key four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes.  ### Login/Password For certain API actions, you can also use basic authentication with the login (email address) and password of your TINA account.<br /> This is useful only in special circumstances, for example if you do not know your access key/secret key and want to retrieve them programmatically.<br /> In most cases, however, you can use the Cockpit web interface to retrieve them.<br />  > For example, if you use OSC CLI: > 1. You need to create an **~/.osc/config.json** file to specify the Region of your account, but you leave the access key value and secret key value empty (`&quot;&quot;`). > 2. You then specify the `--profile`, `--authentication-method`, `--login`, and `--password` options when executing OSC CLI commands.  See the code samples in each section of this documentation for specific examples in different programming languages.  > If you try to sign requests with an invalid password four times in a row, further authentication attempts will be prevented for 1 minute. This lockout time increases 1 minute every four failed attempts, for up to 10 minutes.  ### No Authentication A few API actions do not require any authentication. They are indicated as such in this documentation.<br /> ### Other Security Mechanisms In parallel with the authentication schemes, you can add other security mechanisms to your OUTSCALE account, for example to restrict API requests by IP or other criteria.<br /> For more information, see [Managing Your API Accesses](https://docs.outscale.com/en/userguide/Managing-Your-API-Accesses.html). # Pagination Tutorial You can learn more about the pagination methods for read calls in the dedicated [pagination tutorial](https://docs.outscale.com/en/userguide/Tutorial-Paginating-an-API-Request.html). # Error Codes Reference You can learn more about errors returned by the API in the dedicated [errors page](api-errors.html).
5 *
6 * The version of the OpenAPI document: 1.34.3
7 * Contact: support@outscale.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
12pub struct CreateImageRequest {
13    /// **When registering from a snapshot:** The architecture of the OMI (`i386` or `x86_64`).
14    #[serde(rename = "Architecture", skip_serializing_if = "Option::is_none")]
15    pub architecture: Option<String>,
16    /// **(required) When registering from a snapshot:** One or more block device mappings.
17    #[serde(
18        rename = "BlockDeviceMappings",
19        skip_serializing_if = "Option::is_none"
20    )]
21    pub block_device_mappings: Option<Vec<crate::models::BlockDeviceMappingImage>>,
22    /// A description for the new OMI.
23    #[serde(rename = "Description", skip_serializing_if = "Option::is_none")]
24    pub description: Option<String>,
25    /// If true, checks whether you have the required permissions to perform the action.
26    #[serde(rename = "DryRun", skip_serializing_if = "Option::is_none")]
27    pub dry_run: Option<bool>,
28    /// **(required) When registering from a bucket by using a manifest file:** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html).
29    #[serde(rename = "FileLocation", skip_serializing_if = "Option::is_none")]
30    pub file_location: Option<String>,
31    /// A unique name for the new OMI.<br /> Constraints: 3-128 alphanumeric characters, underscores (`_`), spaces (` `), parentheses (`()`), slashes (`/`), periods (`.`), or dashes (`-`).
32    #[serde(rename = "ImageName", skip_serializing_if = "Option::is_none")]
33    pub image_name: Option<String>,
34    /// **When creating from a VM:** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not.
35    #[serde(rename = "NoReboot", skip_serializing_if = "Option::is_none")]
36    pub no_reboot: Option<bool>,
37    /// The product codes associated with the OMI.
38    #[serde(rename = "ProductCodes", skip_serializing_if = "Option::is_none")]
39    pub product_codes: Option<Vec<String>>,
40    /// **(required) When registering from a snapshot:** The name of the root device for the new OMI.
41    #[serde(rename = "RootDeviceName", skip_serializing_if = "Option::is_none")]
42    pub root_device_name: Option<String>,
43    /// **(required) When copying an OMI:** The ID of the OMI you want to copy.
44    #[serde(rename = "SourceImageId", skip_serializing_if = "Option::is_none")]
45    pub source_image_id: Option<String>,
46    /// **(required) When copying an OMI:** The name of the source Region (always the same as the Region of your account).
47    #[serde(rename = "SourceRegionName", skip_serializing_if = "Option::is_none")]
48    pub source_region_name: Option<String>,
49    /// **(required) When creating from a VM:** The ID of the VM from which you want to create the OMI.
50    #[serde(rename = "VmId", skip_serializing_if = "Option::is_none")]
51    pub vm_id: Option<String>,
52}
53
54impl CreateImageRequest {
55    pub fn new() -> CreateImageRequest {
56        CreateImageRequest {
57            architecture: None,
58            block_device_mappings: None,
59            description: None,
60            dry_run: None,
61            file_location: None,
62            image_name: None,
63            no_reboot: None,
64            product_codes: None,
65            root_device_name: None,
66            source_image_id: None,
67            source_region_name: None,
68            vm_id: None,
69        }
70    }
71}
outscale_api/models/create_image_request.rs

outscale_api/models/
create_image_request.rs
