@scaleway/sdk 2.72.0 → 2.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/account/v3/api.gen.cjs +13 -32
- package/dist/api/account/v3/api.gen.d.ts +17 -36
- package/dist/api/account/v3/api.gen.js +13 -32
- package/dist/api/account/v3/index.gen.d.ts +1 -1
- package/dist/api/account/v3/marshalling.gen.cjs +94 -65
- package/dist/api/account/v3/marshalling.gen.js +94 -65
- package/dist/api/account/v3/types.gen.d.ts +224 -104
- package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
- package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
- package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
- package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
- package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
- package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
- package/dist/api/baremetal/v1/api.gen.cjs +28 -61
- package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
- package/dist/api/baremetal/v1/api.gen.js +28 -61
- package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
- package/dist/api/baremetal/v3/api.gen.cjs +7 -14
- package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
- package/dist/api/baremetal/v3/api.gen.js +7 -14
- package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
- package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
- package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
- package/dist/api/billing/v2beta1/api.gen.js +11 -20
- package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
- package/dist/api/block/v1/api.gen.cjs +37 -55
- package/dist/api/block/v1/api.gen.d.ts +19 -37
- package/dist/api/block/v1/api.gen.js +37 -55
- package/dist/api/block/v1/types.gen.d.ts +306 -125
- package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
- package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
- package/dist/api/block/v1alpha1/api.gen.js +45 -64
- package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
- package/dist/api/cockpit/v1/api.gen.cjs +132 -156
- package/dist/api/cockpit/v1/api.gen.d.ts +66 -113
- package/dist/api/cockpit/v1/api.gen.js +133 -157
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +628 -246
- package/dist/api/container/v1beta1/api.gen.cjs +7 -14
- package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
- package/dist/api/container/v1beta1/api.gen.js +7 -14
- package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
- package/dist/api/dedibox/v1/api.gen.cjs +45 -69
- package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
- package/dist/api/dedibox/v1/api.gen.js +45 -69
- package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
- package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
- package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
- package/dist/api/domain/v2beta1/api.gen.js +119 -178
- package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
- package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
- package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
- package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
- package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
- package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
- package/dist/api/file/index.gen.cjs +4 -0
- package/dist/api/file/index.gen.d.ts +5 -0
- package/dist/api/file/index.gen.js +4 -0
- package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
- package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
- package/dist/api/file/v1alpha1/api.gen.js +142 -0
- package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
- package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
- package/dist/api/file/v1alpha1/content.gen.js +7 -0
- package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
- package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
- package/dist/api/file/v1alpha1/index.gen.js +8 -0
- package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
- package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
- package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
- package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
- package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
- package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
- package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
- package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
- package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
- package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
- package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
- package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
- package/dist/api/iam/v1alpha1/api.gen.js +4 -4
- package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/index.gen.d.ts +3 -1
- package/dist/api/inference/v1/api.gen.cjs +8 -11
- package/dist/api/inference/v1/api.gen.d.ts +6 -9
- package/dist/api/inference/v1/api.gen.js +8 -11
- package/dist/api/inference/v1/types.gen.d.ts +330 -150
- package/dist/api/inference/v1beta1/api.gen.cjs +9 -12
- package/dist/api/inference/v1beta1/api.gen.d.ts +7 -10
- package/dist/api/inference/v1beta1/api.gen.js +9 -12
- package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
- package/dist/api/instance/v1/api.gen.cjs +64 -113
- package/dist/api/instance/v1/api.gen.d.ts +54 -103
- package/dist/api/instance/v1/api.gen.js +64 -113
- package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
- package/dist/api/instance/v1/marshalling.gen.js +4 -1
- package/dist/api/instance/v1/types.gen.d.ts +1368 -600
- package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
- package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
- package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
- package/dist/api/interlink/v1beta1/api.gen.js +21 -67
- package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
- package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
- package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
- package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
- package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
- package/dist/api/iot/v1/api.gen.cjs +37 -70
- package/dist/api/iot/v1/api.gen.d.ts +34 -67
- package/dist/api/iot/v1/api.gen.js +37 -70
- package/dist/api/iot/v1/types.gen.d.ts +566 -321
- package/dist/api/ipam/v1/api.gen.cjs +6 -26
- package/dist/api/ipam/v1/api.gen.d.ts +8 -29
- package/dist/api/ipam/v1/api.gen.js +6 -26
- package/dist/api/ipam/v1/types.gen.d.ts +146 -105
- package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
- package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
- package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
- package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
- package/dist/api/k8s/v1/api.gen.cjs +33 -78
- package/dist/api/k8s/v1/api.gen.d.ts +27 -72
- package/dist/api/k8s/v1/api.gen.js +33 -78
- package/dist/api/k8s/v1/types.gen.d.ts +743 -506
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
- package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
- package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
- package/dist/api/lb/v1/marshalling.gen.js +4 -2
- package/dist/api/lb/v1/types.gen.d.ts +4 -0
- package/dist/api/marketplace/v2/api.gen.cjs +8 -21
- package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
- package/dist/api/marketplace/v2/api.gen.js +8 -21
- package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
- package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
- package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
- package/dist/api/mnq/v1beta1/api.gen.js +24 -76
- package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
- package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
- package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
- package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
- package/dist/api/product_catalog/index.gen.cjs +4 -0
- package/dist/api/product_catalog/index.gen.d.ts +5 -0
- package/dist/api/product_catalog/index.gen.js +4 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
- package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
- package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
- package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
- package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
- package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
- package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
- package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
- package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
- package/dist/api/rdb/v1/api.gen.cjs +62 -202
- package/dist/api/rdb/v1/api.gen.d.ts +60 -201
- package/dist/api/rdb/v1/api.gen.js +62 -202
- package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
- package/dist/api/redis/v1/api.gen.cjs +23 -83
- package/dist/api/redis/v1/api.gen.d.ts +25 -85
- package/dist/api/redis/v1/api.gen.js +23 -83
- package/dist/api/redis/v1/types.gen.d.ts +447 -170
- package/dist/api/registry/v1/api.gen.cjs +12 -40
- package/dist/api/registry/v1/api.gen.d.ts +14 -42
- package/dist/api/registry/v1/api.gen.js +12 -40
- package/dist/api/registry/v1/types.gen.d.ts +200 -116
- package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
- package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
- package/dist/api/secret/v1beta1/api.gen.js +19 -47
- package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
- package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
- package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
- package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
- package/dist/api/tem/v1alpha1/api.gen.js +22 -58
- package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
- package/dist/api/test/v1/api.gen.cjs +8 -11
- package/dist/api/test/v1/api.gen.d.ts +6 -9
- package/dist/api/test/v1/api.gen.js +8 -11
- package/dist/api/test/v1/types.gen.d.ts +21 -10
- package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
- package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
- package/dist/api/vpcgw/v1/api.gen.js +37 -0
- package/dist/client/dist/package.json.cjs +1 -1
- package/dist/client/dist/package.json.js +1 -1
- package/dist/index.cjs +36 -32
- package/dist/index.js +36 -32
- package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
- package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
- package/node_modules/@scaleway/sdk-client/package.json +1 -2
- package/package.json +2 -2
- package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
|
@@ -27,13 +27,21 @@ export interface EndpointDirectAccessDetails {
|
|
|
27
27
|
export interface EndpointLoadBalancerDetails {
|
|
28
28
|
}
|
|
29
29
|
export interface EndpointPrivateNetworkDetails {
|
|
30
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* UUID of the private network.
|
|
32
|
+
*/
|
|
31
33
|
privateNetworkId: string;
|
|
32
|
-
/**
|
|
34
|
+
/**
|
|
35
|
+
* CIDR notation of the endpoint IPv4 address.
|
|
36
|
+
*/
|
|
33
37
|
serviceIp: string;
|
|
34
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* Private network zone.
|
|
40
|
+
*/
|
|
35
41
|
zone: ScwZone;
|
|
36
|
-
/**
|
|
42
|
+
/**
|
|
43
|
+
* How endpoint ips are provisioned.
|
|
44
|
+
*/
|
|
37
45
|
provisioningMode: EndpointPrivateNetworkDetailsProvisioningMode;
|
|
38
46
|
}
|
|
39
47
|
export interface EndpointSpecPrivateNetworkIpamConfig {
|
|
@@ -41,31 +49,55 @@ export interface EndpointSpecPrivateNetworkIpamConfig {
|
|
|
41
49
|
export interface ReadReplicaEndpointSpecPrivateNetworkIpamConfig {
|
|
42
50
|
}
|
|
43
51
|
export interface EngineSetting {
|
|
44
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* Setting name from the database engine.
|
|
54
|
+
*/
|
|
45
55
|
name: string;
|
|
46
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Value set when not specified.
|
|
58
|
+
*/
|
|
47
59
|
defaultValue: string;
|
|
48
|
-
/**
|
|
60
|
+
/**
|
|
61
|
+
* Setting can be applied without restarting.
|
|
62
|
+
*/
|
|
49
63
|
hotConfigurable: boolean;
|
|
50
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* Setting description.
|
|
66
|
+
*/
|
|
51
67
|
description: string;
|
|
52
|
-
/**
|
|
68
|
+
/**
|
|
69
|
+
* Setting type.
|
|
70
|
+
*/
|
|
53
71
|
propertyType: EngineSettingPropertyType;
|
|
54
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* Setting base unit.
|
|
74
|
+
*/
|
|
55
75
|
unit?: string;
|
|
56
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Validation regex for string type settings.
|
|
78
|
+
*/
|
|
57
79
|
stringConstraint?: string;
|
|
58
|
-
/**
|
|
80
|
+
/**
|
|
81
|
+
* Minimum value for int types.
|
|
82
|
+
*/
|
|
59
83
|
intMin?: number;
|
|
60
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
* Maximum value for int types.
|
|
86
|
+
*/
|
|
61
87
|
intMax?: number;
|
|
62
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* Minimum value for float types.
|
|
90
|
+
*/
|
|
63
91
|
floatMin?: number;
|
|
64
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* Maximum value for float types.
|
|
94
|
+
*/
|
|
65
95
|
floatMax?: number;
|
|
66
96
|
}
|
|
67
97
|
export interface Endpoint {
|
|
68
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* UUID of the endpoint.
|
|
100
|
+
*/
|
|
69
101
|
id: string;
|
|
70
102
|
/**
|
|
71
103
|
* IPv4 address of the endpoint.
|
|
@@ -73,33 +105,30 @@ export interface Endpoint {
|
|
|
73
105
|
* One-of ('address'): at most one of 'ip', 'hostname' could be set.
|
|
74
106
|
*/
|
|
75
107
|
ip?: string;
|
|
76
|
-
/**
|
|
108
|
+
/**
|
|
109
|
+
* TCP port of the endpoint.
|
|
110
|
+
*/
|
|
77
111
|
port: number;
|
|
78
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* Name of the endpoint.
|
|
114
|
+
*/
|
|
79
115
|
name?: string;
|
|
80
116
|
/**
|
|
81
|
-
* Private Network details. One maximum per Database Instance or Read Replica
|
|
82
|
-
* (a Database Instance and its Read Replica can have different Private
|
|
83
|
-
* Networks). Cannot be updated (has to be deleted and recreated).
|
|
117
|
+
* Private Network details. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
|
|
84
118
|
*
|
|
85
|
-
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
|
|
86
|
-
* 'directAccess' could be set.
|
|
119
|
+
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.
|
|
87
120
|
*/
|
|
88
121
|
privateNetwork?: EndpointPrivateNetworkDetails;
|
|
89
122
|
/**
|
|
90
|
-
* Load balancer details. Public endpoint for Database Instance which is
|
|
91
|
-
* systematically present. One per Database Instance.
|
|
123
|
+
* Load balancer details. Public endpoint for Database Instance which is systematically present. One per Database Instance.
|
|
92
124
|
*
|
|
93
|
-
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
|
|
94
|
-
* 'directAccess' could be set.
|
|
125
|
+
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.
|
|
95
126
|
*/
|
|
96
127
|
loadBalancer?: EndpointLoadBalancerDetails;
|
|
97
128
|
/**
|
|
98
|
-
* Direct access details. Public endpoint reserved for Read Replicas. One per
|
|
99
|
-
* Read Replica.
|
|
129
|
+
* Direct access details. Public endpoint reserved for Read Replicas. One per Read Replica.
|
|
100
130
|
*
|
|
101
|
-
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
|
|
102
|
-
* 'directAccess' could be set.
|
|
131
|
+
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.
|
|
103
132
|
*/
|
|
104
133
|
directAccess?: EndpointDirectAccessDetails;
|
|
105
134
|
/**
|
|
@@ -112,20 +141,18 @@ export interface Endpoint {
|
|
|
112
141
|
export interface EndpointSpecLoadBalancer {
|
|
113
142
|
}
|
|
114
143
|
export interface EndpointSpecPrivateNetwork {
|
|
115
|
-
/**
|
|
144
|
+
/**
|
|
145
|
+
* UUID of the Private Network to be connected to the Database Instance.
|
|
146
|
+
*/
|
|
116
147
|
privateNetworkId: string;
|
|
117
148
|
/**
|
|
118
|
-
* Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway
|
|
119
|
-
* documentation to learn more about IP and subnet limitations.
|
|
149
|
+
* Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.
|
|
120
150
|
*
|
|
121
151
|
* One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set.
|
|
122
152
|
*/
|
|
123
153
|
serviceIp?: string;
|
|
124
154
|
/**
|
|
125
|
-
* Automated configuration of your Private Network endpoint with Scaleway IPAM
|
|
126
|
-
* service. One at the most per Database Instance or Read Replica (a Database
|
|
127
|
-
* Instance and its Read Replica can have different Private Networks). Cannot
|
|
128
|
-
* be updated (has to be deleted and recreated).
|
|
155
|
+
* Automated configuration of your Private Network endpoint with Scaleway IPAM service. One at the most per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
|
|
129
156
|
*
|
|
130
157
|
* One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set.
|
|
131
158
|
*/
|
|
@@ -134,49 +161,69 @@ export interface EndpointSpecPrivateNetwork {
|
|
|
134
161
|
export interface ReadReplicaEndpointSpecDirectAccess {
|
|
135
162
|
}
|
|
136
163
|
export interface ReadReplicaEndpointSpecPrivateNetwork {
|
|
137
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* UUID of the Private Network to be connected to the Read Replica.
|
|
166
|
+
*/
|
|
138
167
|
privateNetworkId: string;
|
|
139
168
|
/**
|
|
140
|
-
* Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway
|
|
141
|
-
* documentation to learn more about IP and subnet limitations.
|
|
169
|
+
* Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.
|
|
142
170
|
*
|
|
143
171
|
* One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set.
|
|
144
172
|
*/
|
|
145
173
|
serviceIp?: string;
|
|
146
174
|
/**
|
|
147
|
-
* Automated configuration of your Private Network endpoint with Scaleway IPAM
|
|
148
|
-
* service. One at the most per Database Instance or Read Replica (a Database
|
|
149
|
-
* Instance and its Read Replica can have different private networks). Cannot
|
|
150
|
-
* be updated (has to be deleted and recreated).
|
|
175
|
+
* Automated configuration of your Private Network endpoint with Scaleway IPAM service. One at the most per Database Instance or Read Replica (a Database Instance and its Read Replica can have different private networks). Cannot be updated (has to be deleted and recreated).
|
|
151
176
|
*
|
|
152
177
|
* One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set.
|
|
153
178
|
*/
|
|
154
179
|
ipamConfig?: ReadReplicaEndpointSpecPrivateNetworkIpamConfig;
|
|
155
180
|
}
|
|
156
181
|
export interface EngineVersion {
|
|
157
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* Database engine version.
|
|
184
|
+
*/
|
|
158
185
|
version: string;
|
|
159
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* Database engine name.
|
|
188
|
+
*/
|
|
160
189
|
name: string;
|
|
161
|
-
/**
|
|
190
|
+
/**
|
|
191
|
+
* End of life date.
|
|
192
|
+
*/
|
|
162
193
|
endOfLife?: Date;
|
|
163
|
-
/**
|
|
194
|
+
/**
|
|
195
|
+
* Engine settings available to be set.
|
|
196
|
+
*/
|
|
164
197
|
availableSettings: EngineSetting[];
|
|
165
|
-
/**
|
|
198
|
+
/**
|
|
199
|
+
* Disabled versions cannot be created.
|
|
200
|
+
*/
|
|
166
201
|
disabled: boolean;
|
|
167
|
-
/**
|
|
202
|
+
/**
|
|
203
|
+
* Beta status of engine version.
|
|
204
|
+
*/
|
|
168
205
|
beta: boolean;
|
|
169
|
-
/**
|
|
206
|
+
/**
|
|
207
|
+
* Engine settings available to be set at database initialization.
|
|
208
|
+
*/
|
|
170
209
|
availableInitSettings: EngineSetting[];
|
|
171
210
|
}
|
|
172
211
|
export interface BackupSchedule {
|
|
173
|
-
/**
|
|
212
|
+
/**
|
|
213
|
+
* Frequency of the backup schedule (in hours).
|
|
214
|
+
*/
|
|
174
215
|
frequency: number;
|
|
175
|
-
/**
|
|
216
|
+
/**
|
|
217
|
+
* Default retention period of backups (in days).
|
|
218
|
+
*/
|
|
176
219
|
retention: number;
|
|
177
|
-
/**
|
|
220
|
+
/**
|
|
221
|
+
* Defines whether the backup schedule feature is disabled.
|
|
222
|
+
*/
|
|
178
223
|
disabled: boolean;
|
|
179
|
-
/**
|
|
224
|
+
/**
|
|
225
|
+
* Next run of the backup schedule (accurate to 10 minutes).
|
|
226
|
+
*/
|
|
180
227
|
nextRunAt?: Date;
|
|
181
228
|
}
|
|
182
229
|
export interface EncryptionAtRest {
|
|
@@ -187,40 +234,65 @@ export interface InstanceSetting {
|
|
|
187
234
|
value: string;
|
|
188
235
|
}
|
|
189
236
|
export interface LogsPolicy {
|
|
190
|
-
/**
|
|
237
|
+
/**
|
|
238
|
+
* Max age (in days) of remote logs to keep on the Database Instance.
|
|
239
|
+
*/
|
|
191
240
|
maxAgeRetention?: number;
|
|
192
|
-
/**
|
|
241
|
+
/**
|
|
242
|
+
* Max disk size of remote logs to keep on the Database Instance.
|
|
243
|
+
*/
|
|
193
244
|
totalDiskRetention?: number;
|
|
194
245
|
}
|
|
195
246
|
export interface Maintenance {
|
|
196
|
-
/**
|
|
247
|
+
/**
|
|
248
|
+
* Start date of the maintenance window.
|
|
249
|
+
*/
|
|
197
250
|
startsAt?: Date;
|
|
198
|
-
/**
|
|
251
|
+
/**
|
|
252
|
+
* End date of the maintenance window.
|
|
253
|
+
*/
|
|
199
254
|
stopsAt?: Date;
|
|
200
|
-
/**
|
|
255
|
+
/**
|
|
256
|
+
* Closed maintenance date.
|
|
257
|
+
*/
|
|
201
258
|
closedAt?: Date;
|
|
202
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* Maintenance information message.
|
|
261
|
+
*/
|
|
203
262
|
reason: string;
|
|
204
|
-
/**
|
|
263
|
+
/**
|
|
264
|
+
* Status of the maintenance.
|
|
265
|
+
*/
|
|
205
266
|
status: MaintenanceStatus;
|
|
206
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* Time when Scaleway-side maintenance will be applied.
|
|
269
|
+
*/
|
|
207
270
|
forcedAt?: Date;
|
|
208
271
|
}
|
|
209
272
|
export interface ReadReplica {
|
|
210
|
-
/**
|
|
273
|
+
/**
|
|
274
|
+
* UUID of the Read Replica.
|
|
275
|
+
*/
|
|
211
276
|
id: string;
|
|
212
|
-
/**
|
|
277
|
+
/**
|
|
278
|
+
* Display Read Replica connection information.
|
|
279
|
+
*/
|
|
213
280
|
endpoints: Endpoint[];
|
|
214
|
-
/**
|
|
281
|
+
/**
|
|
282
|
+
* Read replica status.
|
|
283
|
+
*/
|
|
215
284
|
status: ReadReplicaStatus;
|
|
216
|
-
/**
|
|
285
|
+
/**
|
|
286
|
+
* Region the Read Replica is in.
|
|
287
|
+
*/
|
|
217
288
|
region: ScwRegion;
|
|
218
289
|
/**
|
|
219
|
-
* Whether the replica is in the same availability zone as the main instance
|
|
220
|
-
* nodes or not.
|
|
290
|
+
* Whether the replica is in the same availability zone as the main instance nodes or not.
|
|
221
291
|
*/
|
|
222
292
|
sameZone: boolean;
|
|
223
|
-
/**
|
|
293
|
+
/**
|
|
294
|
+
* UUID of the Database Instance.
|
|
295
|
+
*/
|
|
224
296
|
instanceId: string;
|
|
225
297
|
}
|
|
226
298
|
export interface UpgradableVersion {
|
|
@@ -235,23 +307,39 @@ export interface Volume {
|
|
|
235
307
|
class: StorageClass;
|
|
236
308
|
}
|
|
237
309
|
export interface NodeTypeVolumeConstraintSizes {
|
|
238
|
-
/**
|
|
310
|
+
/**
|
|
311
|
+
* [deprecated] Minimum size required for the Volume.
|
|
312
|
+
*/
|
|
239
313
|
minSize: number;
|
|
240
|
-
/**
|
|
314
|
+
/**
|
|
315
|
+
* [deprecated] Maximum size required for the Volume.
|
|
316
|
+
*/
|
|
241
317
|
maxSize: number;
|
|
242
318
|
}
|
|
243
319
|
export interface NodeTypeVolumeType {
|
|
244
|
-
/**
|
|
320
|
+
/**
|
|
321
|
+
* Volume Type.
|
|
322
|
+
*/
|
|
245
323
|
type: VolumeType;
|
|
246
|
-
/**
|
|
324
|
+
/**
|
|
325
|
+
* The description of the Volume.
|
|
326
|
+
*/
|
|
247
327
|
description: string;
|
|
248
|
-
/**
|
|
328
|
+
/**
|
|
329
|
+
* Minimum size required for the Volume.
|
|
330
|
+
*/
|
|
249
331
|
minSize: number;
|
|
250
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Maximum size required for the Volume.
|
|
334
|
+
*/
|
|
251
335
|
maxSize: number;
|
|
252
|
-
/**
|
|
336
|
+
/**
|
|
337
|
+
* Minimum increment level for a Block Storage volume size.
|
|
338
|
+
*/
|
|
253
339
|
chunkSize: number;
|
|
254
|
-
/**
|
|
340
|
+
/**
|
|
341
|
+
* The storage class of the volume.
|
|
342
|
+
*/
|
|
255
343
|
class: StorageClass;
|
|
256
344
|
}
|
|
257
345
|
export interface SnapshotVolumeType {
|
|
@@ -264,7 +352,9 @@ export interface ACLRuleRequest {
|
|
|
264
352
|
}
|
|
265
353
|
export interface ACLRule {
|
|
266
354
|
ip: string;
|
|
267
|
-
/**
|
|
355
|
+
/**
|
|
356
|
+
* @deprecated
|
|
357
|
+
*/
|
|
268
358
|
port?: number;
|
|
269
359
|
protocol: ACLRuleProtocol;
|
|
270
360
|
direction: ACLRuleDirection;
|
|
@@ -273,90 +363,124 @@ export interface ACLRule {
|
|
|
273
363
|
}
|
|
274
364
|
export interface EndpointSpec {
|
|
275
365
|
/**
|
|
276
|
-
* Load balancer endpoint specifications. Public endpoint for Database
|
|
277
|
-
* Instance which is systematically present. One per RDB instance.
|
|
366
|
+
* Load balancer endpoint specifications. Public endpoint for Database Instance which is systematically present. One per RDB instance.
|
|
278
367
|
*
|
|
279
|
-
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be
|
|
280
|
-
* set.
|
|
368
|
+
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be set.
|
|
281
369
|
*/
|
|
282
370
|
loadBalancer?: EndpointSpecLoadBalancer;
|
|
283
371
|
/**
|
|
284
|
-
* Private Network endpoint specifications. One maximum per Database Instance
|
|
285
|
-
* or Read Replica (a Database Instance and its Read Replica can have
|
|
286
|
-
* different Private Networks). Cannot be updated (has to be deleted and
|
|
287
|
-
* recreated).
|
|
372
|
+
* Private Network endpoint specifications. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).
|
|
288
373
|
*
|
|
289
|
-
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be
|
|
290
|
-
* set.
|
|
374
|
+
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be set.
|
|
291
375
|
*/
|
|
292
376
|
privateNetwork?: EndpointSpecPrivateNetwork;
|
|
293
377
|
}
|
|
294
378
|
export interface ReadReplicaEndpointSpec {
|
|
295
379
|
/**
|
|
296
|
-
* Direct access endpoint specifications. Public endpoint reserved for Read
|
|
297
|
-
* Replicas. One per Read Replica.
|
|
380
|
+
* Direct access endpoint specifications. Public endpoint reserved for Read Replicas. One per Read Replica.
|
|
298
381
|
*
|
|
299
|
-
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be
|
|
300
|
-
* set.
|
|
382
|
+
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be set.
|
|
301
383
|
*/
|
|
302
384
|
directAccess?: ReadReplicaEndpointSpecDirectAccess;
|
|
303
385
|
/**
|
|
304
|
-
* Private Network endpoint specifications. One at the most per Read Replica.
|
|
305
|
-
* Cannot be updated (has to be deleted and recreated).
|
|
386
|
+
* Private Network endpoint specifications. One at the most per Read Replica. Cannot be updated (has to be deleted and recreated).
|
|
306
387
|
*
|
|
307
|
-
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be
|
|
308
|
-
* set.
|
|
388
|
+
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be set.
|
|
309
389
|
*/
|
|
310
390
|
privateNetwork?: ReadReplicaEndpointSpecPrivateNetwork;
|
|
311
391
|
}
|
|
312
392
|
export interface DatabaseBackup {
|
|
313
|
-
/**
|
|
393
|
+
/**
|
|
394
|
+
* UUID of the database backup.
|
|
395
|
+
*/
|
|
314
396
|
id: string;
|
|
315
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* UUID of the Database Instance.
|
|
399
|
+
*/
|
|
316
400
|
instanceId: string;
|
|
317
|
-
/**
|
|
401
|
+
/**
|
|
402
|
+
* Name of backed up database.
|
|
403
|
+
*/
|
|
318
404
|
databaseName: string;
|
|
319
|
-
/**
|
|
405
|
+
/**
|
|
406
|
+
* Name of the backup.
|
|
407
|
+
*/
|
|
320
408
|
name: string;
|
|
321
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Status of the backup.
|
|
411
|
+
*/
|
|
322
412
|
status: DatabaseBackupStatus;
|
|
323
|
-
/**
|
|
413
|
+
/**
|
|
414
|
+
* Size of the database backup.
|
|
415
|
+
*/
|
|
324
416
|
size?: number;
|
|
325
|
-
/**
|
|
417
|
+
/**
|
|
418
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
419
|
+
*/
|
|
326
420
|
expiresAt?: Date;
|
|
327
|
-
/**
|
|
421
|
+
/**
|
|
422
|
+
* Creation date (must follow the ISO 8601 format).
|
|
423
|
+
*/
|
|
328
424
|
createdAt?: Date;
|
|
329
|
-
/**
|
|
425
|
+
/**
|
|
426
|
+
* Updated date (must follow the ISO 8601 format).
|
|
427
|
+
*/
|
|
330
428
|
updatedAt?: Date;
|
|
331
|
-
/**
|
|
429
|
+
/**
|
|
430
|
+
* Name of the Database Instance of the backup.
|
|
431
|
+
*/
|
|
332
432
|
instanceName: string;
|
|
333
|
-
/**
|
|
433
|
+
/**
|
|
434
|
+
* URL you can download the backup from.
|
|
435
|
+
*/
|
|
334
436
|
downloadUrl?: string;
|
|
335
|
-
/**
|
|
437
|
+
/**
|
|
438
|
+
* Expiration date of the download link.
|
|
439
|
+
*/
|
|
336
440
|
downloadUrlExpiresAt?: Date;
|
|
337
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
* Region of the database backup.
|
|
443
|
+
*/
|
|
338
444
|
region: ScwRegion;
|
|
339
|
-
/**
|
|
445
|
+
/**
|
|
446
|
+
* Store logical backups in the same region as the source Database Instance.
|
|
447
|
+
*/
|
|
340
448
|
sameRegion: boolean;
|
|
341
449
|
}
|
|
342
450
|
export interface DatabaseEngine {
|
|
343
|
-
/**
|
|
451
|
+
/**
|
|
452
|
+
* Engine name.
|
|
453
|
+
*/
|
|
344
454
|
name: string;
|
|
345
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* Engine logo URL.
|
|
457
|
+
*/
|
|
346
458
|
logoUrl: string;
|
|
347
|
-
/**
|
|
459
|
+
/**
|
|
460
|
+
* Available versions.
|
|
461
|
+
*/
|
|
348
462
|
versions: EngineVersion[];
|
|
349
|
-
/**
|
|
463
|
+
/**
|
|
464
|
+
* Region of this Database Instance.
|
|
465
|
+
*/
|
|
350
466
|
region: ScwRegion;
|
|
351
467
|
}
|
|
352
468
|
export interface Database {
|
|
353
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* Name of the database.
|
|
471
|
+
*/
|
|
354
472
|
name: string;
|
|
355
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* Name of the database owner.
|
|
475
|
+
*/
|
|
356
476
|
owner: string;
|
|
357
|
-
/**
|
|
477
|
+
/**
|
|
478
|
+
* Defines whether the database is managed or not.
|
|
479
|
+
*/
|
|
358
480
|
managed: boolean;
|
|
359
|
-
/**
|
|
481
|
+
/**
|
|
482
|
+
* Size of the database.
|
|
483
|
+
*/
|
|
360
484
|
size: number;
|
|
361
485
|
}
|
|
362
486
|
export interface ListInstanceLogsDetailsResponseInstanceLogDetail {
|
|
@@ -364,1069 +488,1426 @@ export interface ListInstanceLogsDetailsResponseInstanceLogDetail {
|
|
|
364
488
|
size: number;
|
|
365
489
|
}
|
|
366
490
|
export interface InstanceLog {
|
|
367
|
-
/**
|
|
491
|
+
/**
|
|
492
|
+
* Presigned Object Storage URL to download your log file.
|
|
493
|
+
*/
|
|
368
494
|
downloadUrl?: string;
|
|
369
|
-
/**
|
|
495
|
+
/**
|
|
496
|
+
* UUID of the Database Instance log.
|
|
497
|
+
*/
|
|
370
498
|
id: string;
|
|
371
|
-
/**
|
|
499
|
+
/**
|
|
500
|
+
* Status of the logs in a Database Instance.
|
|
501
|
+
*/
|
|
372
502
|
status: InstanceLogStatus;
|
|
373
|
-
/**
|
|
503
|
+
/**
|
|
504
|
+
* Name of the underlying node.
|
|
505
|
+
*/
|
|
374
506
|
nodeName: string;
|
|
375
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
509
|
+
*/
|
|
376
510
|
expiresAt?: Date;
|
|
377
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* Creation date (must follow the ISO 8601 format).
|
|
513
|
+
*/
|
|
378
514
|
createdAt?: Date;
|
|
379
|
-
/**
|
|
515
|
+
/**
|
|
516
|
+
* Region the Database Instance is in.
|
|
517
|
+
*/
|
|
380
518
|
region: ScwRegion;
|
|
381
519
|
}
|
|
382
520
|
export interface Instance {
|
|
383
|
-
/**
|
|
521
|
+
/**
|
|
522
|
+
* Creation date (must follow the ISO 8601 format).
|
|
523
|
+
*/
|
|
384
524
|
createdAt?: Date;
|
|
385
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* Volumes of the Database Instance.
|
|
527
|
+
*/
|
|
386
528
|
volume?: Volume;
|
|
387
|
-
/**
|
|
529
|
+
/**
|
|
530
|
+
* Region the Database Instance is in.
|
|
531
|
+
*/
|
|
388
532
|
region: ScwRegion;
|
|
389
|
-
/**
|
|
533
|
+
/**
|
|
534
|
+
* UUID of the Database Instance.
|
|
535
|
+
*/
|
|
390
536
|
id: string;
|
|
391
|
-
/**
|
|
537
|
+
/**
|
|
538
|
+
* Name of the Database Instance.
|
|
539
|
+
*/
|
|
392
540
|
name: string;
|
|
393
|
-
/**
|
|
541
|
+
/**
|
|
542
|
+
* Organization ID the Database Instance belongs to.
|
|
543
|
+
*/
|
|
394
544
|
organizationId: string;
|
|
395
|
-
/**
|
|
545
|
+
/**
|
|
546
|
+
* Project ID the Database Instance belongs to.
|
|
547
|
+
*/
|
|
396
548
|
projectId: string;
|
|
397
|
-
/**
|
|
549
|
+
/**
|
|
550
|
+
* Status of the Database Instance.
|
|
551
|
+
*/
|
|
398
552
|
status: InstanceStatus;
|
|
399
|
-
/**
|
|
553
|
+
/**
|
|
554
|
+
* Database engine of the database (PostgreSQL, MySQL, ...).
|
|
555
|
+
*/
|
|
400
556
|
engine: string;
|
|
401
|
-
/**
|
|
557
|
+
/**
|
|
558
|
+
* Available database engine versions for upgrade.
|
|
559
|
+
*/
|
|
402
560
|
upgradableVersion: UpgradableVersion[];
|
|
403
|
-
/**
|
|
561
|
+
/**
|
|
562
|
+
* @deprecated Endpoint of the Database Instance.
|
|
563
|
+
*/
|
|
404
564
|
endpoint?: Endpoint;
|
|
405
|
-
/**
|
|
565
|
+
/**
|
|
566
|
+
* List of tags applied to the Database Instance.
|
|
567
|
+
*/
|
|
406
568
|
tags: string[];
|
|
407
|
-
/**
|
|
569
|
+
/**
|
|
570
|
+
* Advanced settings of the Database Instance.
|
|
571
|
+
*/
|
|
408
572
|
settings: InstanceSetting[];
|
|
409
|
-
/**
|
|
573
|
+
/**
|
|
574
|
+
* Backup schedule of the Database Instance.
|
|
575
|
+
*/
|
|
410
576
|
backupSchedule?: BackupSchedule;
|
|
411
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* Defines whether or not High-Availability is enabled.
|
|
579
|
+
*/
|
|
412
580
|
isHaCluster: boolean;
|
|
413
|
-
/**
|
|
581
|
+
/**
|
|
582
|
+
* Read Replicas of the Database Instance.
|
|
583
|
+
*/
|
|
414
584
|
readReplicas: ReadReplica[];
|
|
415
|
-
/**
|
|
585
|
+
/**
|
|
586
|
+
* Node type of the Database Instance.
|
|
587
|
+
*/
|
|
416
588
|
nodeType: string;
|
|
417
|
-
/**
|
|
589
|
+
/**
|
|
590
|
+
* List of engine settings to be set at database initialization.
|
|
591
|
+
*/
|
|
418
592
|
initSettings: InstanceSetting[];
|
|
419
|
-
/**
|
|
593
|
+
/**
|
|
594
|
+
* List of Database Instance endpoints.
|
|
595
|
+
*/
|
|
420
596
|
endpoints: Endpoint[];
|
|
421
|
-
/**
|
|
597
|
+
/**
|
|
598
|
+
* Logs policy of the Database Instance.
|
|
599
|
+
*/
|
|
422
600
|
logsPolicy?: LogsPolicy;
|
|
423
|
-
/**
|
|
601
|
+
/**
|
|
602
|
+
* Store logical backups in the same region as the Database Instance.
|
|
603
|
+
*/
|
|
424
604
|
backupSameRegion: boolean;
|
|
425
|
-
/**
|
|
605
|
+
/**
|
|
606
|
+
* List of Database Instance maintenance events.
|
|
607
|
+
*/
|
|
426
608
|
maintenances: Maintenance[];
|
|
427
|
-
/**
|
|
609
|
+
/**
|
|
610
|
+
* Encryption at rest settings for your Database Instance.
|
|
611
|
+
*/
|
|
428
612
|
encryption?: EncryptionAtRest;
|
|
429
613
|
}
|
|
430
614
|
export interface NodeType {
|
|
431
|
-
/**
|
|
615
|
+
/**
|
|
616
|
+
* Node Type name identifier.
|
|
617
|
+
*/
|
|
432
618
|
name: string;
|
|
433
|
-
/**
|
|
619
|
+
/**
|
|
620
|
+
* Current stock status for the Node Type.
|
|
621
|
+
*/
|
|
434
622
|
stockStatus: NodeTypeStock;
|
|
435
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* Current specs of the offer.
|
|
625
|
+
*/
|
|
436
626
|
description: string;
|
|
437
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* Number of virtual CPUs.
|
|
629
|
+
*/
|
|
438
630
|
vcpus: number;
|
|
439
|
-
/**
|
|
631
|
+
/**
|
|
632
|
+
* Quantity of RAM.
|
|
633
|
+
*/
|
|
440
634
|
memory: number;
|
|
441
|
-
/**
|
|
635
|
+
/**
|
|
636
|
+
* @deprecated [deprecated] Node Type volume constraints.
|
|
637
|
+
*/
|
|
442
638
|
volumeConstraint?: NodeTypeVolumeConstraintSizes;
|
|
443
|
-
/**
|
|
639
|
+
/**
|
|
640
|
+
* @deprecated The Node Type is compliant with Block Storage.
|
|
641
|
+
*/
|
|
444
642
|
isBssdCompatible?: boolean;
|
|
445
|
-
/**
|
|
643
|
+
/**
|
|
644
|
+
* The Node Type is currently disabled.
|
|
645
|
+
*/
|
|
446
646
|
disabled: boolean;
|
|
447
|
-
/**
|
|
647
|
+
/**
|
|
648
|
+
* The Node Type is currently in beta.
|
|
649
|
+
*/
|
|
448
650
|
beta: boolean;
|
|
449
|
-
/**
|
|
651
|
+
/**
|
|
652
|
+
* Available storage options for the Node Type.
|
|
653
|
+
*/
|
|
450
654
|
availableVolumeTypes: NodeTypeVolumeType[];
|
|
451
|
-
/**
|
|
655
|
+
/**
|
|
656
|
+
* The Node Type can be used only with high availability option.
|
|
657
|
+
*/
|
|
452
658
|
isHaRequired: boolean;
|
|
453
|
-
/**
|
|
659
|
+
/**
|
|
660
|
+
* Generation associated with the NodeType offer.
|
|
661
|
+
*/
|
|
454
662
|
generation: NodeTypeGeneration;
|
|
455
|
-
/**
|
|
663
|
+
/**
|
|
664
|
+
* Instance range associated with the NodeType offer.
|
|
665
|
+
*/
|
|
456
666
|
instanceRange: string;
|
|
457
|
-
/**
|
|
667
|
+
/**
|
|
668
|
+
* Region the Node Type is in.
|
|
669
|
+
*/
|
|
458
670
|
region: ScwRegion;
|
|
459
671
|
}
|
|
460
672
|
export interface Privilege {
|
|
461
|
-
/**
|
|
673
|
+
/**
|
|
674
|
+
* Permission (Read, Read/Write, All, Custom).
|
|
675
|
+
*/
|
|
462
676
|
permission: Permission;
|
|
463
|
-
/**
|
|
677
|
+
/**
|
|
678
|
+
* Name of the database.
|
|
679
|
+
*/
|
|
464
680
|
databaseName: string;
|
|
465
|
-
/**
|
|
681
|
+
/**
|
|
682
|
+
* Name of the user.
|
|
683
|
+
*/
|
|
466
684
|
userName: string;
|
|
467
685
|
}
|
|
468
686
|
export interface Snapshot {
|
|
469
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* UUID of the snapshot.
|
|
689
|
+
*/
|
|
470
690
|
id: string;
|
|
471
|
-
/**
|
|
691
|
+
/**
|
|
692
|
+
* UUID of the Database Instance.
|
|
693
|
+
*/
|
|
472
694
|
instanceId: string;
|
|
473
|
-
/**
|
|
695
|
+
/**
|
|
696
|
+
* Name of the snapshot.
|
|
697
|
+
*/
|
|
474
698
|
name: string;
|
|
475
|
-
/**
|
|
699
|
+
/**
|
|
700
|
+
* Status of the snapshot.
|
|
701
|
+
*/
|
|
476
702
|
status: SnapshotStatus;
|
|
477
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* Size of the snapshot.
|
|
705
|
+
*/
|
|
478
706
|
size?: number;
|
|
479
|
-
/**
|
|
707
|
+
/**
|
|
708
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
709
|
+
*/
|
|
480
710
|
expiresAt?: Date;
|
|
481
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Creation date (must follow the ISO 8601 format).
|
|
713
|
+
*/
|
|
482
714
|
createdAt?: Date;
|
|
483
|
-
/**
|
|
715
|
+
/**
|
|
716
|
+
* Updated date (must follow the ISO 8601 format).
|
|
717
|
+
*/
|
|
484
718
|
updatedAt?: Date;
|
|
485
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* Name of the Database Instance of the snapshot.
|
|
721
|
+
*/
|
|
486
722
|
instanceName: string;
|
|
487
|
-
/**
|
|
723
|
+
/**
|
|
724
|
+
* Source node type.
|
|
725
|
+
*/
|
|
488
726
|
nodeType: string;
|
|
489
|
-
/**
|
|
727
|
+
/**
|
|
728
|
+
* Type of volume where data is stored (lssd, bssd or sbs).
|
|
729
|
+
*/
|
|
490
730
|
volumeType?: SnapshotVolumeType;
|
|
491
|
-
/**
|
|
731
|
+
/**
|
|
732
|
+
* Region of this snapshot.
|
|
733
|
+
*/
|
|
492
734
|
region: ScwRegion;
|
|
493
735
|
}
|
|
494
736
|
export interface User {
|
|
495
737
|
/**
|
|
496
|
-
* Name of the user (Length must be between 1 and 63 characters for PostgreSQL
|
|
497
|
-
* and between 1 and 32 characters for MySQL. First character must be an
|
|
498
|
-
* alphabet character (a-zA-Z). Your username cannot start with '_rdb' or in
|
|
499
|
-
* PostgreSQL, 'pg_'. Only a-zA-Z0-9_$- characters are accepted).
|
|
738
|
+
* Name of the user (Length must be between 1 and 63 characters for PostgreSQL and between 1 and 32 characters for MySQL. First character must be an alphabet character (a-zA-Z). Your username cannot start with '_rdb' or in PostgreSQL, 'pg_'. Only a-zA-Z0-9_$- characters are accepted).
|
|
500
739
|
*/
|
|
501
740
|
name: string;
|
|
502
741
|
/**
|
|
503
|
-
* Defines whether or not a user got administrative privileges on the Database
|
|
504
|
-
* Instance.
|
|
742
|
+
* Defines whether or not a user got administrative privileges on the Database Instance.
|
|
505
743
|
*/
|
|
506
744
|
isAdmin: boolean;
|
|
507
745
|
}
|
|
508
746
|
export interface UpgradeInstanceRequestMajorUpgradeWorkflow {
|
|
509
747
|
/**
|
|
510
|
-
* This will create a new Database Instance with same specifications as the
|
|
511
|
-
* current one and perform a Database Engine upgrade.
|
|
748
|
+
* This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.
|
|
512
749
|
*/
|
|
513
750
|
upgradableVersionId: string;
|
|
514
751
|
/**
|
|
515
|
-
* At the end of the migration procedure this option let you migrate all your
|
|
516
|
-
* database endpoint to the upgraded instance.
|
|
752
|
+
* At the end of the migration procedure this option let you migrate all your database endpoint to the upgraded instance.
|
|
517
753
|
*/
|
|
518
754
|
withEndpoints: boolean;
|
|
519
755
|
}
|
|
520
756
|
export type AddInstanceACLRulesRequest = {
|
|
521
757
|
/**
|
|
522
|
-
* Region to target. If none is passed will use default region from the
|
|
523
|
-
* config.
|
|
758
|
+
* Region to target. If none is passed will use default region from the config.
|
|
524
759
|
*/
|
|
525
760
|
region?: ScwRegion;
|
|
526
|
-
/**
|
|
761
|
+
/**
|
|
762
|
+
* UUID of the Database Instance you want to add ACL rules to.
|
|
763
|
+
*/
|
|
527
764
|
instanceId: string;
|
|
528
|
-
/**
|
|
765
|
+
/**
|
|
766
|
+
* ACL rules to add to the Database Instance.
|
|
767
|
+
*/
|
|
529
768
|
rules: ACLRuleRequest[];
|
|
530
769
|
};
|
|
531
770
|
export interface AddInstanceACLRulesResponse {
|
|
532
|
-
/**
|
|
771
|
+
/**
|
|
772
|
+
* ACL Rules enabled for the Database Instance.
|
|
773
|
+
*/
|
|
533
774
|
rules: ACLRule[];
|
|
534
775
|
}
|
|
535
776
|
export type AddInstanceSettingsRequest = {
|
|
536
777
|
/**
|
|
537
|
-
* Region to target. If none is passed will use default region from the
|
|
538
|
-
* config.
|
|
778
|
+
* Region to target. If none is passed will use default region from the config.
|
|
539
779
|
*/
|
|
540
780
|
region?: ScwRegion;
|
|
541
|
-
/**
|
|
781
|
+
/**
|
|
782
|
+
* UUID of the Database Instance you want to add settings to.
|
|
783
|
+
*/
|
|
542
784
|
instanceId: string;
|
|
543
|
-
/**
|
|
785
|
+
/**
|
|
786
|
+
* Settings to add to the Database Instance.
|
|
787
|
+
*/
|
|
544
788
|
settings: InstanceSetting[];
|
|
545
789
|
};
|
|
546
790
|
export interface AddInstanceSettingsResponse {
|
|
547
|
-
/**
|
|
791
|
+
/**
|
|
792
|
+
* Settings available on the Database Instance.
|
|
793
|
+
*/
|
|
548
794
|
settings: InstanceSetting[];
|
|
549
795
|
}
|
|
550
796
|
export type ApplyInstanceMaintenanceRequest = {
|
|
551
797
|
/**
|
|
552
|
-
* Region to target. If none is passed will use default region from the
|
|
553
|
-
* config.
|
|
798
|
+
* Region to target. If none is passed will use default region from the config.
|
|
554
799
|
*/
|
|
555
800
|
region?: ScwRegion;
|
|
556
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* UUID of the Database Instance you want to apply maintenance.
|
|
803
|
+
*/
|
|
557
804
|
instanceId: string;
|
|
558
805
|
};
|
|
559
806
|
export type CloneInstanceRequest = {
|
|
560
807
|
/**
|
|
561
|
-
* Region to target. If none is passed will use default region from the
|
|
562
|
-
* config.
|
|
808
|
+
* Region to target. If none is passed will use default region from the config.
|
|
563
809
|
*/
|
|
564
810
|
region?: ScwRegion;
|
|
565
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* UUID of the Database Instance you want to clone.
|
|
813
|
+
*/
|
|
566
814
|
instanceId: string;
|
|
567
|
-
/**
|
|
815
|
+
/**
|
|
816
|
+
* Name of the Database Instance clone.
|
|
817
|
+
*/
|
|
568
818
|
name: string;
|
|
569
|
-
/**
|
|
819
|
+
/**
|
|
820
|
+
* Node type of the clone.
|
|
821
|
+
*/
|
|
570
822
|
nodeType?: string;
|
|
571
823
|
};
|
|
572
824
|
export type CreateDatabaseBackupRequest = {
|
|
573
825
|
/**
|
|
574
|
-
* Region to target. If none is passed will use default region from the
|
|
575
|
-
* config.
|
|
826
|
+
* Region to target. If none is passed will use default region from the config.
|
|
576
827
|
*/
|
|
577
828
|
region?: ScwRegion;
|
|
578
|
-
/**
|
|
829
|
+
/**
|
|
830
|
+
* UUID of the Database Instance.
|
|
831
|
+
*/
|
|
579
832
|
instanceId: string;
|
|
580
|
-
/**
|
|
833
|
+
/**
|
|
834
|
+
* Name of the database you want to back up.
|
|
835
|
+
*/
|
|
581
836
|
databaseName: string;
|
|
582
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* Name of the backup.
|
|
839
|
+
*/
|
|
583
840
|
name?: string;
|
|
584
|
-
/**
|
|
841
|
+
/**
|
|
842
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
843
|
+
*/
|
|
585
844
|
expiresAt?: Date;
|
|
586
845
|
};
|
|
587
846
|
export type CreateDatabaseRequest = {
|
|
588
847
|
/**
|
|
589
|
-
* Region to target. If none is passed will use default region from the
|
|
590
|
-
* config.
|
|
848
|
+
* Region to target. If none is passed will use default region from the config.
|
|
591
849
|
*/
|
|
592
850
|
region?: ScwRegion;
|
|
593
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* UUID of the Database Instance where to create the database.
|
|
853
|
+
*/
|
|
594
854
|
instanceId: string;
|
|
595
|
-
/**
|
|
855
|
+
/**
|
|
856
|
+
* Name of the database.
|
|
857
|
+
*/
|
|
596
858
|
name: string;
|
|
597
859
|
};
|
|
598
860
|
export type CreateEndpointRequest = {
|
|
599
861
|
/**
|
|
600
|
-
* Region to target. If none is passed will use default region from the
|
|
601
|
-
* config.
|
|
862
|
+
* Region to target. If none is passed will use default region from the config.
|
|
602
863
|
*/
|
|
603
864
|
region?: ScwRegion;
|
|
604
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* UUID of the Database Instance you to which you want to add an endpoint.
|
|
867
|
+
*/
|
|
605
868
|
instanceId: string;
|
|
606
|
-
/**
|
|
869
|
+
/**
|
|
870
|
+
* Specification of the endpoint you want to create.
|
|
871
|
+
*/
|
|
607
872
|
endpointSpec?: EndpointSpec;
|
|
608
873
|
};
|
|
609
874
|
export type CreateInstanceFromSnapshotRequest = {
|
|
610
875
|
/**
|
|
611
|
-
* Region to target. If none is passed will use default region from the
|
|
612
|
-
* config.
|
|
876
|
+
* Region to target. If none is passed will use default region from the config.
|
|
613
877
|
*/
|
|
614
878
|
region?: ScwRegion;
|
|
615
|
-
/**
|
|
879
|
+
/**
|
|
880
|
+
* Block snapshot of the Database Instance.
|
|
881
|
+
*/
|
|
616
882
|
snapshotId: string;
|
|
617
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* Name of the Database Instance created with the snapshot.
|
|
885
|
+
*/
|
|
618
886
|
instanceName: string;
|
|
619
887
|
/**
|
|
620
|
-
* Defines whether or not High-Availability is enabled on the new Database
|
|
621
|
-
* Instance.
|
|
888
|
+
* Defines whether or not High-Availability is enabled on the new Database Instance.
|
|
622
889
|
*/
|
|
623
890
|
isHaCluster?: boolean;
|
|
624
|
-
/**
|
|
891
|
+
/**
|
|
892
|
+
* The node type used to restore the snapshot.
|
|
893
|
+
*/
|
|
625
894
|
nodeType?: string;
|
|
626
895
|
};
|
|
627
896
|
export type CreateInstanceRequest = {
|
|
628
897
|
/**
|
|
629
|
-
* Region to target. If none is passed will use default region from the
|
|
630
|
-
* config.
|
|
898
|
+
* Region to target. If none is passed will use default region from the config.
|
|
631
899
|
*/
|
|
632
900
|
region?: ScwRegion;
|
|
633
901
|
/**
|
|
634
902
|
* @deprecated Please use project_id instead.
|
|
635
903
|
*
|
|
636
|
-
*
|
|
637
|
-
* could be set.
|
|
904
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
638
905
|
*/
|
|
639
906
|
organizationId?: string;
|
|
640
907
|
/**
|
|
641
908
|
* The Project ID on which the Database Instance will be created.
|
|
642
909
|
*
|
|
643
|
-
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId'
|
|
644
|
-
* could be set.
|
|
910
|
+
* One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
|
|
645
911
|
*/
|
|
646
912
|
projectId?: string;
|
|
647
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* Name of the Database Instance.
|
|
915
|
+
*/
|
|
648
916
|
name?: string;
|
|
649
|
-
/**
|
|
917
|
+
/**
|
|
918
|
+
* Database engine of the Database Instance (PostgreSQL, MySQL, ...).
|
|
919
|
+
*/
|
|
650
920
|
engine: string;
|
|
651
|
-
/**
|
|
921
|
+
/**
|
|
922
|
+
* Username created when the Database Instance is created.
|
|
923
|
+
*/
|
|
652
924
|
userName: string;
|
|
653
925
|
/**
|
|
654
|
-
* Password of the user. Password must be between 8 and 128 characters,
|
|
655
|
-
* contain at least one digit, one uppercase, one lowercase and one special
|
|
656
|
-
* character.
|
|
926
|
+
* Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
|
|
657
927
|
*/
|
|
658
928
|
password: string;
|
|
659
|
-
/**
|
|
929
|
+
/**
|
|
930
|
+
* Type of node to use for the Database Instance.
|
|
931
|
+
*/
|
|
660
932
|
nodeType: string;
|
|
661
|
-
/**
|
|
933
|
+
/**
|
|
934
|
+
* Defines whether or not High-Availability is enabled.
|
|
935
|
+
*/
|
|
662
936
|
isHaCluster: boolean;
|
|
663
|
-
/**
|
|
937
|
+
/**
|
|
938
|
+
* Defines whether or not backups are disabled.
|
|
939
|
+
*/
|
|
664
940
|
disableBackup: boolean;
|
|
665
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* Tags to apply to the Database Instance.
|
|
943
|
+
*/
|
|
666
944
|
tags?: string[];
|
|
667
|
-
/**
|
|
945
|
+
/**
|
|
946
|
+
* List of engine settings to be set upon Database Instance initialization.
|
|
947
|
+
*/
|
|
668
948
|
initSettings?: InstanceSetting[];
|
|
669
|
-
/**
|
|
949
|
+
/**
|
|
950
|
+
* Type of volume where data is stored (lssd, bssd, ...).
|
|
951
|
+
*/
|
|
670
952
|
volumeType?: VolumeType;
|
|
671
|
-
/**
|
|
953
|
+
/**
|
|
954
|
+
* Volume size when volume_type is not lssd.
|
|
955
|
+
*/
|
|
672
956
|
volumeSize: number;
|
|
673
957
|
/**
|
|
674
|
-
* One or multiple EndpointSpec used to expose your Database Instance. A
|
|
675
|
-
* load_balancer public endpoint is systematically created.
|
|
958
|
+
* One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.
|
|
676
959
|
*/
|
|
677
960
|
initEndpoints?: EndpointSpec[];
|
|
678
961
|
/**
|
|
679
|
-
* Defines whether to or not to store logical backups in the same region as
|
|
680
|
-
* the Database Instance.
|
|
962
|
+
* Defines whether to or not to store logical backups in the same region as the Database Instance.
|
|
681
963
|
*/
|
|
682
964
|
backupSameRegion: boolean;
|
|
683
|
-
/**
|
|
965
|
+
/**
|
|
966
|
+
* Encryption at rest settings for your Database Instance.
|
|
967
|
+
*/
|
|
684
968
|
encryption?: EncryptionAtRest;
|
|
685
969
|
};
|
|
686
970
|
export type CreateReadReplicaEndpointRequest = {
|
|
687
971
|
/**
|
|
688
|
-
* Region to target. If none is passed will use default region from the
|
|
689
|
-
* config.
|
|
972
|
+
* Region to target. If none is passed will use default region from the config.
|
|
690
973
|
*/
|
|
691
974
|
region?: ScwRegion;
|
|
692
|
-
/**
|
|
975
|
+
/**
|
|
976
|
+
* UUID of the Read Replica.
|
|
977
|
+
*/
|
|
693
978
|
readReplicaId: string;
|
|
694
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Specification of the endpoint you want to create.
|
|
981
|
+
*/
|
|
695
982
|
endpointSpec: ReadReplicaEndpointSpec[];
|
|
696
983
|
};
|
|
697
984
|
export type CreateReadReplicaRequest = {
|
|
698
985
|
/**
|
|
699
|
-
* Region to target. If none is passed will use default region from the
|
|
700
|
-
* config.
|
|
986
|
+
* Region to target. If none is passed will use default region from the config.
|
|
701
987
|
*/
|
|
702
988
|
region?: ScwRegion;
|
|
703
|
-
/**
|
|
989
|
+
/**
|
|
990
|
+
* UUID of the Database Instance you want to create a Read Replica from.
|
|
991
|
+
*/
|
|
704
992
|
instanceId: string;
|
|
705
|
-
/**
|
|
993
|
+
/**
|
|
994
|
+
* Specification of the endpoint you want to create.
|
|
995
|
+
*/
|
|
706
996
|
endpointSpec?: ReadReplicaEndpointSpec[];
|
|
707
997
|
/**
|
|
708
|
-
* Defines whether to create the replica in the same availability zone as the
|
|
709
|
-
* main instance nodes or not.
|
|
998
|
+
* Defines whether to create the replica in the same availability zone as the main instance nodes or not.
|
|
710
999
|
*/
|
|
711
1000
|
sameZone?: boolean;
|
|
712
1001
|
};
|
|
713
1002
|
export type CreateSnapshotRequest = {
|
|
714
1003
|
/**
|
|
715
|
-
* Region to target. If none is passed will use default region from the
|
|
716
|
-
* config.
|
|
1004
|
+
* Region to target. If none is passed will use default region from the config.
|
|
717
1005
|
*/
|
|
718
1006
|
region?: ScwRegion;
|
|
719
|
-
/**
|
|
1007
|
+
/**
|
|
1008
|
+
* UUID of the Database Instance.
|
|
1009
|
+
*/
|
|
720
1010
|
instanceId: string;
|
|
721
|
-
/**
|
|
1011
|
+
/**
|
|
1012
|
+
* Name of the snapshot.
|
|
1013
|
+
*/
|
|
722
1014
|
name?: string;
|
|
723
|
-
/**
|
|
1015
|
+
/**
|
|
1016
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
1017
|
+
*/
|
|
724
1018
|
expiresAt?: Date;
|
|
725
1019
|
};
|
|
726
1020
|
export type CreateUserRequest = {
|
|
727
1021
|
/**
|
|
728
|
-
* Region to target. If none is passed will use default region from the
|
|
729
|
-
* config.
|
|
1022
|
+
* Region to target. If none is passed will use default region from the config.
|
|
730
1023
|
*/
|
|
731
1024
|
region?: ScwRegion;
|
|
732
|
-
/**
|
|
1025
|
+
/**
|
|
1026
|
+
* UUID of the Database Instance in which you want to create a user.
|
|
1027
|
+
*/
|
|
733
1028
|
instanceId: string;
|
|
734
|
-
/**
|
|
1029
|
+
/**
|
|
1030
|
+
* Name of the user you want to create.
|
|
1031
|
+
*/
|
|
735
1032
|
name: string;
|
|
736
1033
|
/**
|
|
737
|
-
* Password of the user you want to create. Password must be between 8 and 128
|
|
738
|
-
* characters, contain at least one digit, one uppercase, one lowercase and
|
|
739
|
-
* one special character.
|
|
1034
|
+
* Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
|
|
740
1035
|
*/
|
|
741
1036
|
password: string;
|
|
742
|
-
/**
|
|
1037
|
+
/**
|
|
1038
|
+
* Defines whether the user will have administrative privileges.
|
|
1039
|
+
*/
|
|
743
1040
|
isAdmin: boolean;
|
|
744
1041
|
};
|
|
745
1042
|
export type DeleteDatabaseBackupRequest = {
|
|
746
1043
|
/**
|
|
747
|
-
* Region to target. If none is passed will use default region from the
|
|
748
|
-
* config.
|
|
1044
|
+
* Region to target. If none is passed will use default region from the config.
|
|
749
1045
|
*/
|
|
750
1046
|
region?: ScwRegion;
|
|
751
|
-
/**
|
|
1047
|
+
/**
|
|
1048
|
+
* UUID of the database backup to delete.
|
|
1049
|
+
*/
|
|
752
1050
|
databaseBackupId: string;
|
|
753
1051
|
};
|
|
754
1052
|
export type DeleteDatabaseRequest = {
|
|
755
1053
|
/**
|
|
756
|
-
* Region to target. If none is passed will use default region from the
|
|
757
|
-
* config.
|
|
1054
|
+
* Region to target. If none is passed will use default region from the config.
|
|
758
1055
|
*/
|
|
759
1056
|
region?: ScwRegion;
|
|
760
|
-
/**
|
|
1057
|
+
/**
|
|
1058
|
+
* UUID of the Database Instance where to delete the database.
|
|
1059
|
+
*/
|
|
761
1060
|
instanceId: string;
|
|
762
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* Name of the database to delete.
|
|
1063
|
+
*/
|
|
763
1064
|
name: string;
|
|
764
1065
|
};
|
|
765
1066
|
export type DeleteEndpointRequest = {
|
|
766
1067
|
/**
|
|
767
|
-
* Region to target. If none is passed will use default region from the
|
|
768
|
-
* config.
|
|
1068
|
+
* Region to target. If none is passed will use default region from the config.
|
|
769
1069
|
*/
|
|
770
1070
|
region?: ScwRegion;
|
|
771
|
-
/**
|
|
1071
|
+
/**
|
|
1072
|
+
* This endpoint can also be used to delete a Read Replica endpoint.
|
|
1073
|
+
*/
|
|
772
1074
|
endpointId: string;
|
|
773
1075
|
};
|
|
774
1076
|
export type DeleteInstanceACLRulesRequest = {
|
|
775
1077
|
/**
|
|
776
|
-
* Region to target. If none is passed will use default region from the
|
|
777
|
-
* config.
|
|
1078
|
+
* Region to target. If none is passed will use default region from the config.
|
|
778
1079
|
*/
|
|
779
1080
|
region?: ScwRegion;
|
|
780
|
-
/**
|
|
1081
|
+
/**
|
|
1082
|
+
* UUID of the Database Instance you want to delete an ACL rule from.
|
|
1083
|
+
*/
|
|
781
1084
|
instanceId: string;
|
|
782
|
-
/**
|
|
1085
|
+
/**
|
|
1086
|
+
* IP addresses defined in the ACL rules of the Database Instance.
|
|
1087
|
+
*/
|
|
783
1088
|
aclRuleIps: string[];
|
|
784
1089
|
};
|
|
785
1090
|
export interface DeleteInstanceACLRulesResponse {
|
|
786
|
-
/**
|
|
1091
|
+
/**
|
|
1092
|
+
* IP addresses defined in the ACL rules of the Database Instance.
|
|
1093
|
+
*/
|
|
787
1094
|
rules: ACLRule[];
|
|
788
1095
|
}
|
|
789
1096
|
export type DeleteInstanceRequest = {
|
|
790
1097
|
/**
|
|
791
|
-
* Region to target. If none is passed will use default region from the
|
|
792
|
-
* config.
|
|
1098
|
+
* Region to target. If none is passed will use default region from the config.
|
|
793
1099
|
*/
|
|
794
1100
|
region?: ScwRegion;
|
|
795
|
-
/**
|
|
1101
|
+
/**
|
|
1102
|
+
* UUID of the Database Instance to delete.
|
|
1103
|
+
*/
|
|
796
1104
|
instanceId: string;
|
|
797
1105
|
};
|
|
798
1106
|
export type DeleteInstanceSettingsRequest = {
|
|
799
1107
|
/**
|
|
800
|
-
* Region to target. If none is passed will use default region from the
|
|
801
|
-
* config.
|
|
1108
|
+
* Region to target. If none is passed will use default region from the config.
|
|
802
1109
|
*/
|
|
803
1110
|
region?: ScwRegion;
|
|
804
|
-
/**
|
|
1111
|
+
/**
|
|
1112
|
+
* UUID of the Database Instance to delete settings from.
|
|
1113
|
+
*/
|
|
805
1114
|
instanceId: string;
|
|
806
|
-
/**
|
|
1115
|
+
/**
|
|
1116
|
+
* Settings names to delete.
|
|
1117
|
+
*/
|
|
807
1118
|
settingNames: string[];
|
|
808
1119
|
};
|
|
809
1120
|
export interface DeleteInstanceSettingsResponse {
|
|
810
|
-
/**
|
|
1121
|
+
/**
|
|
1122
|
+
* Settings names to delete from the Database Instance.
|
|
1123
|
+
*/
|
|
811
1124
|
settings: InstanceSetting[];
|
|
812
1125
|
}
|
|
813
1126
|
export type DeleteReadReplicaRequest = {
|
|
814
1127
|
/**
|
|
815
|
-
* Region to target. If none is passed will use default region from the
|
|
816
|
-
* config.
|
|
1128
|
+
* Region to target. If none is passed will use default region from the config.
|
|
817
1129
|
*/
|
|
818
1130
|
region?: ScwRegion;
|
|
819
|
-
/**
|
|
1131
|
+
/**
|
|
1132
|
+
* UUID of the Read Replica.
|
|
1133
|
+
*/
|
|
820
1134
|
readReplicaId: string;
|
|
821
1135
|
};
|
|
822
1136
|
export type DeleteSnapshotRequest = {
|
|
823
1137
|
/**
|
|
824
|
-
* Region to target. If none is passed will use default region from the
|
|
825
|
-
* config.
|
|
1138
|
+
* Region to target. If none is passed will use default region from the config.
|
|
826
1139
|
*/
|
|
827
1140
|
region?: ScwRegion;
|
|
828
|
-
/**
|
|
1141
|
+
/**
|
|
1142
|
+
* UUID of the snapshot to delete.
|
|
1143
|
+
*/
|
|
829
1144
|
snapshotId: string;
|
|
830
1145
|
};
|
|
831
1146
|
export type DeleteUserRequest = {
|
|
832
1147
|
/**
|
|
833
|
-
* Region to target. If none is passed will use default region from the
|
|
834
|
-
* config.
|
|
1148
|
+
* Region to target. If none is passed will use default region from the config.
|
|
835
1149
|
*/
|
|
836
1150
|
region?: ScwRegion;
|
|
837
|
-
/**
|
|
1151
|
+
/**
|
|
1152
|
+
* UUID of the Database Instance to delete the user from.
|
|
1153
|
+
*/
|
|
838
1154
|
instanceId: string;
|
|
839
|
-
/**
|
|
1155
|
+
/**
|
|
1156
|
+
* Name of the user.
|
|
1157
|
+
*/
|
|
840
1158
|
name: string;
|
|
841
1159
|
};
|
|
842
1160
|
export type ExportDatabaseBackupRequest = {
|
|
843
1161
|
/**
|
|
844
|
-
* Region to target. If none is passed will use default region from the
|
|
845
|
-
* config.
|
|
1162
|
+
* Region to target. If none is passed will use default region from the config.
|
|
846
1163
|
*/
|
|
847
1164
|
region?: ScwRegion;
|
|
848
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* UUID of the database backup you want to export.
|
|
1167
|
+
*/
|
|
849
1168
|
databaseBackupId: string;
|
|
850
1169
|
};
|
|
851
1170
|
export type GetDatabaseBackupRequest = {
|
|
852
1171
|
/**
|
|
853
|
-
* Region to target. If none is passed will use default region from the
|
|
854
|
-
* config.
|
|
1172
|
+
* Region to target. If none is passed will use default region from the config.
|
|
855
1173
|
*/
|
|
856
1174
|
region?: ScwRegion;
|
|
857
|
-
/**
|
|
1175
|
+
/**
|
|
1176
|
+
* UUID of the database backup.
|
|
1177
|
+
*/
|
|
858
1178
|
databaseBackupId: string;
|
|
859
1179
|
};
|
|
860
1180
|
export type GetEndpointRequest = {
|
|
861
1181
|
/**
|
|
862
|
-
* Region to target. If none is passed will use default region from the
|
|
863
|
-
* config.
|
|
1182
|
+
* Region to target. If none is passed will use default region from the config.
|
|
864
1183
|
*/
|
|
865
1184
|
region?: ScwRegion;
|
|
866
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* UUID of the endpoint you want to get.
|
|
1187
|
+
*/
|
|
867
1188
|
endpointId: string;
|
|
868
1189
|
};
|
|
869
1190
|
export type GetInstanceCertificateRequest = {
|
|
870
1191
|
/**
|
|
871
|
-
* Region to target. If none is passed will use default region from the
|
|
872
|
-
* config.
|
|
1192
|
+
* Region to target. If none is passed will use default region from the config.
|
|
873
1193
|
*/
|
|
874
1194
|
region?: ScwRegion;
|
|
875
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* UUID of the Database Instance.
|
|
1197
|
+
*/
|
|
876
1198
|
instanceId: string;
|
|
877
1199
|
};
|
|
878
1200
|
export type GetInstanceLogRequest = {
|
|
879
1201
|
/**
|
|
880
|
-
* Region to target. If none is passed will use default region from the
|
|
881
|
-
* config.
|
|
1202
|
+
* Region to target. If none is passed will use default region from the config.
|
|
882
1203
|
*/
|
|
883
1204
|
region?: ScwRegion;
|
|
884
|
-
/**
|
|
1205
|
+
/**
|
|
1206
|
+
* UUID of the instance_log you want.
|
|
1207
|
+
*/
|
|
885
1208
|
instanceLogId: string;
|
|
886
1209
|
};
|
|
887
1210
|
export type GetInstanceMetricsRequest = {
|
|
888
1211
|
/**
|
|
889
|
-
* Region to target. If none is passed will use default region from the
|
|
890
|
-
* config.
|
|
1212
|
+
* Region to target. If none is passed will use default region from the config.
|
|
891
1213
|
*/
|
|
892
1214
|
region?: ScwRegion;
|
|
893
|
-
/**
|
|
1215
|
+
/**
|
|
1216
|
+
* UUID of the Database Instance.
|
|
1217
|
+
*/
|
|
894
1218
|
instanceId: string;
|
|
895
|
-
/**
|
|
1219
|
+
/**
|
|
1220
|
+
* Start date to gather metrics from.
|
|
1221
|
+
*/
|
|
896
1222
|
startDate?: Date;
|
|
897
|
-
/**
|
|
1223
|
+
/**
|
|
1224
|
+
* End date to gather metrics from.
|
|
1225
|
+
*/
|
|
898
1226
|
endDate?: Date;
|
|
899
|
-
/**
|
|
1227
|
+
/**
|
|
1228
|
+
* Name of the metric to gather.
|
|
1229
|
+
*/
|
|
900
1230
|
metricName?: string;
|
|
901
1231
|
};
|
|
902
1232
|
export type GetInstanceRequest = {
|
|
903
1233
|
/**
|
|
904
|
-
* Region to target. If none is passed will use default region from the
|
|
905
|
-
* config.
|
|
1234
|
+
* Region to target. If none is passed will use default region from the config.
|
|
906
1235
|
*/
|
|
907
1236
|
region?: ScwRegion;
|
|
908
|
-
/**
|
|
1237
|
+
/**
|
|
1238
|
+
* UUID of the Database Instance.
|
|
1239
|
+
*/
|
|
909
1240
|
instanceId: string;
|
|
910
1241
|
};
|
|
911
1242
|
export type GetReadReplicaRequest = {
|
|
912
1243
|
/**
|
|
913
|
-
* Region to target. If none is passed will use default region from the
|
|
914
|
-
* config.
|
|
1244
|
+
* Region to target. If none is passed will use default region from the config.
|
|
915
1245
|
*/
|
|
916
1246
|
region?: ScwRegion;
|
|
917
|
-
/**
|
|
1247
|
+
/**
|
|
1248
|
+
* UUID of the Read Replica.
|
|
1249
|
+
*/
|
|
918
1250
|
readReplicaId: string;
|
|
919
1251
|
};
|
|
920
1252
|
export type GetSnapshotRequest = {
|
|
921
1253
|
/**
|
|
922
|
-
* Region to target. If none is passed will use default region from the
|
|
923
|
-
* config.
|
|
1254
|
+
* Region to target. If none is passed will use default region from the config.
|
|
924
1255
|
*/
|
|
925
1256
|
region?: ScwRegion;
|
|
926
|
-
/**
|
|
1257
|
+
/**
|
|
1258
|
+
* UUID of the snapshot.
|
|
1259
|
+
*/
|
|
927
1260
|
snapshotId: string;
|
|
928
1261
|
};
|
|
929
1262
|
export interface InstanceMetrics {
|
|
930
|
-
/**
|
|
1263
|
+
/**
|
|
1264
|
+
* Time series of metrics of a Database Instance.
|
|
1265
|
+
*/
|
|
931
1266
|
timeseries: TimeSeries[];
|
|
932
1267
|
}
|
|
933
1268
|
export type ListDatabaseBackupsRequest = {
|
|
934
1269
|
/**
|
|
935
|
-
* Region to target. If none is passed will use default region from the
|
|
936
|
-
* config.
|
|
1270
|
+
* Region to target. If none is passed will use default region from the config.
|
|
937
1271
|
*/
|
|
938
1272
|
region?: ScwRegion;
|
|
939
|
-
/**
|
|
1273
|
+
/**
|
|
1274
|
+
* Name of the database backups.
|
|
1275
|
+
*/
|
|
940
1276
|
name?: string;
|
|
941
|
-
/**
|
|
1277
|
+
/**
|
|
1278
|
+
* Criteria to use when ordering database backups listing.
|
|
1279
|
+
*/
|
|
942
1280
|
orderBy?: ListDatabaseBackupsRequestOrderBy;
|
|
943
|
-
/**
|
|
1281
|
+
/**
|
|
1282
|
+
* UUID of the Database Instance.
|
|
1283
|
+
*/
|
|
944
1284
|
instanceId?: string;
|
|
945
|
-
/**
|
|
1285
|
+
/**
|
|
1286
|
+
* Organization ID of the Organization the database backups belong to.
|
|
1287
|
+
*/
|
|
946
1288
|
organizationId?: string;
|
|
947
|
-
/**
|
|
1289
|
+
/**
|
|
1290
|
+
* Project ID of the Project the database backups belong to.
|
|
1291
|
+
*/
|
|
948
1292
|
projectId?: string;
|
|
949
1293
|
page?: number;
|
|
950
1294
|
pageSize?: number;
|
|
951
1295
|
};
|
|
952
1296
|
export interface ListDatabaseBackupsResponse {
|
|
953
|
-
/**
|
|
1297
|
+
/**
|
|
1298
|
+
* List of database backups.
|
|
1299
|
+
*/
|
|
954
1300
|
databaseBackups: DatabaseBackup[];
|
|
955
|
-
/**
|
|
1301
|
+
/**
|
|
1302
|
+
* Total count of database backups available.
|
|
1303
|
+
*/
|
|
956
1304
|
totalCount: number;
|
|
957
1305
|
}
|
|
958
1306
|
export type ListDatabaseEnginesRequest = {
|
|
959
1307
|
/**
|
|
960
|
-
* Region to target. If none is passed will use default region from the
|
|
961
|
-
* config.
|
|
1308
|
+
* Region to target. If none is passed will use default region from the config.
|
|
962
1309
|
*/
|
|
963
1310
|
region?: ScwRegion;
|
|
964
|
-
/**
|
|
1311
|
+
/**
|
|
1312
|
+
* Name of the database engine.
|
|
1313
|
+
*/
|
|
965
1314
|
name?: string;
|
|
966
|
-
/**
|
|
1315
|
+
/**
|
|
1316
|
+
* Version of the database engine.
|
|
1317
|
+
*/
|
|
967
1318
|
version?: string;
|
|
968
1319
|
page?: number;
|
|
969
1320
|
pageSize?: number;
|
|
970
1321
|
};
|
|
971
1322
|
export interface ListDatabaseEnginesResponse {
|
|
972
|
-
/**
|
|
1323
|
+
/**
|
|
1324
|
+
* List of the available database engines.
|
|
1325
|
+
*/
|
|
973
1326
|
engines: DatabaseEngine[];
|
|
974
|
-
/**
|
|
1327
|
+
/**
|
|
1328
|
+
* Total count of database engines available.
|
|
1329
|
+
*/
|
|
975
1330
|
totalCount: number;
|
|
976
1331
|
}
|
|
977
1332
|
export type ListDatabasesRequest = {
|
|
978
1333
|
/**
|
|
979
|
-
* Region to target. If none is passed will use default region from the
|
|
980
|
-
* config.
|
|
1334
|
+
* Region to target. If none is passed will use default region from the config.
|
|
981
1335
|
*/
|
|
982
1336
|
region?: ScwRegion;
|
|
983
|
-
/**
|
|
1337
|
+
/**
|
|
1338
|
+
* UUID of the Database Instance to list the databases of.
|
|
1339
|
+
*/
|
|
984
1340
|
instanceId: string;
|
|
985
|
-
/**
|
|
1341
|
+
/**
|
|
1342
|
+
* Name of the database.
|
|
1343
|
+
*/
|
|
986
1344
|
name?: string;
|
|
987
|
-
/**
|
|
1345
|
+
/**
|
|
1346
|
+
* Defines whether or not the database is managed.
|
|
1347
|
+
*/
|
|
988
1348
|
managed?: boolean;
|
|
989
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* User that owns this database.
|
|
1351
|
+
*/
|
|
990
1352
|
owner?: string;
|
|
991
|
-
/**
|
|
1353
|
+
/**
|
|
1354
|
+
* Criteria to use when ordering database listing.
|
|
1355
|
+
*/
|
|
992
1356
|
orderBy?: ListDatabasesRequestOrderBy;
|
|
993
1357
|
page?: number;
|
|
994
1358
|
pageSize?: number;
|
|
995
1359
|
};
|
|
996
1360
|
export interface ListDatabasesResponse {
|
|
997
|
-
/**
|
|
1361
|
+
/**
|
|
1362
|
+
* List of the databases.
|
|
1363
|
+
*/
|
|
998
1364
|
databases: Database[];
|
|
999
|
-
/**
|
|
1365
|
+
/**
|
|
1366
|
+
* Total count of databases present on a Database Instance.
|
|
1367
|
+
*/
|
|
1000
1368
|
totalCount: number;
|
|
1001
1369
|
}
|
|
1002
1370
|
export type ListInstanceACLRulesRequest = {
|
|
1003
1371
|
/**
|
|
1004
|
-
* Region to target. If none is passed will use default region from the
|
|
1005
|
-
* config.
|
|
1372
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1006
1373
|
*/
|
|
1007
1374
|
region?: ScwRegion;
|
|
1008
|
-
/**
|
|
1375
|
+
/**
|
|
1376
|
+
* UUID of the Database Instance.
|
|
1377
|
+
*/
|
|
1009
1378
|
instanceId: string;
|
|
1010
1379
|
page?: number;
|
|
1011
1380
|
pageSize?: number;
|
|
1012
1381
|
};
|
|
1013
1382
|
export interface ListInstanceACLRulesResponse {
|
|
1014
|
-
/**
|
|
1383
|
+
/**
|
|
1384
|
+
* List of ACL rules present on a Database Instance.
|
|
1385
|
+
*/
|
|
1015
1386
|
rules: ACLRule[];
|
|
1016
|
-
/**
|
|
1387
|
+
/**
|
|
1388
|
+
* Total count of ACL rules present on a Database Instance.
|
|
1389
|
+
*/
|
|
1017
1390
|
totalCount: number;
|
|
1018
1391
|
}
|
|
1019
1392
|
export type ListInstanceLogsDetailsRequest = {
|
|
1020
1393
|
/**
|
|
1021
|
-
* Region to target. If none is passed will use default region from the
|
|
1022
|
-
* config.
|
|
1394
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1023
1395
|
*/
|
|
1024
1396
|
region?: ScwRegion;
|
|
1025
|
-
/**
|
|
1397
|
+
/**
|
|
1398
|
+
* UUID of the Database Instance you want logs of.
|
|
1399
|
+
*/
|
|
1026
1400
|
instanceId: string;
|
|
1027
1401
|
};
|
|
1028
1402
|
export interface ListInstanceLogsDetailsResponse {
|
|
1029
|
-
/**
|
|
1403
|
+
/**
|
|
1404
|
+
* Remote Database Instance logs details.
|
|
1405
|
+
*/
|
|
1030
1406
|
details: ListInstanceLogsDetailsResponseInstanceLogDetail[];
|
|
1031
1407
|
}
|
|
1032
1408
|
export type ListInstanceLogsRequest = {
|
|
1033
1409
|
/**
|
|
1034
|
-
* Region to target. If none is passed will use default region from the
|
|
1035
|
-
* config.
|
|
1410
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1036
1411
|
*/
|
|
1037
1412
|
region?: ScwRegion;
|
|
1038
|
-
/**
|
|
1413
|
+
/**
|
|
1414
|
+
* UUID of the Database Instance you want logs of.
|
|
1415
|
+
*/
|
|
1039
1416
|
instanceId: string;
|
|
1040
|
-
/**
|
|
1417
|
+
/**
|
|
1418
|
+
* Criteria to use when ordering Database Instance logs listing.
|
|
1419
|
+
*/
|
|
1041
1420
|
orderBy?: ListInstanceLogsRequestOrderBy;
|
|
1042
1421
|
};
|
|
1043
1422
|
export interface ListInstanceLogsResponse {
|
|
1044
|
-
/**
|
|
1423
|
+
/**
|
|
1424
|
+
* Available logs in a Database Instance.
|
|
1425
|
+
*/
|
|
1045
1426
|
instanceLogs: InstanceLog[];
|
|
1046
1427
|
}
|
|
1047
1428
|
export type ListInstancesRequest = {
|
|
1048
1429
|
/**
|
|
1049
|
-
* Region to target. If none is passed will use default region from the
|
|
1050
|
-
* config.
|
|
1430
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1051
1431
|
*/
|
|
1052
1432
|
region?: ScwRegion;
|
|
1053
|
-
/**
|
|
1433
|
+
/**
|
|
1434
|
+
* List Database Instances that have a given tag.
|
|
1435
|
+
*/
|
|
1054
1436
|
tags?: string[];
|
|
1055
|
-
/**
|
|
1437
|
+
/**
|
|
1438
|
+
* Lists Database Instances that match a name pattern.
|
|
1439
|
+
*/
|
|
1056
1440
|
name?: string;
|
|
1057
|
-
/**
|
|
1441
|
+
/**
|
|
1442
|
+
* Criteria to use when ordering Database Instance listings.
|
|
1443
|
+
*/
|
|
1058
1444
|
orderBy?: ListInstancesRequestOrderBy;
|
|
1059
|
-
/**
|
|
1445
|
+
/**
|
|
1446
|
+
* Please use project_id instead.
|
|
1447
|
+
*/
|
|
1060
1448
|
organizationId?: string;
|
|
1061
|
-
/**
|
|
1449
|
+
/**
|
|
1450
|
+
* Project ID to list the Database Instance of.
|
|
1451
|
+
*/
|
|
1062
1452
|
projectId?: string;
|
|
1063
1453
|
page?: number;
|
|
1064
1454
|
pageSize?: number;
|
|
1065
1455
|
};
|
|
1066
1456
|
export interface ListInstancesResponse {
|
|
1067
|
-
/**
|
|
1457
|
+
/**
|
|
1458
|
+
* List of all Database Instances available in an Organization or Project.
|
|
1459
|
+
*/
|
|
1068
1460
|
instances: Instance[];
|
|
1069
|
-
/**
|
|
1461
|
+
/**
|
|
1462
|
+
* Total count of Database Instances available in a Organization or Project.
|
|
1463
|
+
*/
|
|
1070
1464
|
totalCount: number;
|
|
1071
1465
|
}
|
|
1072
1466
|
export type ListNodeTypesRequest = {
|
|
1073
1467
|
/**
|
|
1074
|
-
* Region to target. If none is passed will use default region from the
|
|
1075
|
-
* config.
|
|
1468
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1076
1469
|
*/
|
|
1077
1470
|
region?: ScwRegion;
|
|
1078
|
-
/**
|
|
1471
|
+
/**
|
|
1472
|
+
* Defines whether or not to include disabled types.
|
|
1473
|
+
*/
|
|
1079
1474
|
includeDisabledTypes: boolean;
|
|
1080
1475
|
page?: number;
|
|
1081
1476
|
pageSize?: number;
|
|
1082
1477
|
};
|
|
1083
1478
|
export interface ListNodeTypesResponse {
|
|
1084
|
-
/**
|
|
1479
|
+
/**
|
|
1480
|
+
* Types of the node.
|
|
1481
|
+
*/
|
|
1085
1482
|
nodeTypes: NodeType[];
|
|
1086
|
-
/**
|
|
1483
|
+
/**
|
|
1484
|
+
* Total count of node-types available.
|
|
1485
|
+
*/
|
|
1087
1486
|
totalCount: number;
|
|
1088
1487
|
}
|
|
1089
1488
|
export type ListPrivilegesRequest = {
|
|
1090
1489
|
/**
|
|
1091
|
-
* Region to target. If none is passed will use default region from the
|
|
1092
|
-
* config.
|
|
1490
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1093
1491
|
*/
|
|
1094
1492
|
region?: ScwRegion;
|
|
1095
|
-
/**
|
|
1493
|
+
/**
|
|
1494
|
+
* UUID of the Database Instance.
|
|
1495
|
+
*/
|
|
1096
1496
|
instanceId: string;
|
|
1097
|
-
/**
|
|
1497
|
+
/**
|
|
1498
|
+
* Criteria to use when ordering privileges listing.
|
|
1499
|
+
*/
|
|
1098
1500
|
orderBy?: ListPrivilegesRequestOrderBy;
|
|
1099
1501
|
page?: number;
|
|
1100
1502
|
pageSize?: number;
|
|
1101
|
-
/**
|
|
1503
|
+
/**
|
|
1504
|
+
* Name of the database.
|
|
1505
|
+
*/
|
|
1102
1506
|
databaseName?: string;
|
|
1103
|
-
/**
|
|
1507
|
+
/**
|
|
1508
|
+
* Name of the user.
|
|
1509
|
+
*/
|
|
1104
1510
|
userName?: string;
|
|
1105
1511
|
};
|
|
1106
1512
|
export interface ListPrivilegesResponse {
|
|
1107
|
-
/**
|
|
1513
|
+
/**
|
|
1514
|
+
* Privileges of a user in a database in a Database Instance.
|
|
1515
|
+
*/
|
|
1108
1516
|
privileges: Privilege[];
|
|
1109
|
-
/**
|
|
1517
|
+
/**
|
|
1518
|
+
* Total count of privileges present on a database.
|
|
1519
|
+
*/
|
|
1110
1520
|
totalCount: number;
|
|
1111
1521
|
}
|
|
1112
1522
|
export type ListSnapshotsRequest = {
|
|
1113
1523
|
/**
|
|
1114
|
-
* Region to target. If none is passed will use default region from the
|
|
1115
|
-
* config.
|
|
1524
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1116
1525
|
*/
|
|
1117
1526
|
region?: ScwRegion;
|
|
1118
|
-
/**
|
|
1527
|
+
/**
|
|
1528
|
+
* Name of the snapshot.
|
|
1529
|
+
*/
|
|
1119
1530
|
name?: string;
|
|
1120
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* Criteria to use when ordering snapshot listing.
|
|
1533
|
+
*/
|
|
1121
1534
|
orderBy?: ListSnapshotsRequestOrderBy;
|
|
1122
|
-
/**
|
|
1535
|
+
/**
|
|
1536
|
+
* UUID of the Database Instance.
|
|
1537
|
+
*/
|
|
1123
1538
|
instanceId?: string;
|
|
1124
|
-
/**
|
|
1539
|
+
/**
|
|
1540
|
+
* Organization ID the snapshots belongs to.
|
|
1541
|
+
*/
|
|
1125
1542
|
organizationId?: string;
|
|
1126
|
-
/**
|
|
1543
|
+
/**
|
|
1544
|
+
* Project ID the snapshots belongs to.
|
|
1545
|
+
*/
|
|
1127
1546
|
projectId?: string;
|
|
1128
1547
|
page?: number;
|
|
1129
1548
|
pageSize?: number;
|
|
1130
1549
|
};
|
|
1131
1550
|
export interface ListSnapshotsResponse {
|
|
1132
|
-
/**
|
|
1551
|
+
/**
|
|
1552
|
+
* List of snapshots.
|
|
1553
|
+
*/
|
|
1133
1554
|
snapshots: Snapshot[];
|
|
1134
|
-
/**
|
|
1555
|
+
/**
|
|
1556
|
+
* Total count of snapshots available.
|
|
1557
|
+
*/
|
|
1135
1558
|
totalCount: number;
|
|
1136
1559
|
}
|
|
1137
1560
|
export type ListUsersRequest = {
|
|
1138
1561
|
/**
|
|
1139
|
-
* Region to target. If none is passed will use default region from the
|
|
1140
|
-
* config.
|
|
1562
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1141
1563
|
*/
|
|
1142
1564
|
region?: ScwRegion;
|
|
1143
|
-
/**
|
|
1565
|
+
/**
|
|
1566
|
+
* UUID of the Database Instance.
|
|
1567
|
+
*/
|
|
1144
1568
|
instanceId: string;
|
|
1145
|
-
/**
|
|
1569
|
+
/**
|
|
1570
|
+
* Name of the user.
|
|
1571
|
+
*/
|
|
1146
1572
|
name?: string;
|
|
1147
|
-
/**
|
|
1573
|
+
/**
|
|
1574
|
+
* Criteria to use when requesting user listing.
|
|
1575
|
+
*/
|
|
1148
1576
|
orderBy?: ListUsersRequestOrderBy;
|
|
1149
1577
|
page?: number;
|
|
1150
1578
|
pageSize?: number;
|
|
1151
1579
|
};
|
|
1152
1580
|
export interface ListUsersResponse {
|
|
1153
|
-
/**
|
|
1581
|
+
/**
|
|
1582
|
+
* List of users in a Database Instance.
|
|
1583
|
+
*/
|
|
1154
1584
|
users: User[];
|
|
1155
|
-
/**
|
|
1585
|
+
/**
|
|
1586
|
+
* Total count of users present on a Database Instance.
|
|
1587
|
+
*/
|
|
1156
1588
|
totalCount: number;
|
|
1157
1589
|
}
|
|
1158
1590
|
export type MigrateEndpointRequest = {
|
|
1159
1591
|
/**
|
|
1160
|
-
* Region to target. If none is passed will use default region from the
|
|
1161
|
-
* config.
|
|
1592
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1162
1593
|
*/
|
|
1163
1594
|
region?: ScwRegion;
|
|
1164
|
-
/**
|
|
1595
|
+
/**
|
|
1596
|
+
* UUID of the endpoint you want to migrate.
|
|
1597
|
+
*/
|
|
1165
1598
|
endpointId: string;
|
|
1166
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* UUID of the instance you want to attach the endpoint to.
|
|
1601
|
+
*/
|
|
1167
1602
|
instanceId: string;
|
|
1168
1603
|
};
|
|
1169
1604
|
export type PrepareInstanceLogsRequest = {
|
|
1170
1605
|
/**
|
|
1171
|
-
* Region to target. If none is passed will use default region from the
|
|
1172
|
-
* config.
|
|
1606
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1173
1607
|
*/
|
|
1174
1608
|
region?: ScwRegion;
|
|
1175
|
-
/**
|
|
1609
|
+
/**
|
|
1610
|
+
* UUID of the Database Instance you want logs of.
|
|
1611
|
+
*/
|
|
1176
1612
|
instanceId: string;
|
|
1177
|
-
/**
|
|
1613
|
+
/**
|
|
1614
|
+
* Start datetime of your log. (RFC 3339 format).
|
|
1615
|
+
*/
|
|
1178
1616
|
startDate?: Date;
|
|
1179
|
-
/**
|
|
1617
|
+
/**
|
|
1618
|
+
* End datetime of your log. (RFC 3339 format).
|
|
1619
|
+
*/
|
|
1180
1620
|
endDate?: Date;
|
|
1181
1621
|
};
|
|
1182
1622
|
export interface PrepareInstanceLogsResponse {
|
|
1183
|
-
/**
|
|
1623
|
+
/**
|
|
1624
|
+
* Instance logs for a Database Instance between a start and an end date.
|
|
1625
|
+
*/
|
|
1184
1626
|
instanceLogs: InstanceLog[];
|
|
1185
1627
|
}
|
|
1186
1628
|
export type PromoteReadReplicaRequest = {
|
|
1187
1629
|
/**
|
|
1188
|
-
* Region to target. If none is passed will use default region from the
|
|
1189
|
-
* config.
|
|
1630
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1190
1631
|
*/
|
|
1191
1632
|
region?: ScwRegion;
|
|
1192
|
-
/**
|
|
1633
|
+
/**
|
|
1634
|
+
* UUID of the Read Replica.
|
|
1635
|
+
*/
|
|
1193
1636
|
readReplicaId: string;
|
|
1194
1637
|
};
|
|
1195
1638
|
export type PurgeInstanceLogsRequest = {
|
|
1196
1639
|
/**
|
|
1197
|
-
* Region to target. If none is passed will use default region from the
|
|
1198
|
-
* config.
|
|
1640
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1199
1641
|
*/
|
|
1200
1642
|
region?: ScwRegion;
|
|
1201
|
-
/**
|
|
1643
|
+
/**
|
|
1644
|
+
* UUID of the Database Instance you want logs of.
|
|
1645
|
+
*/
|
|
1202
1646
|
instanceId: string;
|
|
1203
|
-
/**
|
|
1647
|
+
/**
|
|
1648
|
+
* Given log name to purge.
|
|
1649
|
+
*/
|
|
1204
1650
|
logName?: string;
|
|
1205
1651
|
};
|
|
1206
1652
|
export type RenewInstanceCertificateRequest = {
|
|
1207
1653
|
/**
|
|
1208
|
-
* Region to target. If none is passed will use default region from the
|
|
1209
|
-
* config.
|
|
1654
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1210
1655
|
*/
|
|
1211
1656
|
region?: ScwRegion;
|
|
1212
|
-
/**
|
|
1657
|
+
/**
|
|
1658
|
+
* UUID of the Database Instance you want logs of.
|
|
1659
|
+
*/
|
|
1213
1660
|
instanceId: string;
|
|
1214
1661
|
};
|
|
1215
1662
|
export type ResetReadReplicaRequest = {
|
|
1216
1663
|
/**
|
|
1217
|
-
* Region to target. If none is passed will use default region from the
|
|
1218
|
-
* config.
|
|
1664
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1219
1665
|
*/
|
|
1220
1666
|
region?: ScwRegion;
|
|
1221
|
-
/**
|
|
1667
|
+
/**
|
|
1668
|
+
* UUID of the Read Replica.
|
|
1669
|
+
*/
|
|
1222
1670
|
readReplicaId: string;
|
|
1223
1671
|
};
|
|
1224
1672
|
export type RestartInstanceRequest = {
|
|
1225
1673
|
/**
|
|
1226
|
-
* Region to target. If none is passed will use default region from the
|
|
1227
|
-
* config.
|
|
1674
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1228
1675
|
*/
|
|
1229
1676
|
region?: ScwRegion;
|
|
1230
|
-
/**
|
|
1677
|
+
/**
|
|
1678
|
+
* UUID of the Database Instance you want to restart.
|
|
1679
|
+
*/
|
|
1231
1680
|
instanceId: string;
|
|
1232
1681
|
};
|
|
1233
1682
|
export type RestoreDatabaseBackupRequest = {
|
|
1234
1683
|
/**
|
|
1235
|
-
* Region to target. If none is passed will use default region from the
|
|
1236
|
-
* config.
|
|
1684
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1237
1685
|
*/
|
|
1238
1686
|
region?: ScwRegion;
|
|
1239
|
-
/**
|
|
1687
|
+
/**
|
|
1688
|
+
* Backup of a logical database.
|
|
1689
|
+
*/
|
|
1240
1690
|
databaseBackupId: string;
|
|
1241
1691
|
/**
|
|
1242
|
-
* Defines the destination database to restore into a specified database (the
|
|
1243
|
-
* default destination is set to the origin database of the backup).
|
|
1692
|
+
* Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup).
|
|
1244
1693
|
*/
|
|
1245
1694
|
databaseName?: string;
|
|
1246
|
-
/**
|
|
1695
|
+
/**
|
|
1696
|
+
* Defines the Database Instance where the backup has to be restored.
|
|
1697
|
+
*/
|
|
1247
1698
|
instanceId: string;
|
|
1248
1699
|
};
|
|
1249
1700
|
export type SetInstanceACLRulesRequest = {
|
|
1250
1701
|
/**
|
|
1251
|
-
* Region to target. If none is passed will use default region from the
|
|
1252
|
-
* config.
|
|
1702
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1253
1703
|
*/
|
|
1254
1704
|
region?: ScwRegion;
|
|
1255
|
-
/**
|
|
1705
|
+
/**
|
|
1706
|
+
* UUID of the Database Instance where the ACL rules must be set.
|
|
1707
|
+
*/
|
|
1256
1708
|
instanceId: string;
|
|
1257
|
-
/**
|
|
1709
|
+
/**
|
|
1710
|
+
* ACL rules to define for the Database Instance.
|
|
1711
|
+
*/
|
|
1258
1712
|
rules: ACLRuleRequest[];
|
|
1259
1713
|
};
|
|
1260
1714
|
export interface SetInstanceACLRulesResponse {
|
|
1261
|
-
/**
|
|
1715
|
+
/**
|
|
1716
|
+
* ACLs rules configured for a Database Instance.
|
|
1717
|
+
*/
|
|
1262
1718
|
rules: ACLRule[];
|
|
1263
1719
|
}
|
|
1264
1720
|
export type SetInstanceSettingsRequest = {
|
|
1265
1721
|
/**
|
|
1266
|
-
* Region to target. If none is passed will use default region from the
|
|
1267
|
-
* config.
|
|
1722
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1268
1723
|
*/
|
|
1269
1724
|
region?: ScwRegion;
|
|
1270
|
-
/**
|
|
1725
|
+
/**
|
|
1726
|
+
* UUID of the Database Instance where the settings must be set.
|
|
1727
|
+
*/
|
|
1271
1728
|
instanceId: string;
|
|
1272
|
-
/**
|
|
1729
|
+
/**
|
|
1730
|
+
* Settings to define for the Database Instance.
|
|
1731
|
+
*/
|
|
1273
1732
|
settings: InstanceSetting[];
|
|
1274
1733
|
};
|
|
1275
1734
|
export interface SetInstanceSettingsResponse {
|
|
1276
|
-
/**
|
|
1735
|
+
/**
|
|
1736
|
+
* Settings configured for a Database Instance.
|
|
1737
|
+
*/
|
|
1277
1738
|
settings: InstanceSetting[];
|
|
1278
1739
|
}
|
|
1279
1740
|
export type SetPrivilegeRequest = {
|
|
1280
1741
|
/**
|
|
1281
|
-
* Region to target. If none is passed will use default region from the
|
|
1282
|
-
* config.
|
|
1742
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1283
1743
|
*/
|
|
1284
1744
|
region?: ScwRegion;
|
|
1285
|
-
/**
|
|
1745
|
+
/**
|
|
1746
|
+
* UUID of the Database Instance.
|
|
1747
|
+
*/
|
|
1286
1748
|
instanceId: string;
|
|
1287
|
-
/**
|
|
1749
|
+
/**
|
|
1750
|
+
* Name of the database.
|
|
1751
|
+
*/
|
|
1288
1752
|
databaseName: string;
|
|
1289
|
-
/**
|
|
1753
|
+
/**
|
|
1754
|
+
* Name of the user.
|
|
1755
|
+
*/
|
|
1290
1756
|
userName: string;
|
|
1291
|
-
/**
|
|
1757
|
+
/**
|
|
1758
|
+
* Permission to set (Read, Read/Write, All, Custom).
|
|
1759
|
+
*/
|
|
1292
1760
|
permission?: Permission;
|
|
1293
1761
|
};
|
|
1294
1762
|
export type UpdateDatabaseBackupRequest = {
|
|
1295
1763
|
/**
|
|
1296
|
-
* Region to target. If none is passed will use default region from the
|
|
1297
|
-
* config.
|
|
1764
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1298
1765
|
*/
|
|
1299
1766
|
region?: ScwRegion;
|
|
1300
|
-
/**
|
|
1767
|
+
/**
|
|
1768
|
+
* UUID of the database backup to update.
|
|
1769
|
+
*/
|
|
1301
1770
|
databaseBackupId: string;
|
|
1302
|
-
/**
|
|
1771
|
+
/**
|
|
1772
|
+
* Name of the Database Backup.
|
|
1773
|
+
*/
|
|
1303
1774
|
name?: string;
|
|
1304
|
-
/**
|
|
1775
|
+
/**
|
|
1776
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
1777
|
+
*/
|
|
1305
1778
|
expiresAt?: Date;
|
|
1306
1779
|
};
|
|
1307
1780
|
export type UpdateInstanceRequest = {
|
|
1308
1781
|
/**
|
|
1309
|
-
* Region to target. If none is passed will use default region from the
|
|
1310
|
-
* config.
|
|
1782
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1311
1783
|
*/
|
|
1312
1784
|
region?: ScwRegion;
|
|
1313
|
-
/**
|
|
1785
|
+
/**
|
|
1786
|
+
* UUID of the Database Instance to update.
|
|
1787
|
+
*/
|
|
1314
1788
|
instanceId: string;
|
|
1315
|
-
/**
|
|
1789
|
+
/**
|
|
1790
|
+
* In hours.
|
|
1791
|
+
*/
|
|
1316
1792
|
backupScheduleFrequency?: number;
|
|
1317
|
-
/**
|
|
1793
|
+
/**
|
|
1794
|
+
* In days.
|
|
1795
|
+
*/
|
|
1318
1796
|
backupScheduleRetention?: number;
|
|
1319
|
-
/**
|
|
1797
|
+
/**
|
|
1798
|
+
* Defines whether or not the backup schedule is disabled.
|
|
1799
|
+
*/
|
|
1320
1800
|
isBackupScheduleDisabled?: boolean;
|
|
1321
|
-
/**
|
|
1801
|
+
/**
|
|
1802
|
+
* Name of the Database Instance.
|
|
1803
|
+
*/
|
|
1322
1804
|
name?: string;
|
|
1323
|
-
/**
|
|
1805
|
+
/**
|
|
1806
|
+
* Tags of a Database Instance.
|
|
1807
|
+
*/
|
|
1324
1808
|
tags?: string[];
|
|
1325
|
-
/**
|
|
1809
|
+
/**
|
|
1810
|
+
* Logs policy of the Database Instance.
|
|
1811
|
+
*/
|
|
1326
1812
|
logsPolicy?: LogsPolicy;
|
|
1327
|
-
/**
|
|
1813
|
+
/**
|
|
1814
|
+
* Store logical backups in the same region as the Database Instance.
|
|
1815
|
+
*/
|
|
1328
1816
|
backupSameRegion?: boolean;
|
|
1329
|
-
/**
|
|
1817
|
+
/**
|
|
1818
|
+
* Defines the start time of the autobackup.
|
|
1819
|
+
*/
|
|
1330
1820
|
backupScheduleStartHour?: number;
|
|
1331
1821
|
};
|
|
1332
1822
|
export type UpdateSnapshotRequest = {
|
|
1333
1823
|
/**
|
|
1334
|
-
* Region to target. If none is passed will use default region from the
|
|
1335
|
-
* config.
|
|
1824
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1336
1825
|
*/
|
|
1337
1826
|
region?: ScwRegion;
|
|
1338
|
-
/**
|
|
1827
|
+
/**
|
|
1828
|
+
* UUID of the snapshot to update.
|
|
1829
|
+
*/
|
|
1339
1830
|
snapshotId: string;
|
|
1340
|
-
/**
|
|
1831
|
+
/**
|
|
1832
|
+
* Name of the snapshot.
|
|
1833
|
+
*/
|
|
1341
1834
|
name?: string;
|
|
1342
|
-
/**
|
|
1835
|
+
/**
|
|
1836
|
+
* Expiration date (must follow the ISO 8601 format).
|
|
1837
|
+
*/
|
|
1343
1838
|
expiresAt?: Date;
|
|
1344
1839
|
};
|
|
1345
1840
|
export type UpdateUserRequest = {
|
|
1346
1841
|
/**
|
|
1347
|
-
* Region to target. If none is passed will use default region from the
|
|
1348
|
-
* config.
|
|
1842
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1349
1843
|
*/
|
|
1350
1844
|
region?: ScwRegion;
|
|
1351
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* UUID of the Database Instance the user belongs to.
|
|
1847
|
+
*/
|
|
1352
1848
|
instanceId: string;
|
|
1353
|
-
/**
|
|
1849
|
+
/**
|
|
1850
|
+
* Name of the database user.
|
|
1851
|
+
*/
|
|
1354
1852
|
name: string;
|
|
1355
1853
|
/**
|
|
1356
|
-
* Password of the database user. Password must be between 8 and 128
|
|
1357
|
-
* characters, contain at least one digit, one uppercase, one lowercase and
|
|
1358
|
-
* one special character.
|
|
1854
|
+
* Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
|
|
1359
1855
|
*/
|
|
1360
1856
|
password?: string;
|
|
1361
|
-
/**
|
|
1857
|
+
/**
|
|
1858
|
+
* Defines whether or not this user got administrative privileges.
|
|
1859
|
+
*/
|
|
1362
1860
|
isAdmin?: boolean;
|
|
1363
1861
|
};
|
|
1364
1862
|
export type UpgradeInstanceRequest = {
|
|
1365
1863
|
/**
|
|
1366
|
-
* Region to target. If none is passed will use default region from the
|
|
1367
|
-
* config.
|
|
1864
|
+
* Region to target. If none is passed will use default region from the config.
|
|
1368
1865
|
*/
|
|
1369
1866
|
region?: ScwRegion;
|
|
1370
|
-
/**
|
|
1867
|
+
/**
|
|
1868
|
+
* UUID of the Database Instance you want to upgrade.
|
|
1869
|
+
*/
|
|
1371
1870
|
instanceId: string;
|
|
1372
1871
|
/**
|
|
1373
1872
|
* Node type of the Database Instance you want to upgrade to.
|
|
1374
1873
|
*
|
|
1375
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1376
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1377
|
-
* 'enableEncryption' could be set.
|
|
1874
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1378
1875
|
*/
|
|
1379
1876
|
nodeType?: string;
|
|
1380
1877
|
/**
|
|
1381
|
-
* Defines whether or not high availability should be enabled on the Database
|
|
1382
|
-
* Instance.
|
|
1878
|
+
* Defines whether or not high availability should be enabled on the Database Instance.
|
|
1383
1879
|
*
|
|
1384
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1385
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1386
|
-
* 'enableEncryption' could be set.
|
|
1880
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1387
1881
|
*/
|
|
1388
1882
|
enableHa?: boolean;
|
|
1389
1883
|
/**
|
|
1390
1884
|
* Increase your block storage volume size.
|
|
1391
1885
|
*
|
|
1392
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1393
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1394
|
-
* 'enableEncryption' could be set.
|
|
1886
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1395
1887
|
*/
|
|
1396
1888
|
volumeSize?: number;
|
|
1397
1889
|
/**
|
|
1398
1890
|
* Change your Database Instance storage type.
|
|
1399
1891
|
*
|
|
1400
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1401
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1402
|
-
* 'enableEncryption' could be set.
|
|
1892
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1403
1893
|
*/
|
|
1404
1894
|
volumeType?: VolumeType;
|
|
1405
1895
|
/**
|
|
1406
|
-
* This will create a new Database Instance with same specifications as the
|
|
1407
|
-
* current one and perform a Database Engine upgrade.
|
|
1896
|
+
* This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.
|
|
1408
1897
|
*
|
|
1409
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1410
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1411
|
-
* 'enableEncryption' could be set.
|
|
1898
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1412
1899
|
*/
|
|
1413
1900
|
upgradableVersionId?: string;
|
|
1414
1901
|
/**
|
|
1415
|
-
* Upgrade your database engine to a new major version including instance
|
|
1416
|
-
* endpoints.
|
|
1902
|
+
* Upgrade your database engine to a new major version including instance endpoints.
|
|
1417
1903
|
*
|
|
1418
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1419
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1420
|
-
* 'enableEncryption' could be set.
|
|
1904
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1421
1905
|
*/
|
|
1422
1906
|
majorUpgradeWorkflow?: UpgradeInstanceRequestMajorUpgradeWorkflow;
|
|
1423
1907
|
/**
|
|
1424
|
-
* Defines whether or not encryption should be enabled on the Database
|
|
1425
|
-
* Instance.
|
|
1908
|
+
* Defines whether or not encryption should be enabled on the Database Instance.
|
|
1426
1909
|
*
|
|
1427
|
-
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa',
|
|
1428
|
-
* 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow',
|
|
1429
|
-
* 'enableEncryption' could be set.
|
|
1910
|
+
* One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set.
|
|
1430
1911
|
*/
|
|
1431
1912
|
enableEncryption?: boolean;
|
|
1432
1913
|
};
|