-
Notifications
You must be signed in to change notification settings - Fork 0
/
outscale.yaml
24574 lines (24517 loc) · 882 KB
/
outscale.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
components:
schemas:
AcceptNetPeeringRequest:
additionalProperties: false
properties:
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
NetPeeringId:
description: The ID of the Net peering you want to accept.
type: string
required:
- NetPeeringId
type: object
AcceptNetPeeringResponse:
additionalProperties: false
properties:
NetPeering:
"$ref": "#/components/schemas/NetPeering"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
AccepterNet:
additionalProperties: false
description: Information about the accepter Net.
properties:
AccountId:
description: The account ID of the owner of the accepter Net.
type: string
IpRange:
description: The IP range for the accepter Net, in CIDR notation (for example,
`10.0.0.0/16`).
type: string
NetId:
description: The ID of the accepter Net.
type: string
type: object
AccessKey:
additionalProperties: false
description: Information about the access key.
properties:
AccessKeyId:
description: The ID of the access key.
type: string
CreationDate:
description: The date and time (UTC) at which the access key was created.
format: datetime
type: string
ExpirationDate:
description: The date and time (UTC) at which the access key expires.
format: datetime
type: string
LastModificationDate:
description: The date and time (UTC) at which the access key was last modified.
format: datetime
type: string
State:
description: The state of the access key (`ACTIVE` if the key is valid for
API calls, or `INACTIVE` if not).
type: string
type: object
AccessKeySecretKey:
additionalProperties: false
description: Information about the access key.
properties:
AccessKeyId:
description: The ID of the access key.
type: string
CreationDate:
description: The date and time (UTC) at which the access key was created.
format: datetime
type: string
ExpirationDate:
description: The date and time (UTC) at which the access key expires.
format: datetime
type: string
LastModificationDate:
description: The date and time (UTC) at which the access key was last modified.
format: datetime
type: string
SecretKey:
description: The secret key that enables you to send requests.
type: string
State:
description: The state of the access key (`ACTIVE` if the key is valid for
API calls, or `INACTIVE` if not).
type: string
type: object
AccessLog:
additionalProperties: false
description: Information about access logs.
properties:
IsEnabled:
description: If true, access logs are enabled for your load balancer. If
false, they are not. If you set this to true in your request, the `OsuBucketName`
parameter is required.
type: boolean
OsuBucketName:
description: The name of the OOS bucket for the access logs.
type: string
OsuBucketPrefix:
description: The path to the folder of the access logs in your OOS bucket
(by default, the `root` level of your bucket).
type: string
PublicationInterval:
description: The time interval for the publication of access logs in the
OOS bucket, in minutes. This value can be either `5` or `60` (by default,
`60`).
type: integer
type: object
Account:
additionalProperties: false
description: Information about the account.
properties:
AccountId:
description: The ID of the account.
type: string
AdditionalEmails:
description: One or more additional email addresses for the account. These
addresses are used for notifications only.
items:
pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$"
type: string
type: array
City:
description: The city of the account owner.
type: string
CompanyName:
description: The name of the company for the account.
type: string
Country:
description: The country of the account owner.
type: string
CustomerId:
description: The ID of the customer.
type: string
Email:
description: The main email address for the account. This address is used
for your credentials and for notifications.
type: string
FirstName:
description: The first name of the account owner.
type: string
JobTitle:
description: The job title of the account owner.
type: string
LastName:
description: The last name of the account owner.
type: string
MobileNumber:
description: The mobile phone number of the account owner.
type: string
PhoneNumber:
description: The landline phone number of the account owner.
type: string
StateProvince:
description: The state/province of the account.
type: string
VatNumber:
description: The value added tax (VAT) number for the account.
type: string
ZipCode:
description: The ZIP code of the city.
type: string
type: object
AddUserToUserGroupRequest:
additionalProperties: false
properties:
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
UserGroupName:
description: The name of the group you want to add a user to.
type: string
UserGroupPath:
description: The path to the group. If not specified, it is set to a slash
(`/`).
type: string
UserName:
description: The name of the user you want to add to the group.
type: string
UserPath:
description: The path to the user. If not specified, it is set to a slash
(`/`).
type: string
required:
- UserGroupName
- UserName
type: object
AddUserToUserGroupResponse:
additionalProperties: false
properties:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
ApiAccessPolicy:
additionalProperties: false
description: Information about the API access policy.
properties:
MaxAccessKeyExpirationSeconds:
description: The maximum possible lifetime for your access keys, in seconds.
If `0`, your access keys can have unlimited lifetimes.
format: int64
type: integer
RequireTrustedEnv:
description: |-
If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).<br />
If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication > Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication).
type: boolean
type: object
ApiAccessRule:
additionalProperties: false
description: Information about the API access rule.
properties:
ApiAccessRuleId:
description: The ID of the API access rule.
type: string
CaIds:
description: One or more IDs of Client Certificate Authorities (CAs) used
for the API access rule.
items:
type: string
type: array
Cns:
description: One or more Client Certificate Common Names (CNs).
items:
type: string
type: array
Description:
description: The description of the API access rule.
type: string
IpRanges:
description: One or more IP ranges used for the API access rule, in CIDR
notation (for example, `192.0.2.0/16`).
items:
type: string
type: array
type: object
ApplicationStickyCookiePolicy:
additionalProperties: false
description: Information about the stickiness policy.
properties:
CookieName:
description: The name of the application cookie used for stickiness.
type: string
PolicyName:
description: The mnemonic name for the policy being created. The name must
be unique within a set of policies for this load balancer.
type: string
type: object
BackendVmHealth:
additionalProperties: false
description: Information about the health of a backend VM.
properties:
Description:
description: The description of the state of the backend VM.
type: string
State:
description: The state of the backend VM (`InService` \| `OutOfService`
\| `Unknown`).
type: string
StateReason:
description: |-
Information about the cause of `OutOfService` VMs.<br />
Specifically, whether the cause is Elastic Load Balancing or the VM (`ELB` \| `Instance` \| `N/A`).
type: string
VmId:
description: The ID of the backend VM.
type: string
type: object
BlockDeviceMappingCreated:
additionalProperties: false
description: Information about the created block device mapping.
properties:
Bsu:
"$ref": "#/components/schemas/BsuCreated"
DeviceName:
description: The name of the device.
type: string
type: object
BlockDeviceMappingImage:
additionalProperties: false
description: One or more parameters used to automatically set up volumes when
the VM is created.
properties:
Bsu:
"$ref": "#/components/schemas/BsuToCreate"
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
`/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
`b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
type: string
type: object
BlockDeviceMappingVmCreation:
additionalProperties: false
description: Information about the block device mapping.
properties:
Bsu:
"$ref": "#/components/schemas/BsuToCreate"
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
`/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
`b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
NoDevice:
description: Removes the device which is included in the block device mapping
of the OMI.
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
type: string
type: object
BlockDeviceMappingVmUpdate:
additionalProperties: false
description: Information about the block device mapping.
properties:
Bsu:
"$ref": "#/components/schemas/BsuToUpdateVm"
DeviceName:
description: The device name for the volume. For a root device, you must
use `/dev/sda1`. For other volumes, you must use `/dev/sdX`, `/dev/sdXX`,
`/dev/xvdX`, or `/dev/xvdXX` (where the first `X` is a letter between
`b` and `z`, and the second `X` is a letter between `a` and `z`).
type: string
NoDevice:
description: Removes the device which is included in the block device mapping
of the OMI.
type: string
VirtualDeviceName:
description: The name of the virtual device (`ephemeralN`).
type: string
type: object
BsuCreated:
additionalProperties: false
description: Information about the created BSU volume.
properties:
DeleteOnVmDeletion:
description: If true, the volume is deleted when terminating the VM. If
false, the volume is not deleted when terminating the VM.
type: boolean
LinkDate:
description: The date and time (UTC) at which the volume was attached to
the VM, in ISO 8601 date-time format.
format: date
type: string
State:
description: The state of the volume.
type: string
VolumeId:
description: The ID of the volume.
type: string
type: object
BsuToCreate:
additionalProperties: false
description: Information about the BSU volume to create.
properties:
DeleteOnVmDeletion:
default: true
description: By default or if set to true, the volume is deleted when terminating
the VM. If false, the volume is not deleted when terminating the VM.
type: boolean
Iops:
description: The number of I/O operations per second (IOPS). This parameter
must be specified only if you create an `io1` volume. The maximum number
of IOPS allowed for `io1` volumes is `13000` with a maximum performance
ratio of 300 IOPS per gibibyte.
type: integer
SnapshotId:
description: The ID of the snapshot used to create the volume.
type: string
VolumeSize:
description: |-
The size of the volume, in gibibytes (GiB).<br />
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.<br />
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
type: integer
VolumeType:
description: |-
The type of the volume (`standard` \| `io1` \| `gp2`). If not specified in the request, a `standard` volume is created.<br />
For more information about volume types, see [About Volumes > Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops).
type: string
type: object
BsuToUpdateVm:
additionalProperties: false
description: Information about the BSU volume.
properties:
DeleteOnVmDeletion:
description: If set to true, the volume is deleted when terminating the
VM. If set to false, the volume is not deleted when terminating the VM.
type: boolean
VolumeId:
description: The ID of the volume.
type: string
type: object
Ca:
additionalProperties: false
description: Information about the Client Certificate Authority (CA).
properties:
CaFingerprint:
description: The fingerprint of the CA.
type: string
CaId:
description: The ID of the CA.
type: string
Description:
description: The description of the CA.
type: string
type: object
Catalog:
additionalProperties: false
description: Information about our catalog of prices.
properties:
Entries:
description: One or more catalog entries.
items:
"$ref": "#/components/schemas/CatalogEntry"
type: array
type: object
CatalogEntry:
additionalProperties: false
description: Information about the catalog entry.
properties:
Category:
description: The category of the catalog entry (for example, `network`).
type: string
Flags:
description: When returned and equal to `PER_MONTH`, the price of the catalog
entry is calculated on a monthly basis.
type: string
Operation:
description: The API call associated with the catalog entry (for example,
`CreateVms` or `RunInstances`).
type: string
Service:
description: The service associated with the catalog entry (`TinaOS-FCU`,
`TinaOS-LBU`, `TinaOS-DirectLink`, or `TinaOS-OOS`).
type: string
SubregionName:
description: The Subregion associated with the catalog entry.
type: string
Title:
description: The description of the catalog entry.
type: string
Type:
description: The type of resource associated with the catalog entry.
type: string
UnitPrice:
description: The unit price of the catalog entry in the currency of your
account, in the ISO-4217 format (for example, `EUR`).
format: float
type: number
type: object
Catalogs:
additionalProperties: false
description: Information about the catalogs.
properties:
Entries:
description: One or more catalog entries.
items:
"$ref": "#/components/schemas/CatalogEntry"
type: array
FromDate:
description: The beginning of the time period (UTC).
format: date-time
type: string
State:
description: The state of the catalog (`CURRENT` \| `OBSOLETE`).
enum:
- CURRENT
- OBSOLETE
type: string
ToDate:
description: The end of the time period (UTC).
format: date-time
type: string
type: object
CheckAuthenticationRequest:
additionalProperties: false
properties:
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
Login:
description: The email address of the account.
type: string
Password:
description: The password of the account.
type: string
required:
- Login
- Password
type: object
CheckAuthenticationResponse:
additionalProperties: false
properties:
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
ClientGateway:
additionalProperties: false
description: Information about the client gateway.
properties:
BgpAsn:
description: The Autonomous System Number (ASN) used by the Border Gateway
Protocol (BGP) to find the path to your client gateway through the Internet.
type: integer
ClientGatewayId:
description: The ID of the client gateway.
type: string
ConnectionType:
description: The type of communication tunnel used by the client gateway
(always `ipsec.1`).
type: string
PublicIp:
description: The public IPv4 address of the client gateway (must be a fixed
address into a NATed network).
type: string
State:
description: The state of the client gateway (`pending` \| `available` \|
`deleting` \| `deleted`).
type: string
Tags:
description: One or more tags associated with the client gateway.
items:
"$ref": "#/components/schemas/ResourceTag"
type: array
type: object
ConsumptionEntry:
additionalProperties: false
description: Information about the resources consumed during the specified time
period.
properties:
AccountId:
description: The ID of your TINA account.
type: string
Category:
description: The category of the resource (for example, `network`).
type: string
FromDate:
description: The beginning of the time period (UTC).
format: datetime
type: string
Operation:
description: The API call that triggered the resource consumption (for example,
`RunInstances` or `CreateVolume`).
type: string
PayingAccountId:
description: The ID of the TINA account which is billed for your consumption.
It can be different from your account in the `AccountId` parameter.
type: string
Price:
description: The total price of the consumed resource during the specified
time period, in the currency of the Region's catalog.
format: double
type: number
Service:
description: The service of the API call (`TinaOS-FCU`, `TinaOS-LBU`, `TinaOS-DirectLink`,
`TinaOS-OOS`, or `TinaOS-OSU`).
type: string
SubregionName:
description: The name of the Subregion.
type: string
Title:
description: A description of the consumed resource.
type: string
ToDate:
description: The end of the time period (UTC).
format: datetime
type: string
Type:
description: The type of resource, depending on the API call.
type: string
UnitPrice:
description: The unit price of the consumed resource in the currency of
your account, in the ISO-4217 format (for example, `EUR`).
format: double
type: number
Value:
description: The consumed amount for the resource. The unit depends on the
resource type. For more information, see the `Title` element.
format: double
type: number
type: object
CreateAccessKeyRequest:
additionalProperties: false
properties:
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
ExpirationDate:
description: The date and time, or the date, at which you want the access
key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`,
or `2020-06-14`). To remove an existing expiration date, use the method
without specifying this parameter.
format: datetime
type: string
UserName:
description: The name of the EIM user that owns the key to be created. If
you do not specify a user name, this action creates an access key for
the user who sends the request (which can be the root account).
type: string
type: object
CreateAccessKeyResponse:
additionalProperties: false
properties:
AccessKey:
"$ref": "#/components/schemas/AccessKeySecretKey"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateAccountRequest:
additionalProperties: false
properties:
AdditionalEmails:
description: One or more additional email addresses for the account. These
addresses are used for notifications only. If you already have a list
of additional emails registered, you cannot add to it, only replace it.
To remove all registered additional emails, specify an empty list.
items:
pattern: "^.+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)+$"
type: string
type: array
City:
description: The city of the account owner.
type: string
CompanyName:
description: The name of the company for the account.
type: string
Country:
description: The country of the account owner.
type: string
CustomerId:
description: The ID of the customer. It must be 8 digits.
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
Email:
description: The main email address for the account. This address is used
for your credentials and notifications.
type: string
FirstName:
description: The first name of the account owner.
type: string
JobTitle:
description: The job title of the account owner.
type: string
LastName:
description: The last name of the account owner.
type: string
MobileNumber:
description: The mobile phone number of the account owner.
type: string
PhoneNumber:
description: The landline phone number of the account owner.
type: string
StateProvince:
description: The state/province of the account.
type: string
VatNumber:
description: The value added tax (VAT) number for the account.
type: string
ZipCode:
description: The ZIP code of the city.
type: string
required:
- City
- CompanyName
- Country
- CustomerId
- Email
- FirstName
- LastName
- ZipCode
type: object
CreateAccountResponse:
additionalProperties: false
properties:
Account:
"$ref": "#/components/schemas/Account"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateApiAccessRuleRequest:
additionalProperties: false
properties:
CaIds:
description: One or more IDs of Client Certificate Authorities (CAs).
items:
type: string
type: array
Cns:
description: One or more Client Certificate Common Names (CNs). If this
parameter is specified, you must also specify the `CaIds` parameter.
items:
type: string
type: array
Description:
description: A description for the API access rule.
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
IpRanges:
description: One or more IPs or CIDR blocks (for example, `192.0.2.0/16`).
items:
type: string
type: array
type: object
CreateApiAccessRuleResponse:
additionalProperties: false
properties:
ApiAccessRule:
"$ref": "#/components/schemas/ApiAccessRule"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateCaRequest:
additionalProperties: false
properties:
CaPem:
description: 'The CA in PEM format.<br />With OSC CLI, use the following
syntax to make sure your CA file is correctly parsed: `--CaPem="$(cat
FILENAME)"`.'
type: string
Description:
description: The description of the CA.
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
required:
- CaPem
type: object
CreateCaResponse:
additionalProperties: false
properties:
Ca:
"$ref": "#/components/schemas/Ca"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateClientGatewayRequest:
additionalProperties: false
properties:
BgpAsn:
description: |-
The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. <br/>
This number must be between `1` and `4294967295`. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
type: integer
ConnectionType:
description: The communication protocol used to establish tunnel with your
client gateway (always `ipsec.1`).
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
PublicIp:
description: The public fixed IPv4 address of your client gateway.
type: string
required:
- BgpAsn
- PublicIp
- ConnectionType
type: object
CreateClientGatewayResponse:
additionalProperties: false
properties:
ClientGateway:
"$ref": "#/components/schemas/ClientGateway"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateDedicatedGroupRequest:
additionalProperties: false
properties:
CpuGeneration:
description: The processor generation for the VMs in the dedicated group
(for example, `4`).
type: integer
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
Name:
description: A name for the dedicated group.
type: string
SubregionName:
description: The Subregion in which you want to create the dedicated group.
type: string
required:
- CpuGeneration
- Name
- SubregionName
type: object
CreateDedicatedGroupResponse:
additionalProperties: false
properties:
DedicatedGroup:
"$ref": "#/components/schemas/DedicatedGroup"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateDhcpOptionsRequest:
additionalProperties: false
properties:
DomainName:
description: 'Specify a domain name (for example, `MyCompany.com`). You
can specify only one domain name. You must specify at least one of the
following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
or `NtpServers`.'
type: string
DomainNameServers:
description: 'The IPs of domain name servers. If no IPs are specified, the
`OutscaleProvidedDNS` value is set by default. You must specify at least
one of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
or `NtpServers`.'
items:
type: string
type: array
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
LogServers:
description: 'The IPs of the log servers. You must specify at least one
of the following parameters: `DomainName`, `DomainNameServers`, `LogServers`,
or `NtpServers`.'
items:
type: string
type: array
NtpServers:
description: 'The IPs of the Network Time Protocol (NTP) servers. You must
specify at least one of the following parameters: `DomainName`, `DomainNameServers`,
`LogServers`, or `NtpServers`.'
items:
type: string
type: array
type: object
CreateDhcpOptionsResponse:
additionalProperties: false
properties:
DhcpOptionsSet:
"$ref": "#/components/schemas/DhcpOptionsSet"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateDirectLinkInterfaceRequest:
additionalProperties: false
properties:
DirectLinkId:
description: The ID of the existing DirectLink for which you want to create
the DirectLink interface.
type: string
DirectLinkInterface:
"$ref": "#/components/schemas/DirectLinkInterface"
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
required:
- DirectLinkId
- DirectLinkInterface
type: object
CreateDirectLinkInterfaceResponse:
additionalProperties: false
properties:
DirectLinkInterface:
"$ref": "#/components/schemas/DirectLinkInterfaces"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateDirectLinkRequest:
additionalProperties: false
properties:
Bandwidth:
description: The bandwidth of the DirectLink (`1Gbps` \| `10Gbps`).
type: string
DirectLinkName:
description: The name of the DirectLink.
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
Location:
description: The code of the requested location for the DirectLink, returned
by the [ReadLocations](#readlocations) method.
type: string
required:
- Bandwidth
- DirectLinkName
- Location
type: object
CreateDirectLinkResponse:
additionalProperties: false
properties:
DirectLink:
"$ref": "#/components/schemas/DirectLink"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateFlexibleGpuRequest:
additionalProperties: false
properties:
DeleteOnVmDeletion:
default: false
description: If true, the fGPU is deleted when the VM is terminated.
type: boolean
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
Generation:
description: The processor generation that the fGPU must be compatible with.
If not specified, the oldest possible processor generation is selected
(as provided by [ReadFlexibleGpuCatalog](#readflexiblegpucatalog) for
the specified model of fGPU).
type: string
ModelName:
description: The model of fGPU you want to allocate. For more information,
see [About Flexible GPUs](https://docs.outscale.com/en/userguide/About-Flexible-GPUs.html).
type: string
SubregionName:
description: The Subregion in which you want to create the fGPU.
type: string
required:
- ModelName
- SubregionName
type: object
CreateFlexibleGpuResponse:
additionalProperties: false
properties:
FlexibleGpu:
"$ref": "#/components/schemas/FlexibleGpu"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateImageExportTaskRequest:
additionalProperties: false
properties:
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
ImageId:
description: The ID of the OMI to export.
type: string
OsuExport:
"$ref": "#/components/schemas/OsuExportToCreate"
required:
- OsuExport
- ImageId
type: object
CreateImageExportTaskResponse:
additionalProperties: false
properties:
ImageExportTask:
"$ref": "#/components/schemas/ImageExportTask"
ResponseContext:
"$ref": "#/components/schemas/ResponseContext"
type: object
CreateImageRequest:
additionalProperties: false
properties:
Architecture:
description: "**(when registering from a snapshot)** The architecture of
the OMI (`i386` or `x86_64`)."
type: string
BlockDeviceMappings:
description: "**(when registering from a snapshot)** One or more block device
mappings."
items:
"$ref": "#/components/schemas/BlockDeviceMappingImage"
type: array
Description:
description: A description for the new OMI.
type: string
DryRun:
description: If true, checks whether you have the required permissions to
perform the action.
type: boolean
FileLocation:
description: "**(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)."