outscale_api/models/
create_vm_group_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 CreateVmGroupRequest {
13    /// A description for the VM group.
14    #[serde(rename = "Description", skip_serializing_if = "Option::is_none")]
15    pub description: Option<String>,
16    /// If true, checks whether you have the required permissions to perform the action.
17    #[serde(rename = "DryRun", skip_serializing_if = "Option::is_none")]
18    pub dry_run: Option<bool>,
19    /// The positioning strategy of VMs on hypervisors. By default, or if set to `no-strategy` our orchestrator determines the most adequate position for your VMs. If set to `attract`, your VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, your VMs are deployed on a different hypervisor, which improves fault tolerance.
20    #[serde(
21        rename = "PositioningStrategy",
22        skip_serializing_if = "Option::is_none"
23    )]
24    pub positioning_strategy: Option<PositioningStrategy>,
25    /// One or more IDs of security groups for the VM group.
26    #[serde(rename = "SecurityGroupIds")]
27    pub security_group_ids: Vec<String>,
28    /// The ID of the Subnet in which you want to create the VM group.
29    #[serde(rename = "SubnetId")]
30    pub subnet_id: String,
31    /// One or more tags to add to the VM group.
32    #[serde(rename = "Tags", skip_serializing_if = "Option::is_none")]
33    pub tags: Option<Vec<crate::models::ResourceTag>>,
34    /// The number of VMs deployed in the VM group.
35    #[serde(rename = "VmCount")]
36    pub vm_count: i32,
37    /// The name of the VM group.
38    #[serde(rename = "VmGroupName")]
39    pub vm_group_name: String,
40    /// The ID of the VM template used to launch VMs in the VM group.
41    #[serde(rename = "VmTemplateId")]
42    pub vm_template_id: String,
43}
44
45impl CreateVmGroupRequest {
46    pub fn new(
47        security_group_ids: Vec<String>,
48        subnet_id: String,
49        vm_count: i32,
50        vm_group_name: String,
51        vm_template_id: String,
52    ) -> CreateVmGroupRequest {
53        CreateVmGroupRequest {
54            description: None,
55            dry_run: None,
56            positioning_strategy: None,
57            security_group_ids,
58            subnet_id,
59            tags: None,
60            vm_count,
61            vm_group_name,
62            vm_template_id,
63        }
64    }
65}
66
67/// The positioning strategy of VMs on hypervisors. By default, or if set to `no-strategy` our orchestrator determines the most adequate position for your VMs. If set to `attract`, your VMs are deployed on the same hypervisor, which improves network performance. If set to `repulse`, your VMs are deployed on a different hypervisor, which improves fault tolerance.
68#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
69pub enum PositioningStrategy {
70    #[serde(rename = "attract")]
71    Attract,
72    #[serde(rename = "no-strategy")]
73    NoStrategy,
74    #[serde(rename = "repulse")]
75    Repulse,
76}
77
78impl Default for PositioningStrategy {
79    fn default() -> PositioningStrategy {
80        Self::Attract
81    }
82}
outscale_api/models/create_vm_group_request.rs

outscale_api/models/
create_vm_group_request.rs
