@aws-sdk/client-evs 3.824.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/LICENSE +201 -0
- package/README.md +293 -0
- package/dist-cjs/Evs.js +33 -0
- package/dist-cjs/EvsClient.js +52 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateEnvironmentCommand.js +26 -0
- package/dist-cjs/commands/CreateEnvironmentHostCommand.js +26 -0
- package/dist-cjs/commands/DeleteEnvironmentCommand.js +26 -0
- package/dist-cjs/commands/DeleteEnvironmentHostCommand.js +26 -0
- package/dist-cjs/commands/GetEnvironmentCommand.js +26 -0
- package/dist-cjs/commands/ListEnvironmentHostsCommand.js +26 -0
- package/dist-cjs/commands/ListEnvironmentVlansCommand.js +26 -0
- package/dist-cjs/commands/ListEnvironmentsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/endpoint/EndpointParameters.js +17 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/EvsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +126 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListEnvironmentHostsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEnvironmentVlansPaginator.js +7 -0
- package/dist-cjs/pagination/ListEnvironmentsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_json1_0.js +536 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +56 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +13 -0
- package/dist-es/Evs.js +29 -0
- package/dist-es/EvsClient.js +48 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateEnvironmentCommand.js +22 -0
- package/dist-es/commands/CreateEnvironmentHostCommand.js +22 -0
- package/dist-es/commands/DeleteEnvironmentCommand.js +22 -0
- package/dist-es/commands/DeleteEnvironmentHostCommand.js +22 -0
- package/dist-es/commands/GetEnvironmentCommand.js +22 -0
- package/dist-es/commands/ListEnvironmentHostsCommand.js +22 -0
- package/dist-es/commands/ListEnvironmentVlansCommand.js +22 -0
- package/dist-es/commands/ListEnvironmentsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/endpoint/EndpointParameters.js +13 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/EvsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +118 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListEnvironmentHostsPaginator.js +4 -0
- package/dist-es/pagination/ListEnvironmentVlansPaginator.js +4 -0
- package/dist-es/pagination/ListEnvironmentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_0.js +511 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +51 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-types/Evs.d.ts +88 -0
- package/dist-types/EvsClient.d.ts +198 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +197 -0
- package/dist-types/commands/CreateEnvironmentHostCommand.d.ts +113 -0
- package/dist-types/commands/DeleteEnvironmentCommand.d.ts +133 -0
- package/dist-types/commands/DeleteEnvironmentHostCommand.d.ts +107 -0
- package/dist-types/commands/GetEnvironmentCommand.d.ts +132 -0
- package/dist-types/commands/ListEnvironmentHostsCommand.d.ts +100 -0
- package/dist-types/commands/ListEnvironmentVlansCommand.d.ts +93 -0
- package/dist-types/commands/ListEnvironmentsCommand.d.ts +91 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +77 -0
- package/dist-types/commands/TagResourceCommand.d.ts +82 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +79 -0
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +38 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/EvsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1083 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListEnvironmentHostsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEnvironmentVlansPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEnvironmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +101 -0
- package/dist-types/runtimeConfig.browser.d.ts +50 -0
- package/dist-types/runtimeConfig.d.ts +50 -0
- package/dist-types/runtimeConfig.native.d.ts +49 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/Evs.d.ts +193 -0
- package/dist-types/ts3.4/EvsClient.d.ts +182 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +46 -0
- package/dist-types/ts3.4/commands/CreateEnvironmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateEnvironmentHostCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteEnvironmentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteEnvironmentHostCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetEnvironmentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListEnvironmentHostsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEnvironmentVlansCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListEnvironmentsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +48 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/EvsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +306 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListEnvironmentHostsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEnvironmentVlansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEnvironmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +137 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +90 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +94 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/package.json +101 -0
|
@@ -0,0 +1,1083 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { EvsServiceException as __BaseException } from "./EvsServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.</p>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface ConnectivityInfo {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The unique IDs for private route server peers.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
privateRouteServerPeerings: string[] | undefined;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
* @enum
|
|
17
|
+
*/
|
|
18
|
+
export declare const _InstanceType: {
|
|
19
|
+
readonly I4I_METAL: "i4i.metal";
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
|
|
25
|
+
/**
|
|
26
|
+
* <p>An object that represents a host.</p> <note> <p>You cannot use <code>dedicatedHostId</code> and <code>placementGroupId</code> together in the same <code>HostInfoForCreate</code>object. This results in a <code>ValidationException</code> response.</p> </note>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export interface HostInfoForCreate {
|
|
30
|
+
/**
|
|
31
|
+
* <p>The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
hostName: string | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>The name of the SSH key that is used to access the host.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
keyName: string | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The EC2 instance type that represents the host.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
instanceType: _InstanceType | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The unique ID of the placement group where the host is placed.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
placementGroupId?: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The unique ID of the Amazon EC2 Dedicated Host.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
dedicatedHostId?: string | undefined;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* <p>An object that represents an initial VLAN subnet for the environment. Amazon EVS creates initial VLAN subnets when you first create the environment. You must specify a non-overlapping CIDR block for each VLAN subnet. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export interface InitialVlanInfo {
|
|
61
|
+
/**
|
|
62
|
+
* <p> The CIDR block that you provide to create a VLAN subnet. VLAN CIDR blocks must not overlap with other subnets in the VPC.</p>
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
cidr: string | undefined;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* <p>The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export interface InitialVlans {
|
|
72
|
+
/**
|
|
73
|
+
* <p> The VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
vmkManagement: InitialVlanInfo | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
vmManagement: InitialVlanInfo | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p> The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
vMotion: InitialVlanInfo | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p> The vSAN VLAN subnet. This VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
vSan: InitialVlanInfo | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <p> The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
vTep: InitialVlanInfo | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* <p>The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
edgeVTep: InitialVlanInfo | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* <p> The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
nsxUplink: InitialVlanInfo | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* <p>The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.</p>
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
hcx: InitialVlanInfo | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* <p>An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.</p>
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
expansionVlan1: InitialVlanInfo | undefined;
|
|
117
|
+
/**
|
|
118
|
+
* <p>An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
expansionVlan2: InitialVlanInfo | undefined;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* <p> The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
export interface LicenseInfo {
|
|
128
|
+
/**
|
|
129
|
+
* <p> The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
solutionKey: string | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* <p> The VSAN license key. This license unlocks vSAN features.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
vsanKey: string | undefined;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* <p>The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
export interface ServiceAccessSecurityGroups {
|
|
144
|
+
/**
|
|
145
|
+
* <p>The security groups that allow service access.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
securityGroups?: string[] | undefined;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* <p>The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be unique, and resolve to a domain name that you've registered in your DNS service of choice. Hostnames cannot be changed.</p> <p>VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export interface VcfHostnames {
|
|
155
|
+
/**
|
|
156
|
+
* <p>The VMware vCenter hostname.</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
vCenter: string | undefined;
|
|
160
|
+
/**
|
|
161
|
+
* <p>The VMware NSX hostname.</p>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
nsx: string | undefined;
|
|
165
|
+
/**
|
|
166
|
+
* <p>The hostname for the first VMware NSX Manager virtual machine (VM).</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
nsxManager1: string | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The hostname for the second VMware NSX Manager virtual machine (VM).</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
nsxManager2: string | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* <p>The hostname for the third VMware NSX Manager virtual machine (VM).</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
nsxManager3: string | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* <p>The hostname for the first NSX Edge node.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
nsxEdge1: string | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* <p>The hostname for the second NSX Edge node.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
nsxEdge2: string | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* <p>The hostname for SDDC Manager.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
sddcManager: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* <p>The hostname for VMware Cloud Builder.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
cloudBuilder: string | undefined;
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* @public
|
|
203
|
+
* @enum
|
|
204
|
+
*/
|
|
205
|
+
export declare const VcfVersion: {
|
|
206
|
+
readonly VCF_5_2_1: "VCF-5.2.1";
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
export type VcfVersion = (typeof VcfVersion)[keyof typeof VcfVersion];
|
|
212
|
+
/**
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
export interface CreateEnvironmentRequest {
|
|
216
|
+
/**
|
|
217
|
+
* <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
clientToken?: string | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* <p>The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.</p>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
environmentName?: string | undefined;
|
|
226
|
+
/**
|
|
227
|
+
* <p>A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
kmsKeyId?: string | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* <p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
tags?: Record<string, string> | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.</p> <p>The security group should allow access to the following.</p> <ul> <li> <p>TCP/UDP access to the DNS servers</p> </li> <li> <p>HTTPS/SSH access to the host management VLAN subnet</p> </li> <li> <p>HTTPS/SSH access to the Management VM VLAN subnet</p> </li> </ul> <p>You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
serviceAccessSecurityGroups?: ServiceAccessSecurityGroups | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* <p>A unique ID for the VPC that connects to the environment control plane for service access.</p> <p>Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.</p> <p>The VPC that you select must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts.</p> <p>If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.</p> <p>Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.</p>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
vpcId: string | undefined;
|
|
246
|
+
/**
|
|
247
|
+
* <p>The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to validate mandatory DNS records for your VCF appliances and hosts and create the environment.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
serviceAccessSubnetId: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p> The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
vcfVersion: VcfVersion | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
termsAccepted: boolean | undefined;
|
|
261
|
+
/**
|
|
262
|
+
* <p>The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.</p> <p>VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.</p> <p>VCF license information can be retrieved from the Broadcom portal.</p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
licenseInfo: LicenseInfo[] | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* <p>The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
initialVlans: InitialVlans | undefined;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.</p> <p>For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
hosts: HostInfoForCreate[] | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* <p> The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX, providing BGP dynamic routing for overlay networks.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
connectivityInfo: ConnectivityInfo | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <p>The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
vcfHostnames: VcfHostnames | undefined;
|
|
286
|
+
/**
|
|
287
|
+
* <p>The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
siteId: string | undefined;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* @public
|
|
294
|
+
* @enum
|
|
295
|
+
*/
|
|
296
|
+
export declare const CheckResult: {
|
|
297
|
+
readonly FAILED: "FAILED";
|
|
298
|
+
readonly PASSED: "PASSED";
|
|
299
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
export type CheckResult = (typeof CheckResult)[keyof typeof CheckResult];
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
* @enum
|
|
308
|
+
*/
|
|
309
|
+
export declare const CheckType: {
|
|
310
|
+
readonly HOST_COUNT: "HOST_COUNT";
|
|
311
|
+
readonly KEY_COVERAGE: "KEY_COVERAGE";
|
|
312
|
+
readonly KEY_REUSE: "KEY_REUSE";
|
|
313
|
+
readonly REACHABILITY: "REACHABILITY";
|
|
314
|
+
};
|
|
315
|
+
/**
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
export type CheckType = (typeof CheckType)[keyof typeof CheckType];
|
|
319
|
+
/**
|
|
320
|
+
* <p>A check on the environment to identify environment health and validate VMware VCF licensing compliance.</p>
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
export interface Check {
|
|
324
|
+
/**
|
|
325
|
+
* <p>The check type. Amazon EVS performs the following checks.</p> <ul> <li> <p> <code>KEY_REUSE</code>: checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.</p> </li> <li> <p> <code>KEY_COVERAGE</code>: checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.</p> </li> <li> <p> <code>REACHABILITY</code>: checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.</p> </li> <li> <p> <code>HOST_COUNT</code>: Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.</p> <p>If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.</p> </li> </ul>
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
type?: CheckType | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* <p> The check result.</p>
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
result?: CheckResult | undefined;
|
|
334
|
+
/**
|
|
335
|
+
* <p>The time when environment health began to be impaired.</p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
impairedSince?: Date | undefined;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* <p>A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export interface Secret {
|
|
345
|
+
/**
|
|
346
|
+
* <p> The Amazon Resource Name (ARN) of the secret.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
secretArn?: string | undefined;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* @public
|
|
353
|
+
* @enum
|
|
354
|
+
*/
|
|
355
|
+
export declare const EnvironmentState: {
|
|
356
|
+
readonly CREATED: "CREATED";
|
|
357
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
358
|
+
readonly CREATING: "CREATING";
|
|
359
|
+
readonly DELETED: "DELETED";
|
|
360
|
+
readonly DELETING: "DELETING";
|
|
361
|
+
};
|
|
362
|
+
/**
|
|
363
|
+
* @public
|
|
364
|
+
*/
|
|
365
|
+
export type EnvironmentState = (typeof EnvironmentState)[keyof typeof EnvironmentState];
|
|
366
|
+
/**
|
|
367
|
+
* <p>An object that represents an Amazon EVS environment.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
export interface Environment {
|
|
371
|
+
/**
|
|
372
|
+
* <p>The unique ID for the environment.</p>
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
375
|
+
environmentId?: string | undefined;
|
|
376
|
+
/**
|
|
377
|
+
* <p>The state of an environment.</p>
|
|
378
|
+
* @public
|
|
379
|
+
*/
|
|
380
|
+
environmentState?: EnvironmentState | undefined;
|
|
381
|
+
/**
|
|
382
|
+
* <p>A detailed description of the <code>environmentState</code> of an environment.</p>
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
stateDetails?: string | undefined;
|
|
386
|
+
/**
|
|
387
|
+
* <p>The date and time that the environment was created.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
createdAt?: Date | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* <p> The date and time that the environment was modified.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
modifiedAt?: Date | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>The Amazon Resource Name (ARN) that is associated with the environment.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
environmentArn?: string | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>The name of the environment.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
environmentName?: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The VPC associated with the environment.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
vpcId?: string | undefined;
|
|
411
|
+
/**
|
|
412
|
+
* <p> The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.</p>
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
serviceAccessSubnetId?: string | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* <p>The VCF version of the environment.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
vcfVersion?: VcfVersion | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* <p>Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
termsAccepted?: boolean | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p> The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
licenseInfo?: LicenseInfo[] | undefined;
|
|
431
|
+
/**
|
|
432
|
+
* <p>The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
siteId?: string | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* <p>Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
environmentStatus?: CheckResult | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>A check on the environment to identify instance health and VMware VCF licensing issues.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
checks?: Check[] | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.</p>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
connectivityInfo?: ConnectivityInfo | undefined;
|
|
451
|
+
/**
|
|
452
|
+
* <p>The DNS hostnames to be used by the VCF management appliances in your environment.</p> <p>For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.</p>
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
vcfHostnames?: VcfHostnames | undefined;
|
|
456
|
+
/**
|
|
457
|
+
* <p>The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.</p> <p>By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key <code>aws/secretsmanager</code>. You can also specify a customer managed key.</p>
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
kmsKeyId?: string | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* <p>The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.</p>
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
serviceAccessSecurityGroups?: ServiceAccessSecurityGroups | undefined;
|
|
466
|
+
/**
|
|
467
|
+
* <p>The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.</p> <p>Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.</p>
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
credentials?: Secret[] | undefined;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
export interface CreateEnvironmentResponse {
|
|
476
|
+
/**
|
|
477
|
+
* <p>A description of the created environment.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
environment?: Environment | undefined;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* <p>Stores information about a field passed inside a request that resulted in an exception.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
export interface ValidationExceptionField {
|
|
487
|
+
/**
|
|
488
|
+
* <p> The field name.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
name: string | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p> A message describing why the field failed validation.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
message: string | undefined;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* @public
|
|
500
|
+
* @enum
|
|
501
|
+
*/
|
|
502
|
+
export declare const ValidationExceptionReason: {
|
|
503
|
+
readonly CANNOT_PARSE: "cannotParse";
|
|
504
|
+
readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
|
|
505
|
+
readonly OTHER: "other";
|
|
506
|
+
readonly UNKNOWN_OPERATION: "unknownOperation";
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
512
|
+
/**
|
|
513
|
+
* <p>The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.</p>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
export declare class ValidationException extends __BaseException {
|
|
517
|
+
readonly name: "ValidationException";
|
|
518
|
+
readonly $fault: "client";
|
|
519
|
+
/**
|
|
520
|
+
* <p>The reason for the exception.</p>
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
reason: ValidationExceptionReason | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* <p>A list of fields that didn't validate.</p>
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
fieldList?: ValidationExceptionField[] | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* @internal
|
|
531
|
+
*/
|
|
532
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
533
|
+
}
|
|
534
|
+
/**
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
export interface CreateEnvironmentHostRequest {
|
|
538
|
+
/**
|
|
539
|
+
* <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the host creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
clientToken?: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>A unique ID for the environment that the host is added to.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
environmentId: string | undefined;
|
|
548
|
+
/**
|
|
549
|
+
* <p>The host that is created and added to the environment.</p>
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
host: HostInfoForCreate | undefined;
|
|
553
|
+
}
|
|
554
|
+
/**
|
|
555
|
+
* <p>A list of environments with summarized environment details.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
export interface EnvironmentSummary {
|
|
559
|
+
/**
|
|
560
|
+
* <p>A unique ID for the environment.</p>
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
environmentId?: string | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* <p> The name of the environment.</p>
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
environmentName?: string | undefined;
|
|
569
|
+
/**
|
|
570
|
+
* <p>The VCF version of the environment.</p>
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
vcfVersion?: VcfVersion | undefined;
|
|
574
|
+
/**
|
|
575
|
+
* <p>Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.</p>
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
environmentStatus?: CheckResult | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* <p>The state of an environment.</p>
|
|
581
|
+
* @public
|
|
582
|
+
*/
|
|
583
|
+
environmentState?: EnvironmentState | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* <p> The date and time that the environment was created.</p>
|
|
586
|
+
* @public
|
|
587
|
+
*/
|
|
588
|
+
createdAt?: Date | undefined;
|
|
589
|
+
/**
|
|
590
|
+
* <p> The date and time that the environment was modified.</p>
|
|
591
|
+
* @public
|
|
592
|
+
*/
|
|
593
|
+
modifiedAt?: Date | undefined;
|
|
594
|
+
/**
|
|
595
|
+
* <p>The Amazon Resource Name (ARN) that is associated with the environment.</p>
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
environmentArn?: string | undefined;
|
|
599
|
+
}
|
|
600
|
+
/**
|
|
601
|
+
* @public
|
|
602
|
+
* @enum
|
|
603
|
+
*/
|
|
604
|
+
export declare const HostState: {
|
|
605
|
+
readonly CREATED: "CREATED";
|
|
606
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
607
|
+
readonly CREATING: "CREATING";
|
|
608
|
+
readonly DELETED: "DELETED";
|
|
609
|
+
readonly DELETING: "DELETING";
|
|
610
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
611
|
+
readonly UPDATING: "UPDATING";
|
|
612
|
+
};
|
|
613
|
+
/**
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
export type HostState = (typeof HostState)[keyof typeof HostState];
|
|
617
|
+
/**
|
|
618
|
+
* <p>An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
export interface NetworkInterface {
|
|
622
|
+
/**
|
|
623
|
+
* <p>The unique ID of the elastic network interface.</p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
networkInterfaceId?: string | undefined;
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* <p>An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the <code>CreateEnvironmentHost</code> operation. Amazon EVS supports 4-16 hosts per environment.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
export interface Host {
|
|
633
|
+
/**
|
|
634
|
+
* <p>The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.</p>
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
hostName?: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* <p>The IP address of the host.</p>
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
ipAddress?: string | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* <p>The name of the SSH key that is used to access the host.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
keyName?: string | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* <p>The EC2 instance type of the host.</p> <note> <p>EC2 instances created through Amazon EVS do not support associating an IAM instance profile.</p> </note>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
instanceType?: _InstanceType | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* <p>The unique ID of the placement group where the host is placed.</p>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
placementGroupId?: string | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* <p>The unique ID of the Amazon EC2 Dedicated Host.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
dedicatedHostId?: string | undefined;
|
|
663
|
+
/**
|
|
664
|
+
* <p> The date and time that the host was created.</p>
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
createdAt?: Date | undefined;
|
|
668
|
+
/**
|
|
669
|
+
* <p> The date and time that the host was modified.</p>
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
modifiedAt?: Date | undefined;
|
|
673
|
+
/**
|
|
674
|
+
* <p> The state of the host.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
hostState?: HostState | undefined;
|
|
678
|
+
/**
|
|
679
|
+
* <p> A detailed description of the <code>hostState</code> of a host.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
stateDetails?: string | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* <p>The unique ID of the EC2 instance that represents the host.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
ec2InstanceId?: string | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>The elastic network interfaces that are attached to the host.</p>
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
networkInterfaces?: NetworkInterface[] | undefined;
|
|
693
|
+
}
|
|
694
|
+
/**
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
export interface CreateEnvironmentHostResponse {
|
|
698
|
+
/**
|
|
699
|
+
* <p>A summary of the environment that the host is created in.</p>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
environmentSummary?: EnvironmentSummary | undefined;
|
|
703
|
+
/**
|
|
704
|
+
* <p>A description of the created host.</p>
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
host?: Host | undefined;
|
|
708
|
+
}
|
|
709
|
+
/**
|
|
710
|
+
* <p>The <code>CreateEnvironmentHost</code> operation couldn't be performed because the service is throttling requests. This exception is thrown when the <code>CreateEnvironmentHost</code> request exceeds concurrency of 1 transaction per second (TPS).</p>
|
|
711
|
+
* @public
|
|
712
|
+
*/
|
|
713
|
+
export declare class ThrottlingException extends __BaseException {
|
|
714
|
+
readonly name: "ThrottlingException";
|
|
715
|
+
readonly $fault: "client";
|
|
716
|
+
$retryable: {};
|
|
717
|
+
/**
|
|
718
|
+
* <p>The seconds to wait to retry.</p>
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
retryAfterSeconds?: number | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* @internal
|
|
724
|
+
*/
|
|
725
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
export interface DeleteEnvironmentRequest {
|
|
731
|
+
/**
|
|
732
|
+
* <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
clientToken?: string | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* <p>A unique ID associated with the environment to be deleted.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
environmentId: string | undefined;
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
export interface DeleteEnvironmentResponse {
|
|
746
|
+
/**
|
|
747
|
+
* <p>A description of the deleted environment.</p>
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
environment?: Environment | undefined;
|
|
751
|
+
}
|
|
752
|
+
/**
|
|
753
|
+
* <p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
757
|
+
readonly name: "ResourceNotFoundException";
|
|
758
|
+
readonly $fault: "client";
|
|
759
|
+
/**
|
|
760
|
+
* <p>The ID of the resource that could not be found.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
resourceId: string | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p>The type of the resource that is associated with the error.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
resourceType: string | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* @internal
|
|
771
|
+
*/
|
|
772
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
export interface DeleteEnvironmentHostRequest {
|
|
778
|
+
/**
|
|
779
|
+
* <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the host deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
clientToken?: string | undefined;
|
|
783
|
+
/**
|
|
784
|
+
* <p>A unique ID for the host's environment.</p>
|
|
785
|
+
* @public
|
|
786
|
+
*/
|
|
787
|
+
environmentId: string | undefined;
|
|
788
|
+
/**
|
|
789
|
+
* <p>The DNS hostname associated with the host to be deleted.</p>
|
|
790
|
+
* @public
|
|
791
|
+
*/
|
|
792
|
+
hostName: string | undefined;
|
|
793
|
+
}
|
|
794
|
+
/**
|
|
795
|
+
* @public
|
|
796
|
+
*/
|
|
797
|
+
export interface DeleteEnvironmentHostResponse {
|
|
798
|
+
/**
|
|
799
|
+
* <p>A summary of the environment that the host was deleted from.</p>
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
environmentSummary?: EnvironmentSummary | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* <p>A description of the deleted host.</p>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
host?: Host | undefined;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* @public
|
|
811
|
+
*/
|
|
812
|
+
export interface GetEnvironmentRequest {
|
|
813
|
+
/**
|
|
814
|
+
* <p>A unique ID for the environment.</p>
|
|
815
|
+
* @public
|
|
816
|
+
*/
|
|
817
|
+
environmentId: string | undefined;
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
export interface GetEnvironmentResponse {
|
|
823
|
+
/**
|
|
824
|
+
* <p>A description of the requested environment.</p>
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
environment?: Environment | undefined;
|
|
828
|
+
}
|
|
829
|
+
/**
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
export interface ListEnvironmentHostsRequest {
|
|
833
|
+
/**
|
|
834
|
+
* <p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
nextToken?: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
maxResults?: number | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>A unique ID for the environment.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
environmentId: string | undefined;
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
export interface ListEnvironmentHostsResponse {
|
|
853
|
+
/**
|
|
854
|
+
* <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
nextToken?: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>A list of hosts in the environment.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
environmentHosts?: Host[] | undefined;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
export interface ListEnvironmentsRequest {
|
|
868
|
+
/**
|
|
869
|
+
* <p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
nextToken?: string | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
maxResults?: number | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The state of an environment. Used to filter response results to return only environments with the specified <code>environmentState</code>.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
state?: EnvironmentState[] | undefined;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
export interface ListEnvironmentsResponse {
|
|
888
|
+
/**
|
|
889
|
+
* <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
nextToken?: string | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* <p>A list of environments with summarized environment details.</p>
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
environmentSummaries?: EnvironmentSummary[] | undefined;
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
export interface ListEnvironmentVlansRequest {
|
|
903
|
+
/**
|
|
904
|
+
* <p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
nextToken?: string | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* <p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
maxResults?: number | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* <p>A unique ID for the environment.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
environmentId: string | undefined;
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* @public
|
|
921
|
+
* @enum
|
|
922
|
+
*/
|
|
923
|
+
export declare const VlanState: {
|
|
924
|
+
readonly CREATED: "CREATED";
|
|
925
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
926
|
+
readonly CREATING: "CREATING";
|
|
927
|
+
readonly DELETED: "DELETED";
|
|
928
|
+
readonly DELETING: "DELETING";
|
|
929
|
+
};
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
export type VlanState = (typeof VlanState)[keyof typeof VlanState];
|
|
934
|
+
/**
|
|
935
|
+
* <p>The VLANs that Amazon EVS creates during environment creation.</p>
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
export interface Vlan {
|
|
939
|
+
/**
|
|
940
|
+
* <p>The unique ID of the VLAN.</p>
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
vlanId?: number | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* <p> The CIDR block of the VLAN.</p>
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
cidr?: string | undefined;
|
|
949
|
+
/**
|
|
950
|
+
* <p>The availability zone of the VLAN.</p>
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
availabilityZone?: string | undefined;
|
|
954
|
+
/**
|
|
955
|
+
* <p>The VMware VCF traffic type that is carried over the VLAN. For example, a VLAN with a <code>functionName</code> of <code>hcx</code> is being used to carry VMware HCX traffic.</p>
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
functionName?: string | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* <p> The unique ID of the VLAN subnet.</p>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
subnetId?: string | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* <p>The date and time that the VLAN was created.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
createdAt?: Date | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* <p> The date and time that the VLAN was modified.</p>
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
modifiedAt?: Date | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* <p> The state of the VLAN.</p>
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
vlanState?: VlanState | undefined;
|
|
979
|
+
/**
|
|
980
|
+
* <p>The state details of the VLAN.</p>
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
stateDetails?: string | undefined;
|
|
984
|
+
}
|
|
985
|
+
/**
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
export interface ListEnvironmentVlansResponse {
|
|
989
|
+
/**
|
|
990
|
+
* <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
|
|
991
|
+
* @public
|
|
992
|
+
*/
|
|
993
|
+
nextToken?: string | undefined;
|
|
994
|
+
/**
|
|
995
|
+
* <p>A list of VLANs that are associated with the specified environment.</p>
|
|
996
|
+
* @public
|
|
997
|
+
*/
|
|
998
|
+
environmentVlans?: Vlan[] | undefined;
|
|
999
|
+
}
|
|
1000
|
+
/**
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
export interface ListTagsForResourceRequest {
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource to list tags for.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
resourceArn: string | undefined;
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
export interface ListTagsForResourceResponse {
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>The tags for the resource.</p>
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
tags?: Record<string, string> | undefined;
|
|
1019
|
+
}
|
|
1020
|
+
/**
|
|
1021
|
+
* <p>The request doesn't comply with IAM tag policy. Correct your request and then retry it.</p>
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
export declare class TagPolicyException extends __BaseException {
|
|
1025
|
+
readonly name: "TagPolicyException";
|
|
1026
|
+
readonly $fault: "client";
|
|
1027
|
+
/**
|
|
1028
|
+
* @internal
|
|
1029
|
+
*/
|
|
1030
|
+
constructor(opts: __ExceptionOptionType<TagPolicyException, __BaseException>);
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
export interface TagResourceRequest {
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
resourceArn: string | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other environment or Amazon Web Services resources.</p>
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
tags: Record<string, string> | undefined;
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
export interface TagResourceResponse {
|
|
1051
|
+
}
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>A service resource associated with the request has more than 200 tags.</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
export declare class TooManyTagsException extends __BaseException {
|
|
1057
|
+
readonly name: "TooManyTagsException";
|
|
1058
|
+
readonly $fault: "client";
|
|
1059
|
+
/**
|
|
1060
|
+
* @internal
|
|
1061
|
+
*/
|
|
1062
|
+
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
1063
|
+
}
|
|
1064
|
+
/**
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
export interface UntagResourceRequest {
|
|
1068
|
+
/**
|
|
1069
|
+
* <p>The Amazon Resource Name (ARN) of the resource to delete tags from.</p>
|
|
1070
|
+
* @public
|
|
1071
|
+
*/
|
|
1072
|
+
resourceArn: string | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* <p>The keys of the tags to delete.</p>
|
|
1075
|
+
* @public
|
|
1076
|
+
*/
|
|
1077
|
+
tagKeys: string[] | undefined;
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
export interface UntagResourceResponse {
|
|
1083
|
+
}
|