@scaleway/sdk 2.72.0 → 2.73.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/types.gen.d.ts +187 -85
- 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 +100 -156
- package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
- package/dist/api/cockpit/v1/api.gen.js +100 -156
- package/dist/api/cockpit/v1/types.gen.d.ts +567 -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/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/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 +8 -11
- package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
- package/dist/api/inference/v1beta1/api.gen.js +8 -11
- 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/types.gen.d.ts +1351 -598
- 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/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/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/client/dist/package.json.cjs +1 -1
- package/dist/client/dist/package.json.js +1 -1
- 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
|
@@ -3,19 +3,15 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
|
|
|
3
3
|
import type { AttachRoutingPolicyRequest, AttachVpcRequest, CreateLinkRequest, CreateRoutingPolicyRequest, DedicatedConnection, DeleteLinkRequest, DeleteRoutingPolicyRequest, DetachRoutingPolicyRequest, DetachVpcRequest, DisableRoutePropagationRequest, EnableRoutePropagationRequest, GetDedicatedConnectionRequest, GetLinkRequest, GetPartnerRequest, GetPopRequest, GetRoutingPolicyRequest, Link, ListDedicatedConnectionsRequest, ListDedicatedConnectionsResponse, ListLinksRequest, ListLinksResponse, ListPartnersRequest, ListPartnersResponse, ListPopsRequest, ListPopsResponse, ListRoutingPoliciesRequest, ListRoutingPoliciesResponse, Partner, Pop, RoutingPolicy, UpdateLinkRequest, UpdateRoutingPolicyRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* InterLink API.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
* on-premises infrastructure with your Scaleway VPC.
|
|
6
|
+
|
|
7
|
+
This API allows you to manage your Scaleway InterLink, to connect your on-premises infrastructure with your Scaleway VPC.
|
|
9
8
|
*/
|
|
10
9
|
export declare class API extends ParentAPI {
|
|
11
10
|
/** Lists the available regions of the API. */
|
|
12
11
|
static readonly LOCALITIES: ScwRegion[];
|
|
13
12
|
protected pageOfListDedicatedConnections: (request?: Readonly<ListDedicatedConnectionsRequest>) => Promise<ListDedicatedConnectionsResponse>;
|
|
14
13
|
/**
|
|
15
|
-
* List dedicated connections. For self-hosted users, list their dedicated
|
|
16
|
-
* physical connections in a given region. By default, the connections
|
|
17
|
-
* returned in the list are ordered by name in ascending order, though this
|
|
18
|
-
* can be modified via the `order_by` field.
|
|
14
|
+
* List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
|
|
19
15
|
*
|
|
20
16
|
* @param request - The request {@link ListDedicatedConnectionsRequest}
|
|
21
17
|
* @returns A Promise of ListDedicatedConnectionsResponse
|
|
@@ -25,9 +21,7 @@ export declare class API extends ParentAPI {
|
|
|
25
21
|
[Symbol.asyncIterator]: () => AsyncGenerator<DedicatedConnection[], void, void>;
|
|
26
22
|
};
|
|
27
23
|
/**
|
|
28
|
-
* Get a dedicated connection. For self-hosted users, get a dedicated physical
|
|
29
|
-
* connection corresponding to the given ID. The response object includes
|
|
30
|
-
* information such as the connection's name, status and total bandwidth.
|
|
24
|
+
* Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth.
|
|
31
25
|
*
|
|
32
26
|
* @param request - The request {@link GetDedicatedConnectionRequest}
|
|
33
27
|
* @returns A Promise of DedicatedConnection
|
|
@@ -43,9 +37,7 @@ export declare class API extends ParentAPI {
|
|
|
43
37
|
waitForDedicatedConnection: (request: Readonly<GetDedicatedConnectionRequest>, options?: Readonly<WaitForOptions<DedicatedConnection>>) => Promise<DedicatedConnection>;
|
|
44
38
|
protected pageOfListPartners: (request?: Readonly<ListPartnersRequest>) => Promise<ListPartnersResponse>;
|
|
45
39
|
/**
|
|
46
|
-
* List available partners. List all available partners. By default, the
|
|
47
|
-
* partners returned in the list are ordered by name in ascending order,
|
|
48
|
-
* though this can be modified via the `order_by` field.
|
|
40
|
+
* List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
|
|
49
41
|
*
|
|
50
42
|
* @param request - The request {@link ListPartnersRequest}
|
|
51
43
|
* @returns A Promise of ListPartnersResponse
|
|
@@ -55,9 +47,7 @@ export declare class API extends ParentAPI {
|
|
|
55
47
|
[Symbol.asyncIterator]: () => AsyncGenerator<Partner[], void, void>;
|
|
56
48
|
};
|
|
57
49
|
/**
|
|
58
|
-
* Get a partner. Get a partner for the given partner IP. The response object
|
|
59
|
-
* includes information such as the partner's name, email address and portal
|
|
60
|
-
* URL.
|
|
50
|
+
* Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.
|
|
61
51
|
*
|
|
62
52
|
* @param request - The request {@link GetPartnerRequest}
|
|
63
53
|
* @returns A Promise of Partner
|
|
@@ -65,8 +55,7 @@ export declare class API extends ParentAPI {
|
|
|
65
55
|
getPartner: (request: Readonly<GetPartnerRequest>) => Promise<Partner>;
|
|
66
56
|
protected pageOfListPops: (request?: Readonly<ListPopsRequest>) => Promise<ListPopsResponse>;
|
|
67
57
|
/**
|
|
68
|
-
* List PoPs. List all available PoPs (locations) for a given region. By
|
|
69
|
-
* default, the results are returned in ascending alphabetical order by name.
|
|
58
|
+
* List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.
|
|
70
59
|
*
|
|
71
60
|
* @param request - The request {@link ListPopsRequest}
|
|
72
61
|
* @returns A Promise of ListPopsResponse
|
|
@@ -76,8 +65,7 @@ export declare class API extends ParentAPI {
|
|
|
76
65
|
[Symbol.asyncIterator]: () => AsyncGenerator<Pop[], void, void>;
|
|
77
66
|
};
|
|
78
67
|
/**
|
|
79
|
-
* Get a PoP. Get a PoP for the given PoP ID. The response object includes the
|
|
80
|
-
* PoP's name and information about its physical location.
|
|
68
|
+
* Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.
|
|
81
69
|
*
|
|
82
70
|
* @param request - The request {@link GetPopRequest}
|
|
83
71
|
* @returns A Promise of Pop
|
|
@@ -85,8 +73,7 @@ export declare class API extends ParentAPI {
|
|
|
85
73
|
getPop: (request: Readonly<GetPopRequest>) => Promise<Pop>;
|
|
86
74
|
protected pageOfListLinks: (request?: Readonly<ListLinksRequest>) => Promise<ListLinksResponse>;
|
|
87
75
|
/**
|
|
88
|
-
* List links. List all your links (InterLink connections). A number of
|
|
89
|
-
* filters are available, including Project ID, name, tags and status.
|
|
76
|
+
* List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.
|
|
90
77
|
*
|
|
91
78
|
* @param request - The request {@link ListLinksRequest}
|
|
92
79
|
* @returns A Promise of ListLinksResponse
|
|
@@ -96,9 +83,7 @@ export declare class API extends ParentAPI {
|
|
|
96
83
|
[Symbol.asyncIterator]: () => AsyncGenerator<Link[], void, void>;
|
|
97
84
|
};
|
|
98
85
|
/**
|
|
99
|
-
* Get a link. Get a link (InterLink session / logical InterLink resource) for
|
|
100
|
-
* the given link ID. The response object includes information about the
|
|
101
|
-
* link's various configuration details.
|
|
86
|
+
* Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.
|
|
102
87
|
*
|
|
103
88
|
* @param request - The request {@link GetLinkRequest}
|
|
104
89
|
* @returns A Promise of Link
|
|
@@ -113,39 +98,28 @@ export declare class API extends ParentAPI {
|
|
|
113
98
|
*/
|
|
114
99
|
waitForLink: (request: Readonly<GetLinkRequest>, options?: Readonly<WaitForOptions<Link>>) => Promise<Link>;
|
|
115
100
|
/**
|
|
116
|
-
* Create a link. Create a link (InterLink session / logical InterLink
|
|
117
|
-
* resource) in a given PoP, specifying its various configuration details.
|
|
118
|
-
* Links can either be hosted (faciliated by partners' shared physical
|
|
119
|
-
* connections) or self-hosted (for users who have purchased a dedicated
|
|
120
|
-
* physical connection).
|
|
101
|
+
* Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
|
|
121
102
|
*
|
|
122
103
|
* @param request - The request {@link CreateLinkRequest}
|
|
123
104
|
* @returns A Promise of Link
|
|
124
105
|
*/
|
|
125
106
|
createLink: (request: Readonly<CreateLinkRequest>) => Promise<Link>;
|
|
126
107
|
/**
|
|
127
|
-
* Update a link. Update an existing link, specified by its link ID. Only its
|
|
128
|
-
* name and tags can be updated.
|
|
108
|
+
* Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated.
|
|
129
109
|
*
|
|
130
110
|
* @param request - The request {@link UpdateLinkRequest}
|
|
131
111
|
* @returns A Promise of Link
|
|
132
112
|
*/
|
|
133
113
|
updateLink: (request: Readonly<UpdateLinkRequest>) => Promise<Link>;
|
|
134
114
|
/**
|
|
135
|
-
* Delete a link. Delete an existing link, specified by its link ID. Note that
|
|
136
|
-
* as well as deleting the link here on the Scaleway side, it is also
|
|
137
|
-
* necessary to request deletion from the partner on their side. Only when
|
|
138
|
-
* this action has been carried out on both sides will the resource be
|
|
139
|
-
* completely deleted.
|
|
115
|
+
* Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
|
|
140
116
|
*
|
|
141
117
|
* @param request - The request {@link DeleteLinkRequest}
|
|
142
118
|
* @returns A Promise of Link
|
|
143
119
|
*/
|
|
144
120
|
deleteLink: (request: Readonly<DeleteLinkRequest>) => Promise<Link>;
|
|
145
121
|
/**
|
|
146
|
-
* Attach a VPC. Attach a VPC to an existing link. This facilitates
|
|
147
|
-
* communication between the resources in your Scaleway VPC, and your
|
|
148
|
-
* on-premises infrastructure.
|
|
122
|
+
* Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
|
|
149
123
|
*
|
|
150
124
|
* @param request - The request {@link AttachVpcRequest}
|
|
151
125
|
* @returns A Promise of Link
|
|
@@ -159,40 +133,28 @@ export declare class API extends ParentAPI {
|
|
|
159
133
|
*/
|
|
160
134
|
detachVpc: (request: Readonly<DetachVpcRequest>) => Promise<Link>;
|
|
161
135
|
/**
|
|
162
|
-
* Attach a routing policy. Attach a routing policy to an existing link. As
|
|
163
|
-
* all routes across the link are blocked by default, you must attach a
|
|
164
|
-
* routing policy to set IP prefix filters for allowed routes, facilitating
|
|
165
|
-
* traffic flow.
|
|
136
|
+
* Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
|
|
166
137
|
*
|
|
167
138
|
* @param request - The request {@link AttachRoutingPolicyRequest}
|
|
168
139
|
* @returns A Promise of Link
|
|
169
140
|
*/
|
|
170
141
|
attachRoutingPolicy: (request: Readonly<AttachRoutingPolicyRequest>) => Promise<Link>;
|
|
171
142
|
/**
|
|
172
|
-
* Detach a routing policy. Detach a routing policy from an existing link.
|
|
173
|
-
* Without a routing policy, all routes across the link are blocked by
|
|
174
|
-
* default.
|
|
143
|
+
* Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
|
|
175
144
|
*
|
|
176
145
|
* @param request - The request {@link DetachRoutingPolicyRequest}
|
|
177
146
|
* @returns A Promise of Link
|
|
178
147
|
*/
|
|
179
148
|
detachRoutingPolicy: (request: Readonly<DetachRoutingPolicyRequest>) => Promise<Link>;
|
|
180
149
|
/**
|
|
181
|
-
* Enable route propagation. Enable all allowed prefixes (defined in a routing
|
|
182
|
-
* policy) to be announced in the BGP session. This allows traffic to flow
|
|
183
|
-
* between the attached VPC and the on-premises infrastructure along the
|
|
184
|
-
* announced routes. Note that by default, even when route propagation is
|
|
185
|
-
* enabled, all routes are blocked. It is essential to attach a routing policy
|
|
186
|
-
* to define the ranges of routes to announce.
|
|
150
|
+
* Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
|
|
187
151
|
*
|
|
188
152
|
* @param request - The request {@link EnableRoutePropagationRequest}
|
|
189
153
|
* @returns A Promise of Link
|
|
190
154
|
*/
|
|
191
155
|
enableRoutePropagation: (request: Readonly<EnableRoutePropagationRequest>) => Promise<Link>;
|
|
192
156
|
/**
|
|
193
|
-
* Disable route propagation. Prevent any prefixes from being announced in the
|
|
194
|
-
* BGP session. Traffic will not be able to flow over the InterLink until
|
|
195
|
-
* route propagation is re-enabled.
|
|
157
|
+
* Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
|
|
196
158
|
*
|
|
197
159
|
* @param request - The request {@link DisableRoutePropagationRequest}
|
|
198
160
|
* @returns A Promise of Link
|
|
@@ -200,9 +162,7 @@ export declare class API extends ParentAPI {
|
|
|
200
162
|
disableRoutePropagation: (request: Readonly<DisableRoutePropagationRequest>) => Promise<Link>;
|
|
201
163
|
protected pageOfListRoutingPolicies: (request?: Readonly<ListRoutingPoliciesRequest>) => Promise<ListRoutingPoliciesResponse>;
|
|
202
164
|
/**
|
|
203
|
-
* List routing policies. List all routing policies in a given region. A
|
|
204
|
-
* routing policy can be attached to one or multiple links (InterLink
|
|
205
|
-
* connections).
|
|
165
|
+
* List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).
|
|
206
166
|
*
|
|
207
167
|
* @param request - The request {@link ListRoutingPoliciesRequest}
|
|
208
168
|
* @returns A Promise of ListRoutingPoliciesResponse
|
|
@@ -212,35 +172,28 @@ export declare class API extends ParentAPI {
|
|
|
212
172
|
[Symbol.asyncIterator]: () => AsyncGenerator<RoutingPolicy[], void, void>;
|
|
213
173
|
};
|
|
214
174
|
/**
|
|
215
|
-
* Get routing policy. Get a routing policy for the given routing policy ID.
|
|
216
|
-
* The response object gives information including the policy's name, tags and
|
|
217
|
-
* prefix filters.
|
|
175
|
+
* Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.
|
|
218
176
|
*
|
|
219
177
|
* @param request - The request {@link GetRoutingPolicyRequest}
|
|
220
178
|
* @returns A Promise of RoutingPolicy
|
|
221
179
|
*/
|
|
222
180
|
getRoutingPolicy: (request: Readonly<GetRoutingPolicyRequest>) => Promise<RoutingPolicy>;
|
|
223
181
|
/**
|
|
224
|
-
* Create a routing policy. Create a routing policy. Routing policies allow
|
|
225
|
-
* you to set IP prefix filters to define the incoming route announcements to
|
|
226
|
-
* accept from the peer, and the outgoing routes to announce to the peer.
|
|
182
|
+
* Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.
|
|
227
183
|
*
|
|
228
184
|
* @param request - The request {@link CreateRoutingPolicyRequest}
|
|
229
185
|
* @returns A Promise of RoutingPolicy
|
|
230
186
|
*/
|
|
231
187
|
createRoutingPolicy: (request: Readonly<CreateRoutingPolicyRequest>) => Promise<RoutingPolicy>;
|
|
232
188
|
/**
|
|
233
|
-
* Update a routing policy. Update an existing routing policy, specified by
|
|
234
|
-
* its routing policy ID. Its name, tags and incoming/outgoing prefix filters
|
|
235
|
-
* can be updated.
|
|
189
|
+
* Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.
|
|
236
190
|
*
|
|
237
191
|
* @param request - The request {@link UpdateRoutingPolicyRequest}
|
|
238
192
|
* @returns A Promise of RoutingPolicy
|
|
239
193
|
*/
|
|
240
194
|
updateRoutingPolicy: (request: Readonly<UpdateRoutingPolicyRequest>) => Promise<RoutingPolicy>;
|
|
241
195
|
/**
|
|
242
|
-
* Delete a routing policy. Delete an existing routing policy, specified by
|
|
243
|
-
* its routing policy ID.
|
|
196
|
+
* Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.
|
|
244
197
|
*
|
|
245
198
|
* @param request - The request {@link DeleteRoutingPolicyRequest}
|
|
246
199
|
*/
|
|
@@ -39,10 +39,7 @@ class API extends API$1 {
|
|
|
39
39
|
unmarshalListDedicatedConnectionsResponse
|
|
40
40
|
);
|
|
41
41
|
/**
|
|
42
|
-
* List dedicated connections. For self-hosted users, list their dedicated
|
|
43
|
-
* physical connections in a given region. By default, the connections
|
|
44
|
-
* returned in the list are ordered by name in ascending order, though this
|
|
45
|
-
* can be modified via the `order_by` field.
|
|
42
|
+
* List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
|
|
46
43
|
*
|
|
47
44
|
* @param request - The request {@link ListDedicatedConnectionsRequest}
|
|
48
45
|
* @returns A Promise of ListDedicatedConnectionsResponse
|
|
@@ -53,9 +50,7 @@ class API extends API$1 {
|
|
|
53
50
|
request
|
|
54
51
|
);
|
|
55
52
|
/**
|
|
56
|
-
* Get a dedicated connection. For self-hosted users, get a dedicated physical
|
|
57
|
-
* connection corresponding to the given ID. The response object includes
|
|
58
|
-
* information such as the connection's name, status and total bandwidth.
|
|
53
|
+
* Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth.
|
|
59
54
|
*
|
|
60
55
|
* @param request - The request {@link GetDedicatedConnectionRequest}
|
|
61
56
|
* @returns A Promise of DedicatedConnection
|
|
@@ -101,18 +96,14 @@ class API extends API$1 {
|
|
|
101
96
|
unmarshalListPartnersResponse
|
|
102
97
|
);
|
|
103
98
|
/**
|
|
104
|
-
* List available partners. List all available partners. By default, the
|
|
105
|
-
* partners returned in the list are ordered by name in ascending order,
|
|
106
|
-
* though this can be modified via the `order_by` field.
|
|
99
|
+
* List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field.
|
|
107
100
|
*
|
|
108
101
|
* @param request - The request {@link ListPartnersRequest}
|
|
109
102
|
* @returns A Promise of ListPartnersResponse
|
|
110
103
|
*/
|
|
111
104
|
listPartners = (request = {}) => enrichForPagination("partners", this.pageOfListPartners, request);
|
|
112
105
|
/**
|
|
113
|
-
* Get a partner. Get a partner for the given partner IP. The response object
|
|
114
|
-
* includes information such as the partner's name, email address and portal
|
|
115
|
-
* URL.
|
|
106
|
+
* Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL.
|
|
116
107
|
*
|
|
117
108
|
* @param request - The request {@link GetPartnerRequest}
|
|
118
109
|
* @returns A Promise of Partner
|
|
@@ -145,16 +136,14 @@ class API extends API$1 {
|
|
|
145
136
|
unmarshalListPopsResponse
|
|
146
137
|
);
|
|
147
138
|
/**
|
|
148
|
-
* List PoPs. List all available PoPs (locations) for a given region. By
|
|
149
|
-
* default, the results are returned in ascending alphabetical order by name.
|
|
139
|
+
* List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name.
|
|
150
140
|
*
|
|
151
141
|
* @param request - The request {@link ListPopsRequest}
|
|
152
142
|
* @returns A Promise of ListPopsResponse
|
|
153
143
|
*/
|
|
154
144
|
listPops = (request = {}) => enrichForPagination("pops", this.pageOfListPops, request);
|
|
155
145
|
/**
|
|
156
|
-
* Get a PoP. Get a PoP for the given PoP ID. The response object includes the
|
|
157
|
-
* PoP's name and information about its physical location.
|
|
146
|
+
* Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location.
|
|
158
147
|
*
|
|
159
148
|
* @param request - The request {@link GetPopRequest}
|
|
160
149
|
* @returns A Promise of Pop
|
|
@@ -197,17 +186,14 @@ class API extends API$1 {
|
|
|
197
186
|
unmarshalListLinksResponse
|
|
198
187
|
);
|
|
199
188
|
/**
|
|
200
|
-
* List links. List all your links (InterLink connections). A number of
|
|
201
|
-
* filters are available, including Project ID, name, tags and status.
|
|
189
|
+
* List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status.
|
|
202
190
|
*
|
|
203
191
|
* @param request - The request {@link ListLinksRequest}
|
|
204
192
|
* @returns A Promise of ListLinksResponse
|
|
205
193
|
*/
|
|
206
194
|
listLinks = (request = {}) => enrichForPagination("links", this.pageOfListLinks, request);
|
|
207
195
|
/**
|
|
208
|
-
* Get a link. Get a link (InterLink session / logical InterLink resource) for
|
|
209
|
-
* the given link ID. The response object includes information about the
|
|
210
|
-
* link's various configuration details.
|
|
196
|
+
* Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details.
|
|
211
197
|
*
|
|
212
198
|
* @param request - The request {@link GetLinkRequest}
|
|
213
199
|
* @returns A Promise of Link
|
|
@@ -235,11 +221,7 @@ class API extends API$1 {
|
|
|
235
221
|
options
|
|
236
222
|
);
|
|
237
223
|
/**
|
|
238
|
-
* Create a link. Create a link (InterLink session / logical InterLink
|
|
239
|
-
* resource) in a given PoP, specifying its various configuration details.
|
|
240
|
-
* Links can either be hosted (faciliated by partners' shared physical
|
|
241
|
-
* connections) or self-hosted (for users who have purchased a dedicated
|
|
242
|
-
* physical connection).
|
|
224
|
+
* Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection).
|
|
243
225
|
*
|
|
244
226
|
* @param request - The request {@link CreateLinkRequest}
|
|
245
227
|
* @returns A Promise of Link
|
|
@@ -256,8 +238,7 @@ class API extends API$1 {
|
|
|
256
238
|
unmarshalLink
|
|
257
239
|
);
|
|
258
240
|
/**
|
|
259
|
-
* Update a link. Update an existing link, specified by its link ID. Only its
|
|
260
|
-
* name and tags can be updated.
|
|
241
|
+
* Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated.
|
|
261
242
|
*
|
|
262
243
|
* @param request - The request {@link UpdateLinkRequest}
|
|
263
244
|
* @returns A Promise of Link
|
|
@@ -274,11 +255,7 @@ class API extends API$1 {
|
|
|
274
255
|
unmarshalLink
|
|
275
256
|
);
|
|
276
257
|
/**
|
|
277
|
-
* Delete a link. Delete an existing link, specified by its link ID. Note that
|
|
278
|
-
* as well as deleting the link here on the Scaleway side, it is also
|
|
279
|
-
* necessary to request deletion from the partner on their side. Only when
|
|
280
|
-
* this action has been carried out on both sides will the resource be
|
|
281
|
-
* completely deleted.
|
|
258
|
+
* Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted.
|
|
282
259
|
*
|
|
283
260
|
* @param request - The request {@link DeleteLinkRequest}
|
|
284
261
|
* @returns A Promise of Link
|
|
@@ -291,9 +268,7 @@ class API extends API$1 {
|
|
|
291
268
|
unmarshalLink
|
|
292
269
|
);
|
|
293
270
|
/**
|
|
294
|
-
* Attach a VPC. Attach a VPC to an existing link. This facilitates
|
|
295
|
-
* communication between the resources in your Scaleway VPC, and your
|
|
296
|
-
* on-premises infrastructure.
|
|
271
|
+
* Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure.
|
|
297
272
|
*
|
|
298
273
|
* @param request - The request {@link AttachVpcRequest}
|
|
299
274
|
* @returns A Promise of Link
|
|
@@ -325,10 +300,7 @@ class API extends API$1 {
|
|
|
325
300
|
unmarshalLink
|
|
326
301
|
);
|
|
327
302
|
/**
|
|
328
|
-
* Attach a routing policy. Attach a routing policy to an existing link. As
|
|
329
|
-
* all routes across the link are blocked by default, you must attach a
|
|
330
|
-
* routing policy to set IP prefix filters for allowed routes, facilitating
|
|
331
|
-
* traffic flow.
|
|
303
|
+
* Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow.
|
|
332
304
|
*
|
|
333
305
|
* @param request - The request {@link AttachRoutingPolicyRequest}
|
|
334
306
|
* @returns A Promise of Link
|
|
@@ -345,9 +317,7 @@ class API extends API$1 {
|
|
|
345
317
|
unmarshalLink
|
|
346
318
|
);
|
|
347
319
|
/**
|
|
348
|
-
* Detach a routing policy. Detach a routing policy from an existing link.
|
|
349
|
-
* Without a routing policy, all routes across the link are blocked by
|
|
350
|
-
* default.
|
|
320
|
+
* Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default.
|
|
351
321
|
*
|
|
352
322
|
* @param request - The request {@link DetachRoutingPolicyRequest}
|
|
353
323
|
* @returns A Promise of Link
|
|
@@ -362,12 +332,7 @@ class API extends API$1 {
|
|
|
362
332
|
unmarshalLink
|
|
363
333
|
);
|
|
364
334
|
/**
|
|
365
|
-
* Enable route propagation. Enable all allowed prefixes (defined in a routing
|
|
366
|
-
* policy) to be announced in the BGP session. This allows traffic to flow
|
|
367
|
-
* between the attached VPC and the on-premises infrastructure along the
|
|
368
|
-
* announced routes. Note that by default, even when route propagation is
|
|
369
|
-
* enabled, all routes are blocked. It is essential to attach a routing policy
|
|
370
|
-
* to define the ranges of routes to announce.
|
|
335
|
+
* Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce.
|
|
371
336
|
*
|
|
372
337
|
* @param request - The request {@link EnableRoutePropagationRequest}
|
|
373
338
|
* @returns A Promise of Link
|
|
@@ -382,9 +347,7 @@ class API extends API$1 {
|
|
|
382
347
|
unmarshalLink
|
|
383
348
|
);
|
|
384
349
|
/**
|
|
385
|
-
* Disable route propagation. Prevent any prefixes from being announced in the
|
|
386
|
-
* BGP session. Traffic will not be able to flow over the InterLink until
|
|
387
|
-
* route propagation is re-enabled.
|
|
350
|
+
* Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled.
|
|
388
351
|
*
|
|
389
352
|
* @param request - The request {@link DisableRoutePropagationRequest}
|
|
390
353
|
* @returns A Promise of Link
|
|
@@ -418,9 +381,7 @@ class API extends API$1 {
|
|
|
418
381
|
unmarshalListRoutingPoliciesResponse
|
|
419
382
|
);
|
|
420
383
|
/**
|
|
421
|
-
* List routing policies. List all routing policies in a given region. A
|
|
422
|
-
* routing policy can be attached to one or multiple links (InterLink
|
|
423
|
-
* connections).
|
|
384
|
+
* List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections).
|
|
424
385
|
*
|
|
425
386
|
* @param request - The request {@link ListRoutingPoliciesRequest}
|
|
426
387
|
* @returns A Promise of ListRoutingPoliciesResponse
|
|
@@ -431,9 +392,7 @@ class API extends API$1 {
|
|
|
431
392
|
request
|
|
432
393
|
);
|
|
433
394
|
/**
|
|
434
|
-
* Get routing policy. Get a routing policy for the given routing policy ID.
|
|
435
|
-
* The response object gives information including the policy's name, tags and
|
|
436
|
-
* prefix filters.
|
|
395
|
+
* Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters.
|
|
437
396
|
*
|
|
438
397
|
* @param request - The request {@link GetRoutingPolicyRequest}
|
|
439
398
|
* @returns A Promise of RoutingPolicy
|
|
@@ -446,9 +405,7 @@ class API extends API$1 {
|
|
|
446
405
|
unmarshalRoutingPolicy
|
|
447
406
|
);
|
|
448
407
|
/**
|
|
449
|
-
* Create a routing policy. Create a routing policy. Routing policies allow
|
|
450
|
-
* you to set IP prefix filters to define the incoming route announcements to
|
|
451
|
-
* accept from the peer, and the outgoing routes to announce to the peer.
|
|
408
|
+
* Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer.
|
|
452
409
|
*
|
|
453
410
|
* @param request - The request {@link CreateRoutingPolicyRequest}
|
|
454
411
|
* @returns A Promise of RoutingPolicy
|
|
@@ -465,9 +422,7 @@ class API extends API$1 {
|
|
|
465
422
|
unmarshalRoutingPolicy
|
|
466
423
|
);
|
|
467
424
|
/**
|
|
468
|
-
* Update a routing policy. Update an existing routing policy, specified by
|
|
469
|
-
* its routing policy ID. Its name, tags and incoming/outgoing prefix filters
|
|
470
|
-
* can be updated.
|
|
425
|
+
* Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated.
|
|
471
426
|
*
|
|
472
427
|
* @param request - The request {@link UpdateRoutingPolicyRequest}
|
|
473
428
|
* @returns A Promise of RoutingPolicy
|
|
@@ -484,8 +439,7 @@ class API extends API$1 {
|
|
|
484
439
|
unmarshalRoutingPolicy
|
|
485
440
|
);
|
|
486
441
|
/**
|
|
487
|
-
* Delete a routing policy. Delete an existing routing policy, specified by
|
|
488
|
-
* its routing policy ID.
|
|
442
|
+
* Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID.
|
|
489
443
|
*
|
|
490
444
|
* @param request - The request {@link DeleteRoutingPolicyRequest}
|
|
491
445
|
*/
|
|
@@ -212,6 +212,7 @@ const marshalAttachVpcRequest = (request, defaults) => ({
|
|
|
212
212
|
const marshalCreateLinkRequest = (request, defaults) => ({
|
|
213
213
|
bandwidth_mbps: request.bandwidthMbps,
|
|
214
214
|
name: request.name,
|
|
215
|
+
peer_asn: request.peerAsn,
|
|
215
216
|
pop_id: request.popId,
|
|
216
217
|
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
217
218
|
tags: request.tags,
|
|
@@ -229,6 +230,7 @@ const marshalCreateRoutingPolicyRequest = (request, defaults) => ({
|
|
|
229
230
|
});
|
|
230
231
|
const marshalUpdateLinkRequest = (request, defaults) => ({
|
|
231
232
|
name: request.name,
|
|
233
|
+
peer_asn: request.peerAsn,
|
|
232
234
|
tags: request.tags
|
|
233
235
|
});
|
|
234
236
|
const marshalUpdateRoutingPolicyRequest = (request, defaults) => ({
|
|
@@ -210,6 +210,7 @@ const marshalAttachVpcRequest = (request, defaults) => ({
|
|
|
210
210
|
const marshalCreateLinkRequest = (request, defaults) => ({
|
|
211
211
|
bandwidth_mbps: request.bandwidthMbps,
|
|
212
212
|
name: request.name,
|
|
213
|
+
peer_asn: request.peerAsn,
|
|
213
214
|
pop_id: request.popId,
|
|
214
215
|
project_id: request.projectId ?? defaults.defaultProjectId,
|
|
215
216
|
tags: request.tags,
|
|
@@ -227,6 +228,7 @@ const marshalCreateRoutingPolicyRequest = (request, defaults) => ({
|
|
|
227
228
|
});
|
|
228
229
|
const marshalUpdateLinkRequest = (request, defaults) => ({
|
|
229
230
|
name: request.name,
|
|
231
|
+
peer_asn: request.peerAsn,
|
|
230
232
|
tags: request.tags
|
|
231
233
|
});
|
|
232
234
|
const marshalUpdateRoutingPolicyRequest = (request, defaults) => ({
|