aws-sdk-evs 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-evs/client.rb +1392 -0
- data/lib/aws-sdk-evs/client_api.rb +523 -0
- data/lib/aws-sdk-evs/customizations.rb +0 -0
- data/lib/aws-sdk-evs/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-evs/endpoint_provider.rb +50 -0
- data/lib/aws-sdk-evs/endpoints.rb +20 -0
- data/lib/aws-sdk-evs/errors.rb +147 -0
- data/lib/aws-sdk-evs/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-evs/resource.rb +26 -0
- data/lib/aws-sdk-evs/types.rb +1376 -0
- data/lib/aws-sdk-evs/waiters.rb +15 -0
- data/lib/aws-sdk-evs.rb +62 -0
- data/sig/client.rbs +287 -0
- data/sig/errors.rbs +36 -0
- data/sig/resource.rbs +85 -0
- data/sig/types.rbs +324 -0
- data/sig/waiters.rbs +13 -0
- metadata +97 -0
@@ -0,0 +1,1376 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::Evs
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# A check on the environment to identify environment health and validate
|
14
|
+
# VMware VCF licensing compliance.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] type
|
17
|
+
# The check type. Amazon EVS performs the following checks.
|
18
|
+
#
|
19
|
+
# * `KEY_REUSE`: checks that the VCF license key is not used by
|
20
|
+
# another Amazon EVS environment. This check fails if a used license
|
21
|
+
# is added to the environment.
|
22
|
+
#
|
23
|
+
# * `KEY_COVERAGE`: checks that your VCF license key allocates
|
24
|
+
# sufficient vCPU cores for all deployed hosts. The check fails when
|
25
|
+
# any assigned hosts in the EVS environment are not covered by
|
26
|
+
# license keys, or when any unassigned hosts cannot be covered by
|
27
|
+
# available vCPU cores in keys.
|
28
|
+
#
|
29
|
+
# * `REACHABILITY`: checks that the Amazon EVS control plane has a
|
30
|
+
# persistent connection to SDDC Manager. If Amazon EVS cannot reach
|
31
|
+
# the environment, this check fails.
|
32
|
+
#
|
33
|
+
# * `HOST_COUNT`: Checks that your environment has a minimum of 4
|
34
|
+
# hosts, which is a requirement for VCF 5.2.1.
|
35
|
+
#
|
36
|
+
# If this check fails, you will need to add hosts so that your
|
37
|
+
# environment meets this minimum requirement. Amazon EVS only
|
38
|
+
# supports environments with 4-16 hosts.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @!attribute [rw] result
|
42
|
+
# The check result.
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] impaired_since
|
46
|
+
# The time when environment health began to be impaired.
|
47
|
+
# @return [Time]
|
48
|
+
#
|
49
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/Check AWS API Documentation
|
50
|
+
#
|
51
|
+
class Check < Struct.new(
|
52
|
+
:type,
|
53
|
+
:result,
|
54
|
+
:impaired_since)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
59
|
+
# The connectivity configuration for the environment. Amazon EVS
|
60
|
+
# requires that you specify two route server peer IDs. During
|
61
|
+
# environment creation, the route server endpoints peer with the NSX
|
62
|
+
# uplink VLAN for connectivity to the NSX overlay network.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] private_route_server_peerings
|
65
|
+
# The unique IDs for private route server peers.
|
66
|
+
# @return [Array<String>]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ConnectivityInfo AWS API Documentation
|
69
|
+
#
|
70
|
+
class ConnectivityInfo < Struct.new(
|
71
|
+
:private_route_server_peerings)
|
72
|
+
SENSITIVE = []
|
73
|
+
include Aws::Structure
|
74
|
+
end
|
75
|
+
|
76
|
+
# @!attribute [rw] client_token
|
77
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
78
|
+
# currently. If you supply
|
79
|
+
# input for this parameter, it will have no effect.
|
80
|
+
#
|
81
|
+
# </note>
|
82
|
+
#
|
83
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
84
|
+
# idempotency of the host creation request. If you do not specify a
|
85
|
+
# client token, a randomly generated token is used for the request to
|
86
|
+
# ensure idempotency.
|
87
|
+
#
|
88
|
+
# **A suitable default value is auto-generated.** You should normally
|
89
|
+
# not need to pass this option.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] environment_id
|
93
|
+
# A unique ID for the environment that the host is added to.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] host
|
97
|
+
# The host that is created and added to the environment.
|
98
|
+
# @return [Types::HostInfoForCreate]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEnvironmentHostRequest AWS API Documentation
|
101
|
+
#
|
102
|
+
class CreateEnvironmentHostRequest < Struct.new(
|
103
|
+
:client_token,
|
104
|
+
:environment_id,
|
105
|
+
:host)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# @!attribute [rw] environment_summary
|
111
|
+
# A summary of the environment that the host is created in.
|
112
|
+
# @return [Types::EnvironmentSummary]
|
113
|
+
#
|
114
|
+
# @!attribute [rw] host
|
115
|
+
# A description of the created host.
|
116
|
+
# @return [Types::Host]
|
117
|
+
#
|
118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEnvironmentHostResponse AWS API Documentation
|
119
|
+
#
|
120
|
+
class CreateEnvironmentHostResponse < Struct.new(
|
121
|
+
:environment_summary,
|
122
|
+
:host)
|
123
|
+
SENSITIVE = []
|
124
|
+
include Aws::Structure
|
125
|
+
end
|
126
|
+
|
127
|
+
# @!attribute [rw] client_token
|
128
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
129
|
+
# currently. If you supply
|
130
|
+
# input for this parameter, it will have no effect.
|
131
|
+
#
|
132
|
+
# </note>
|
133
|
+
#
|
134
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
135
|
+
# idempotency of the environment creation request. If you do not
|
136
|
+
# specify a client token, a randomly generated token is used for the
|
137
|
+
# request to ensure idempotency.
|
138
|
+
#
|
139
|
+
# **A suitable default value is auto-generated.** You should normally
|
140
|
+
# not need to pass this option.
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] environment_name
|
144
|
+
# The name to give to your environment. The name can contain only
|
145
|
+
# alphanumeric characters (case-sensitive), hyphens, and underscores.
|
146
|
+
# It must start with an alphanumeric character, and can't be longer
|
147
|
+
# than 100 characters. The name must be unique within the Amazon Web
|
148
|
+
# Services Region and Amazon Web Services account that you're
|
149
|
+
# creating the environment in.
|
150
|
+
# @return [String]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] kms_key_id
|
153
|
+
# A unique ID for the customer-managed KMS key that is used to encrypt
|
154
|
+
# the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter
|
155
|
+
# appliances. These credentials are stored in Amazon Web Services
|
156
|
+
# Secrets Manager.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] tags
|
160
|
+
# Metadata that assists with categorization and organization. Each tag
|
161
|
+
# consists of a key and an optional value. You define both. Tags
|
162
|
+
# don't propagate to any other cluster or Amazon Web Services
|
163
|
+
# resources.
|
164
|
+
# @return [Hash<String,String>]
|
165
|
+
#
|
166
|
+
# @!attribute [rw] service_access_security_groups
|
167
|
+
# The security group that controls communication between the Amazon
|
168
|
+
# EVS control plane and VPC. The default security group is used if a
|
169
|
+
# custom security group isn't specified.
|
170
|
+
#
|
171
|
+
# The security group should allow access to the following.
|
172
|
+
#
|
173
|
+
# * TCP/UDP access to the DNS servers
|
174
|
+
#
|
175
|
+
# * HTTPS/SSH access to the host management VLAN subnet
|
176
|
+
#
|
177
|
+
# * HTTPS/SSH access to the Management VM VLAN subnet
|
178
|
+
#
|
179
|
+
# You should avoid modifying the security group rules after
|
180
|
+
# deployment, as this can break the persistent connection between the
|
181
|
+
# Amazon EVS control plane and VPC. This can cause future environment
|
182
|
+
# actions like adding or removing hosts to fail.
|
183
|
+
# @return [Types::ServiceAccessSecurityGroups]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] vpc_id
|
186
|
+
# A unique ID for the VPC that connects to the environment control
|
187
|
+
# plane for service access.
|
188
|
+
#
|
189
|
+
# Amazon EVS requires that all VPC subnets exist in a single
|
190
|
+
# Availability Zone in a Region where the service is available.
|
191
|
+
#
|
192
|
+
# The VPC that you select must have a valid DHCP option set with
|
193
|
+
# domain name, at least two DNS servers, and an NTP server. These
|
194
|
+
# settings are used to configure your VCF appliances and hosts.
|
195
|
+
#
|
196
|
+
# If you plan to use HCX over the internet, choose a VPC that has a
|
197
|
+
# primary CIDR block and a /28 secondary CIDR block from an IPAM pool.
|
198
|
+
# Make sure that your VPC also has an attached internet gateway.
|
199
|
+
#
|
200
|
+
# Amazon EVS does not support the following Amazon Web Services
|
201
|
+
# networking options for NSX overlay connectivity: cross-Region VPC
|
202
|
+
# peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct
|
203
|
+
# Connect virtual private gateway associations.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @!attribute [rw] service_access_subnet_id
|
207
|
+
# The subnet that is used to establish connectivity between the Amazon
|
208
|
+
# EVS control plane and VPC. Amazon EVS uses this subnet to validate
|
209
|
+
# mandatory DNS records for your VCF appliances and hosts and create
|
210
|
+
# the environment.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] vcf_version
|
214
|
+
# The VCF version to use for the environment. Amazon EVS only supports
|
215
|
+
# VCF version 5.2.1 at this time.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] terms_accepted
|
219
|
+
# Customer confirmation that the customer has purchased and maintains
|
220
|
+
# sufficient VCF software licenses to cover all physical processor
|
221
|
+
# cores in the environment, in compliance with VMware's licensing
|
222
|
+
# requirements and terms of use.
|
223
|
+
# @return [Boolean]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] license_info
|
226
|
+
# The license information that Amazon EVS requires to create an
|
227
|
+
# environment. Amazon EVS requires two license keys: a VCF solution
|
228
|
+
# key and a vSAN license key. VCF licenses must have sufficient core
|
229
|
+
# entitlements to cover vCPU core and vSAN storage capacity needs.
|
230
|
+
#
|
231
|
+
# VCF licenses can be used for only one Amazon EVS environment. Amazon
|
232
|
+
# EVS does not support reuse of VCF licenses for multiple
|
233
|
+
# environments.
|
234
|
+
#
|
235
|
+
# VCF license information can be retrieved from the Broadcom portal.
|
236
|
+
# @return [Array<Types::LicenseInfo>]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] initial_vlans
|
239
|
+
# The initial VLAN subnets for the environment. You must specify a
|
240
|
+
# non-overlapping CIDR block for each VLAN subnet.
|
241
|
+
# @return [Types::InitialVlans]
|
242
|
+
#
|
243
|
+
# @!attribute [rw] hosts
|
244
|
+
# The ESXi hosts to add to the environment. Amazon EVS requires that
|
245
|
+
# you provide details for a minimum of 4 hosts during environment
|
246
|
+
# creation.
|
247
|
+
#
|
248
|
+
# For each host, you must provide the desired hostname, EC2 SSH key,
|
249
|
+
# and EC2 instance type. Optionally, you can also provide a partition
|
250
|
+
# or cluster placement group to use, or use Amazon EC2 Dedicated
|
251
|
+
# Hosts.
|
252
|
+
# @return [Array<Types::HostInfoForCreate>]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] connectivity_info
|
255
|
+
# The connectivity configuration for the environment. Amazon EVS
|
256
|
+
# requires that you specify two route server peer IDs. During
|
257
|
+
# environment creation, the route server endpoints peer with the NSX
|
258
|
+
# edges over the NSX, providing BGP dynamic routing for overlay
|
259
|
+
# networks.
|
260
|
+
# @return [Types::ConnectivityInfo]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] vcf_hostnames
|
263
|
+
# The DNS hostnames for the virtual machines that host the VCF
|
264
|
+
# management appliances. Amazon EVS requires that you provide DNS
|
265
|
+
# hostnames for the following appliances: vCenter, NSX Manager, SDDC
|
266
|
+
# Manager, and Cloud Builder.
|
267
|
+
# @return [Types::VcfHostnames]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] site_id
|
270
|
+
# The Broadcom Site ID that is allocated to you as part of your
|
271
|
+
# electronic software delivery. This ID allows customer access to the
|
272
|
+
# Broadcom portal, and is provided to you by Broadcom at the close of
|
273
|
+
# your software contract or contract renewal. Amazon EVS uses the
|
274
|
+
# Broadcom Site ID that you provide to meet Broadcom VCF license usage
|
275
|
+
# reporting requirements for Amazon EVS.
|
276
|
+
# @return [String]
|
277
|
+
#
|
278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEnvironmentRequest AWS API Documentation
|
279
|
+
#
|
280
|
+
class CreateEnvironmentRequest < Struct.new(
|
281
|
+
:client_token,
|
282
|
+
:environment_name,
|
283
|
+
:kms_key_id,
|
284
|
+
:tags,
|
285
|
+
:service_access_security_groups,
|
286
|
+
:vpc_id,
|
287
|
+
:service_access_subnet_id,
|
288
|
+
:vcf_version,
|
289
|
+
:terms_accepted,
|
290
|
+
:license_info,
|
291
|
+
:initial_vlans,
|
292
|
+
:hosts,
|
293
|
+
:connectivity_info,
|
294
|
+
:vcf_hostnames,
|
295
|
+
:site_id)
|
296
|
+
SENSITIVE = []
|
297
|
+
include Aws::Structure
|
298
|
+
end
|
299
|
+
|
300
|
+
# @!attribute [rw] environment
|
301
|
+
# A description of the created environment.
|
302
|
+
# @return [Types::Environment]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEnvironmentResponse AWS API Documentation
|
305
|
+
#
|
306
|
+
class CreateEnvironmentResponse < Struct.new(
|
307
|
+
:environment)
|
308
|
+
SENSITIVE = []
|
309
|
+
include Aws::Structure
|
310
|
+
end
|
311
|
+
|
312
|
+
# @!attribute [rw] client_token
|
313
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
314
|
+
# currently. If you supply
|
315
|
+
# input for this parameter, it will have no effect.
|
316
|
+
#
|
317
|
+
# </note>
|
318
|
+
#
|
319
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
320
|
+
# idempotency of the host deletion request. If you do not specify a
|
321
|
+
# client token, a randomly generated token is used for the request to
|
322
|
+
# ensure idempotency.
|
323
|
+
#
|
324
|
+
# **A suitable default value is auto-generated.** You should normally
|
325
|
+
# not need to pass this option.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] environment_id
|
329
|
+
# A unique ID for the host's environment.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] host_name
|
333
|
+
# The DNS hostname associated with the host to be deleted.
|
334
|
+
# @return [String]
|
335
|
+
#
|
336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEnvironmentHostRequest AWS API Documentation
|
337
|
+
#
|
338
|
+
class DeleteEnvironmentHostRequest < Struct.new(
|
339
|
+
:client_token,
|
340
|
+
:environment_id,
|
341
|
+
:host_name)
|
342
|
+
SENSITIVE = []
|
343
|
+
include Aws::Structure
|
344
|
+
end
|
345
|
+
|
346
|
+
# @!attribute [rw] environment_summary
|
347
|
+
# A summary of the environment that the host was deleted from.
|
348
|
+
# @return [Types::EnvironmentSummary]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] host
|
351
|
+
# A description of the deleted host.
|
352
|
+
# @return [Types::Host]
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEnvironmentHostResponse AWS API Documentation
|
355
|
+
#
|
356
|
+
class DeleteEnvironmentHostResponse < Struct.new(
|
357
|
+
:environment_summary,
|
358
|
+
:host)
|
359
|
+
SENSITIVE = []
|
360
|
+
include Aws::Structure
|
361
|
+
end
|
362
|
+
|
363
|
+
# @!attribute [rw] client_token
|
364
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
365
|
+
# currently. If you supply
|
366
|
+
# input for this parameter, it will have no effect.
|
367
|
+
#
|
368
|
+
# </note>
|
369
|
+
#
|
370
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
371
|
+
# idempotency of the environment deletion request. If you do not
|
372
|
+
# specify a client token, a randomly generated token is used for the
|
373
|
+
# request to ensure idempotency.
|
374
|
+
#
|
375
|
+
# **A suitable default value is auto-generated.** You should normally
|
376
|
+
# not need to pass this option.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] environment_id
|
380
|
+
# A unique ID associated with the environment to be deleted.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEnvironmentRequest AWS API Documentation
|
384
|
+
#
|
385
|
+
class DeleteEnvironmentRequest < Struct.new(
|
386
|
+
:client_token,
|
387
|
+
:environment_id)
|
388
|
+
SENSITIVE = []
|
389
|
+
include Aws::Structure
|
390
|
+
end
|
391
|
+
|
392
|
+
# @!attribute [rw] environment
|
393
|
+
# A description of the deleted environment.
|
394
|
+
# @return [Types::Environment]
|
395
|
+
#
|
396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEnvironmentResponse AWS API Documentation
|
397
|
+
#
|
398
|
+
class DeleteEnvironmentResponse < Struct.new(
|
399
|
+
:environment)
|
400
|
+
SENSITIVE = []
|
401
|
+
include Aws::Structure
|
402
|
+
end
|
403
|
+
|
404
|
+
# An object that represents an Amazon EVS environment.
|
405
|
+
#
|
406
|
+
# @!attribute [rw] environment_id
|
407
|
+
# The unique ID for the environment.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] environment_state
|
411
|
+
# The state of an environment.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] state_details
|
415
|
+
# A detailed description of the `environmentState` of an environment.
|
416
|
+
# @return [String]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] created_at
|
419
|
+
# The date and time that the environment was created.
|
420
|
+
# @return [Time]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] modified_at
|
423
|
+
# The date and time that the environment was modified.
|
424
|
+
# @return [Time]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] environment_arn
|
427
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
428
|
+
# environment.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] environment_name
|
432
|
+
# The name of the environment.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] vpc_id
|
436
|
+
# The VPC associated with the environment.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] service_access_subnet_id
|
440
|
+
# The subnet that is used to establish connectivity between the Amazon
|
441
|
+
# EVS control plane and VPC. Amazon EVS uses this subnet to perform
|
442
|
+
# validations and create the environment.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] vcf_version
|
446
|
+
# The VCF version of the environment.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] terms_accepted
|
450
|
+
# Customer confirmation that the customer has purchased and maintains
|
451
|
+
# sufficient VCF software licenses to cover all physical processor
|
452
|
+
# cores in the environment, in compliance with VMware's licensing
|
453
|
+
# requirements and terms of use.
|
454
|
+
# @return [Boolean]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] license_info
|
457
|
+
# The license information that Amazon EVS requires to create an
|
458
|
+
# environment. Amazon EVS requires two license keys: a VCF solution
|
459
|
+
# key and a vSAN license key.
|
460
|
+
# @return [Array<Types::LicenseInfo>]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] site_id
|
463
|
+
# The Broadcom Site ID that is associated with your Amazon EVS
|
464
|
+
# environment. Amazon EVS uses the Broadcom Site ID that you provide
|
465
|
+
# to meet Broadcom VCF license usage reporting requirements for Amazon
|
466
|
+
# EVS.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] environment_status
|
470
|
+
# Reports impaired functionality that stems from issues internal to
|
471
|
+
# the environment, such as impaired reachability.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] checks
|
475
|
+
# A check on the environment to identify instance health and VMware
|
476
|
+
# VCF licensing issues.
|
477
|
+
# @return [Array<Types::Check>]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] connectivity_info
|
480
|
+
# The connectivity configuration for the environment. Amazon EVS
|
481
|
+
# requires that you specify two route server peer IDs. During
|
482
|
+
# environment creation, the route server endpoints peer with the NSX
|
483
|
+
# uplink VLAN for connectivity to the NSX overlay network.
|
484
|
+
# @return [Types::ConnectivityInfo]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] vcf_hostnames
|
487
|
+
# The DNS hostnames to be used by the VCF management appliances in
|
488
|
+
# your environment.
|
489
|
+
#
|
490
|
+
# For environment creation to be successful, each hostname entry must
|
491
|
+
# resolve to a domain name that you've registered in your DNS service
|
492
|
+
# of choice and configured in the DHCP option set of your VPC. DNS
|
493
|
+
# hostnames cannot be changed after environment creation has started.
|
494
|
+
# @return [Types::VcfHostnames]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] kms_key_id
|
497
|
+
# The Amazon Web Services KMS key ID that Amazon Web Services Secrets
|
498
|
+
# Manager uses to encrypt secrets that are associated with the
|
499
|
+
# environment. These secrets contain the VCF credentials that are
|
500
|
+
# needed to install vCenter Server, NSX, and SDDC Manager.
|
501
|
+
#
|
502
|
+
# By default, Amazon EVS use the Amazon Web Services Secrets Manager
|
503
|
+
# managed key `aws/secretsmanager`. You can also specify a customer
|
504
|
+
# managed key.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] service_access_security_groups
|
508
|
+
# The security groups that allow traffic between the Amazon EVS
|
509
|
+
# control plane and your VPC for service access. If a security group
|
510
|
+
# is not specified, Amazon EVS uses the default security group in your
|
511
|
+
# account for service access.
|
512
|
+
# @return [Types::ServiceAccessSecurityGroups]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] credentials
|
515
|
+
# The VCF credentials that are stored as Amazon EVS managed secrets in
|
516
|
+
# Amazon Web Services Secrets Manager.
|
517
|
+
#
|
518
|
+
# Amazon EVS stores credentials that are needed to install vCenter
|
519
|
+
# Server, NSX, and SDDC Manager.
|
520
|
+
# @return [Array<Types::Secret>]
|
521
|
+
#
|
522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/Environment AWS API Documentation
|
523
|
+
#
|
524
|
+
class Environment < Struct.new(
|
525
|
+
:environment_id,
|
526
|
+
:environment_state,
|
527
|
+
:state_details,
|
528
|
+
:created_at,
|
529
|
+
:modified_at,
|
530
|
+
:environment_arn,
|
531
|
+
:environment_name,
|
532
|
+
:vpc_id,
|
533
|
+
:service_access_subnet_id,
|
534
|
+
:vcf_version,
|
535
|
+
:terms_accepted,
|
536
|
+
:license_info,
|
537
|
+
:site_id,
|
538
|
+
:environment_status,
|
539
|
+
:checks,
|
540
|
+
:connectivity_info,
|
541
|
+
:vcf_hostnames,
|
542
|
+
:kms_key_id,
|
543
|
+
:service_access_security_groups,
|
544
|
+
:credentials)
|
545
|
+
SENSITIVE = []
|
546
|
+
include Aws::Structure
|
547
|
+
end
|
548
|
+
|
549
|
+
# A list of environments with summarized environment details.
|
550
|
+
#
|
551
|
+
# @!attribute [rw] environment_id
|
552
|
+
# A unique ID for the environment.
|
553
|
+
# @return [String]
|
554
|
+
#
|
555
|
+
# @!attribute [rw] environment_name
|
556
|
+
# The name of the environment.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] vcf_version
|
560
|
+
# The VCF version of the environment.
|
561
|
+
# @return [String]
|
562
|
+
#
|
563
|
+
# @!attribute [rw] environment_status
|
564
|
+
# Reports impaired functionality that stems from issues internal to
|
565
|
+
# the environment, such as impaired reachability.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] environment_state
|
569
|
+
# The state of an environment.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] created_at
|
573
|
+
# The date and time that the environment was created.
|
574
|
+
# @return [Time]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] modified_at
|
577
|
+
# The date and time that the environment was modified.
|
578
|
+
# @return [Time]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] environment_arn
|
581
|
+
# The Amazon Resource Name (ARN) that is associated with the
|
582
|
+
# environment.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/EnvironmentSummary AWS API Documentation
|
586
|
+
#
|
587
|
+
class EnvironmentSummary < Struct.new(
|
588
|
+
:environment_id,
|
589
|
+
:environment_name,
|
590
|
+
:vcf_version,
|
591
|
+
:environment_status,
|
592
|
+
:environment_state,
|
593
|
+
:created_at,
|
594
|
+
:modified_at,
|
595
|
+
:environment_arn)
|
596
|
+
SENSITIVE = []
|
597
|
+
include Aws::Structure
|
598
|
+
end
|
599
|
+
|
600
|
+
# @!attribute [rw] environment_id
|
601
|
+
# A unique ID for the environment.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/GetEnvironmentRequest AWS API Documentation
|
605
|
+
#
|
606
|
+
class GetEnvironmentRequest < Struct.new(
|
607
|
+
:environment_id)
|
608
|
+
SENSITIVE = []
|
609
|
+
include Aws::Structure
|
610
|
+
end
|
611
|
+
|
612
|
+
# @!attribute [rw] environment
|
613
|
+
# A description of the requested environment.
|
614
|
+
# @return [Types::Environment]
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/GetEnvironmentResponse AWS API Documentation
|
617
|
+
#
|
618
|
+
class GetEnvironmentResponse < Struct.new(
|
619
|
+
:environment)
|
620
|
+
SENSITIVE = []
|
621
|
+
include Aws::Structure
|
622
|
+
end
|
623
|
+
|
624
|
+
# An ESXi host that runs on an Amazon EC2 bare metal instance. Four
|
625
|
+
# hosts are created in an Amazon EVS environment during environment
|
626
|
+
# creation. You can add hosts to an environment using the
|
627
|
+
# `CreateEnvironmentHost` operation. Amazon EVS supports 4-16 hosts per
|
628
|
+
# environment.
|
629
|
+
#
|
630
|
+
# @!attribute [rw] host_name
|
631
|
+
# The DNS hostname of the host. DNS hostnames for hosts must be unique
|
632
|
+
# across Amazon EVS environments and within VCF.
|
633
|
+
# @return [String]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] ip_address
|
636
|
+
# The IP address of the host.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] key_name
|
640
|
+
# The name of the SSH key that is used to access the host.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] instance_type
|
644
|
+
# The EC2 instance type of the host.
|
645
|
+
#
|
646
|
+
# <note markdown="1"> EC2 instances created through Amazon EVS do not support associating
|
647
|
+
# an IAM instance profile.
|
648
|
+
#
|
649
|
+
# </note>
|
650
|
+
# @return [String]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] placement_group_id
|
653
|
+
# The unique ID of the placement group where the host is placed.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] dedicated_host_id
|
657
|
+
# The unique ID of the Amazon EC2 Dedicated Host.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] created_at
|
661
|
+
# The date and time that the host was created.
|
662
|
+
# @return [Time]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] modified_at
|
665
|
+
# The date and time that the host was modified.
|
666
|
+
# @return [Time]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] host_state
|
669
|
+
# The state of the host.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] state_details
|
673
|
+
# A detailed description of the `hostState` of a host.
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] ec2_instance_id
|
677
|
+
# The unique ID of the EC2 instance that represents the host.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] network_interfaces
|
681
|
+
# The elastic network interfaces that are attached to the host.
|
682
|
+
# @return [Array<Types::NetworkInterface>]
|
683
|
+
#
|
684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/Host AWS API Documentation
|
685
|
+
#
|
686
|
+
class Host < Struct.new(
|
687
|
+
:host_name,
|
688
|
+
:ip_address,
|
689
|
+
:key_name,
|
690
|
+
:instance_type,
|
691
|
+
:placement_group_id,
|
692
|
+
:dedicated_host_id,
|
693
|
+
:created_at,
|
694
|
+
:modified_at,
|
695
|
+
:host_state,
|
696
|
+
:state_details,
|
697
|
+
:ec2_instance_id,
|
698
|
+
:network_interfaces)
|
699
|
+
SENSITIVE = []
|
700
|
+
include Aws::Structure
|
701
|
+
end
|
702
|
+
|
703
|
+
# An object that represents a host.
|
704
|
+
#
|
705
|
+
# <note markdown="1"> You cannot use `dedicatedHostId` and `placementGroupId` together in
|
706
|
+
# the same `HostInfoForCreate`object. This results in a
|
707
|
+
# `ValidationException` response.
|
708
|
+
#
|
709
|
+
# </note>
|
710
|
+
#
|
711
|
+
# @!attribute [rw] host_name
|
712
|
+
# The DNS hostname of the host. DNS hostnames for hosts must be unique
|
713
|
+
# across Amazon EVS environments and within VCF.
|
714
|
+
# @return [String]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] key_name
|
717
|
+
# The name of the SSH key that is used to access the host.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] instance_type
|
721
|
+
# The EC2 instance type that represents the host.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] placement_group_id
|
725
|
+
# The unique ID of the placement group where the host is placed.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] dedicated_host_id
|
729
|
+
# The unique ID of the Amazon EC2 Dedicated Host.
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/HostInfoForCreate AWS API Documentation
|
733
|
+
#
|
734
|
+
class HostInfoForCreate < Struct.new(
|
735
|
+
:host_name,
|
736
|
+
:key_name,
|
737
|
+
:instance_type,
|
738
|
+
:placement_group_id,
|
739
|
+
:dedicated_host_id)
|
740
|
+
SENSITIVE = []
|
741
|
+
include Aws::Structure
|
742
|
+
end
|
743
|
+
|
744
|
+
# An object that represents an initial VLAN subnet for the environment.
|
745
|
+
# Amazon EVS creates initial VLAN subnets when you first create the
|
746
|
+
# environment. You must specify a non-overlapping CIDR block for each
|
747
|
+
# VLAN subnet. Amazon EVS creates the following 10 VLAN subnets: host
|
748
|
+
# management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN,
|
749
|
+
# Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN
|
750
|
+
# 1, expansion VLAN 2.
|
751
|
+
#
|
752
|
+
# @!attribute [rw] cidr
|
753
|
+
# The CIDR block that you provide to create a VLAN subnet. VLAN CIDR
|
754
|
+
# blocks must not overlap with other subnets in the VPC.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/InitialVlanInfo AWS API Documentation
|
758
|
+
#
|
759
|
+
class InitialVlanInfo < Struct.new(
|
760
|
+
:cidr)
|
761
|
+
SENSITIVE = []
|
762
|
+
include Aws::Structure
|
763
|
+
end
|
764
|
+
|
765
|
+
# The initial VLAN subnets for the environment. You must specify a
|
766
|
+
# non-overlapping CIDR block for each VLAN subnet.
|
767
|
+
#
|
768
|
+
# @!attribute [rw] vmk_management
|
769
|
+
# The VMkernel management VLAN subnet. This VLAN subnet carries
|
770
|
+
# traffic for managing ESXi hosts and communicating with VMware
|
771
|
+
# vCenter Server.
|
772
|
+
# @return [Types::InitialVlanInfo]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] vm_management
|
775
|
+
# The VM management VLAN subnet. This VLAN subnet carries traffic for
|
776
|
+
# vSphere virtual machines.
|
777
|
+
# @return [Types::InitialVlanInfo]
|
778
|
+
#
|
779
|
+
# @!attribute [rw] v_motion
|
780
|
+
# The vMotion VLAN subnet. This VLAN subnet carries traffic for
|
781
|
+
# vSphere vMotion.
|
782
|
+
# @return [Types::InitialVlanInfo]
|
783
|
+
#
|
784
|
+
# @!attribute [rw] v_san
|
785
|
+
# The vSAN VLAN subnet. This VLAN subnet carries the communication
|
786
|
+
# between ESXi hosts to implement a vSAN shared storage pool.
|
787
|
+
# @return [Types::InitialVlanInfo]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] v_tep
|
790
|
+
# The VTEP VLAN subnet. This VLAN subnet handles internal network
|
791
|
+
# traffic between virtual machines within a VCF instance.
|
792
|
+
# @return [Types::InitialVlanInfo]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] edge_v_tep
|
795
|
+
# The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing
|
796
|
+
# between the internal network and external networks, including
|
797
|
+
# internet access and other site connections.
|
798
|
+
# @return [Types::InitialVlanInfo]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] nsx_uplink
|
801
|
+
# The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to
|
802
|
+
# the NSX overlay network.
|
803
|
+
# @return [Types::InitialVlanInfo]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] hcx
|
806
|
+
# The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect
|
807
|
+
# (IX) and HCX Network Extension (NE) to reach their peers and enable
|
808
|
+
# HCX Service Mesh creation.
|
809
|
+
# @return [Types::InitialVlanInfo]
|
810
|
+
#
|
811
|
+
# @!attribute [rw] expansion_vlan_1
|
812
|
+
# An additional VLAN subnet that can be used to extend VCF
|
813
|
+
# capabilities once configured. For example, you can configure an
|
814
|
+
# expansion VLAN subnet to use NSX Federation for centralized
|
815
|
+
# management and synchronization of multiple NSX deployments across
|
816
|
+
# different locations.
|
817
|
+
# @return [Types::InitialVlanInfo]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] expansion_vlan_2
|
820
|
+
# An additional VLAN subnet that can be used to extend VCF
|
821
|
+
# capabilities once configured. For example, you can configure an
|
822
|
+
# expansion VLAN subnet to use NSX Federation for centralized
|
823
|
+
# management and synchronization of multiple NSX deployments across
|
824
|
+
# different locations.
|
825
|
+
# @return [Types::InitialVlanInfo]
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/InitialVlans AWS API Documentation
|
828
|
+
#
|
829
|
+
class InitialVlans < Struct.new(
|
830
|
+
:vmk_management,
|
831
|
+
:vm_management,
|
832
|
+
:v_motion,
|
833
|
+
:v_san,
|
834
|
+
:v_tep,
|
835
|
+
:edge_v_tep,
|
836
|
+
:nsx_uplink,
|
837
|
+
:hcx,
|
838
|
+
:expansion_vlan_1,
|
839
|
+
:expansion_vlan_2)
|
840
|
+
SENSITIVE = []
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# The license information that Amazon EVS requires to create an
|
845
|
+
# environment. Amazon EVS requires two license keys: a VCF solution key
|
846
|
+
# and a vSAN license key.
|
847
|
+
#
|
848
|
+
# @!attribute [rw] solution_key
|
849
|
+
# The VCF solution key. This license unlocks VMware VCF product
|
850
|
+
# features, including vSphere, NSX, SDDC Manager, and vCenter Server.
|
851
|
+
# @return [String]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] vsan_key
|
854
|
+
# The VSAN license key. This license unlocks vSAN features.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/LicenseInfo AWS API Documentation
|
858
|
+
#
|
859
|
+
class LicenseInfo < Struct.new(
|
860
|
+
:solution_key,
|
861
|
+
:vsan_key)
|
862
|
+
SENSITIVE = []
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# @!attribute [rw] next_token
|
867
|
+
# A unique pagination token for each page. If `nextToken` is returned,
|
868
|
+
# there are more results available. Make the call again using the
|
869
|
+
# returned token with all other arguments unchanged to retrieve the
|
870
|
+
# next page. Each pagination token expires after 24 hours. Using an
|
871
|
+
# expired pagination token will return an *HTTP 400 InvalidToken*
|
872
|
+
# error.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] max_results
|
876
|
+
# The maximum number of results to return. If you specify `MaxResults`
|
877
|
+
# in the request, the response includes information up to the limit
|
878
|
+
# specified.
|
879
|
+
# @return [Integer]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] environment_id
|
882
|
+
# A unique ID for the environment.
|
883
|
+
# @return [String]
|
884
|
+
#
|
885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentHostsRequest AWS API Documentation
|
886
|
+
#
|
887
|
+
class ListEnvironmentHostsRequest < Struct.new(
|
888
|
+
:next_token,
|
889
|
+
:max_results,
|
890
|
+
:environment_id)
|
891
|
+
SENSITIVE = []
|
892
|
+
include Aws::Structure
|
893
|
+
end
|
894
|
+
|
895
|
+
# @!attribute [rw] next_token
|
896
|
+
# A unique pagination token for next page results. Make the call again
|
897
|
+
# using this token to retrieve the next page.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] environment_hosts
|
901
|
+
# A list of hosts in the environment.
|
902
|
+
# @return [Array<Types::Host>]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentHostsResponse AWS API Documentation
|
905
|
+
#
|
906
|
+
class ListEnvironmentHostsResponse < Struct.new(
|
907
|
+
:next_token,
|
908
|
+
:environment_hosts)
|
909
|
+
SENSITIVE = []
|
910
|
+
include Aws::Structure
|
911
|
+
end
|
912
|
+
|
913
|
+
# @!attribute [rw] next_token
|
914
|
+
# A unique pagination token for each page. If `nextToken` is returned,
|
915
|
+
# there are more results available. Make the call again using the
|
916
|
+
# returned token with all other arguments unchanged to retrieve the
|
917
|
+
# next page. Each pagination token expires after 24 hours. Using an
|
918
|
+
# expired pagination token will return an *HTTP 400 InvalidToken*
|
919
|
+
# error.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] max_results
|
923
|
+
# The maximum number of results to return. If you specify `MaxResults`
|
924
|
+
# in the request, the response includes information up to the limit
|
925
|
+
# specified.
|
926
|
+
# @return [Integer]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] environment_id
|
929
|
+
# A unique ID for the environment.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentVlansRequest AWS API Documentation
|
933
|
+
#
|
934
|
+
class ListEnvironmentVlansRequest < Struct.new(
|
935
|
+
:next_token,
|
936
|
+
:max_results,
|
937
|
+
:environment_id)
|
938
|
+
SENSITIVE = []
|
939
|
+
include Aws::Structure
|
940
|
+
end
|
941
|
+
|
942
|
+
# @!attribute [rw] next_token
|
943
|
+
# A unique pagination token for next page results. Make the call again
|
944
|
+
# using this token to retrieve the next page.
|
945
|
+
# @return [String]
|
946
|
+
#
|
947
|
+
# @!attribute [rw] environment_vlans
|
948
|
+
# A list of VLANs that are associated with the specified environment.
|
949
|
+
# @return [Array<Types::Vlan>]
|
950
|
+
#
|
951
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentVlansResponse AWS API Documentation
|
952
|
+
#
|
953
|
+
class ListEnvironmentVlansResponse < Struct.new(
|
954
|
+
:next_token,
|
955
|
+
:environment_vlans)
|
956
|
+
SENSITIVE = []
|
957
|
+
include Aws::Structure
|
958
|
+
end
|
959
|
+
|
960
|
+
# @!attribute [rw] next_token
|
961
|
+
# A unique pagination token for each page. If `nextToken` is returned,
|
962
|
+
# there are more results available. Make the call again using the
|
963
|
+
# returned token with all other arguments unchanged to retrieve the
|
964
|
+
# next page. Each pagination token expires after 24 hours. Using an
|
965
|
+
# expired pagination token will return an *HTTP 400 InvalidToken*
|
966
|
+
# error.
|
967
|
+
# @return [String]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] max_results
|
970
|
+
# The maximum number of results to return. If you specify `MaxResults`
|
971
|
+
# in the request, the response includes information up to the limit
|
972
|
+
# specified.
|
973
|
+
# @return [Integer]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] state
|
976
|
+
# The state of an environment. Used to filter response results to
|
977
|
+
# return only environments with the specified `environmentState`.
|
978
|
+
# @return [Array<String>]
|
979
|
+
#
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentsRequest AWS API Documentation
|
981
|
+
#
|
982
|
+
class ListEnvironmentsRequest < Struct.new(
|
983
|
+
:next_token,
|
984
|
+
:max_results,
|
985
|
+
:state)
|
986
|
+
SENSITIVE = []
|
987
|
+
include Aws::Structure
|
988
|
+
end
|
989
|
+
|
990
|
+
# @!attribute [rw] next_token
|
991
|
+
# A unique pagination token for next page results. Make the call again
|
992
|
+
# using this token to retrieve the next page.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] environment_summaries
|
996
|
+
# A list of environments with summarized environment details.
|
997
|
+
# @return [Array<Types::EnvironmentSummary>]
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentsResponse AWS API Documentation
|
1000
|
+
#
|
1001
|
+
class ListEnvironmentsResponse < Struct.new(
|
1002
|
+
:next_token,
|
1003
|
+
:environment_summaries)
|
1004
|
+
SENSITIVE = []
|
1005
|
+
include Aws::Structure
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# @!attribute [rw] resource_arn
|
1009
|
+
# The Amazon Resource Name (ARN) that identifies the resource to list
|
1010
|
+
# tags for.
|
1011
|
+
# @return [String]
|
1012
|
+
#
|
1013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListTagsForResourceRequest AWS API Documentation
|
1014
|
+
#
|
1015
|
+
class ListTagsForResourceRequest < Struct.new(
|
1016
|
+
:resource_arn)
|
1017
|
+
SENSITIVE = []
|
1018
|
+
include Aws::Structure
|
1019
|
+
end
|
1020
|
+
|
1021
|
+
# @!attribute [rw] tags
|
1022
|
+
# The tags for the resource.
|
1023
|
+
# @return [Hash<String,String>]
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListTagsForResourceResponse AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class ListTagsForResourceResponse < Struct.new(
|
1028
|
+
:tags)
|
1029
|
+
SENSITIVE = []
|
1030
|
+
include Aws::Structure
|
1031
|
+
end
|
1032
|
+
|
1033
|
+
# An elastic network interface (ENI) that connects hosts to the VLAN
|
1034
|
+
# subnets. Amazon EVS provisions two identically configured ENIs in the
|
1035
|
+
# VMkernel management subnet during host creation. One ENI is active,
|
1036
|
+
# and the other is in standby mode for automatic switchover during a
|
1037
|
+
# failure scenario.
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] network_interface_id
|
1040
|
+
# The unique ID of the elastic network interface.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/NetworkInterface AWS API Documentation
|
1044
|
+
#
|
1045
|
+
class NetworkInterface < Struct.new(
|
1046
|
+
:network_interface_id)
|
1047
|
+
SENSITIVE = []
|
1048
|
+
include Aws::Structure
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
# A service resource associated with the request could not be found. The
|
1052
|
+
# resource might not be specified correctly, or it may have a `state` of
|
1053
|
+
# `DELETED`.
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] message
|
1056
|
+
# Describes the error encountered.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] resource_id
|
1060
|
+
# The ID of the resource that could not be found.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] resource_type
|
1064
|
+
# The type of the resource that is associated with the error.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ResourceNotFoundException AWS API Documentation
|
1068
|
+
#
|
1069
|
+
class ResourceNotFoundException < Struct.new(
|
1070
|
+
:message,
|
1071
|
+
:resource_id,
|
1072
|
+
:resource_type)
|
1073
|
+
SENSITIVE = []
|
1074
|
+
include Aws::Structure
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# A managed secret that contains the credentials for installing vCenter
|
1078
|
+
# Server, NSX, and SDDC Manager. During environment creation, the Amazon
|
1079
|
+
# EVS control plane uses Amazon Web Services Secrets Manager to create,
|
1080
|
+
# encrypt, validate, and store secrets. If you choose to delete your
|
1081
|
+
# environment, Amazon EVS also deletes the secrets that are associated
|
1082
|
+
# with your environment. Amazon EVS does not provide managed rotation of
|
1083
|
+
# secrets. We recommend that you rotate secrets regularly to ensure that
|
1084
|
+
# secrets are not long-lived.
|
1085
|
+
#
|
1086
|
+
# @!attribute [rw] secret_arn
|
1087
|
+
# The Amazon Resource Name (ARN) of the secret.
|
1088
|
+
# @return [String]
|
1089
|
+
#
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/Secret AWS API Documentation
|
1091
|
+
#
|
1092
|
+
class Secret < Struct.new(
|
1093
|
+
:secret_arn)
|
1094
|
+
SENSITIVE = []
|
1095
|
+
include Aws::Structure
|
1096
|
+
end
|
1097
|
+
|
1098
|
+
# The security groups that allow traffic between the Amazon EVS control
|
1099
|
+
# plane and your VPC for Amazon EVS service access. If a security group
|
1100
|
+
# is not specified, Amazon EVS uses the default security group in your
|
1101
|
+
# account for service access.
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] security_groups
|
1104
|
+
# The security groups that allow service access.
|
1105
|
+
# @return [Array<String>]
|
1106
|
+
#
|
1107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ServiceAccessSecurityGroups AWS API Documentation
|
1108
|
+
#
|
1109
|
+
class ServiceAccessSecurityGroups < Struct.new(
|
1110
|
+
:security_groups)
|
1111
|
+
SENSITIVE = []
|
1112
|
+
include Aws::Structure
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# The request doesn't comply with IAM tag policy. Correct your request
|
1116
|
+
# and then retry it.
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] message
|
1119
|
+
# Describes the error encountered
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/TagPolicyException AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class TagPolicyException < Struct.new(
|
1125
|
+
:message)
|
1126
|
+
SENSITIVE = []
|
1127
|
+
include Aws::Structure
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# @!attribute [rw] resource_arn
|
1131
|
+
# The Amazon Resource Name (ARN) of the resource to add tags to.
|
1132
|
+
# @return [String]
|
1133
|
+
#
|
1134
|
+
# @!attribute [rw] tags
|
1135
|
+
# Metadata that assists with categorization and organization. Each tag
|
1136
|
+
# consists of a key and an optional value. You define both. Tags
|
1137
|
+
# don't propagate to any other environment or Amazon Web Services
|
1138
|
+
# resources.
|
1139
|
+
# @return [Hash<String,String>]
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/TagResourceRequest AWS API Documentation
|
1142
|
+
#
|
1143
|
+
class TagResourceRequest < Struct.new(
|
1144
|
+
:resource_arn,
|
1145
|
+
:tags)
|
1146
|
+
SENSITIVE = []
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/TagResourceResponse AWS API Documentation
|
1151
|
+
#
|
1152
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1153
|
+
|
1154
|
+
# The `CreateEnvironmentHost` operation couldn't be performed because
|
1155
|
+
# the service is throttling requests. This exception is thrown when the
|
1156
|
+
# `CreateEnvironmentHost` request exceeds concurrency of 1 transaction
|
1157
|
+
# per second (TPS).
|
1158
|
+
#
|
1159
|
+
# @!attribute [rw] message
|
1160
|
+
# Describes the error encountered.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @!attribute [rw] retry_after_seconds
|
1164
|
+
# The seconds to wait to retry.
|
1165
|
+
# @return [Integer]
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ThrottlingException AWS API Documentation
|
1168
|
+
#
|
1169
|
+
class ThrottlingException < Struct.new(
|
1170
|
+
:message,
|
1171
|
+
:retry_after_seconds)
|
1172
|
+
SENSITIVE = []
|
1173
|
+
include Aws::Structure
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
# A service resource associated with the request has more than 200 tags.
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] message
|
1179
|
+
# Describes the error encountered.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/TooManyTagsException AWS API Documentation
|
1183
|
+
#
|
1184
|
+
class TooManyTagsException < Struct.new(
|
1185
|
+
:message)
|
1186
|
+
SENSITIVE = []
|
1187
|
+
include Aws::Structure
|
1188
|
+
end
|
1189
|
+
|
1190
|
+
# @!attribute [rw] resource_arn
|
1191
|
+
# The Amazon Resource Name (ARN) of the resource to delete tags from.
|
1192
|
+
# @return [String]
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] tag_keys
|
1195
|
+
# The keys of the tags to delete.
|
1196
|
+
# @return [Array<String>]
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/UntagResourceRequest AWS API Documentation
|
1199
|
+
#
|
1200
|
+
class UntagResourceRequest < Struct.new(
|
1201
|
+
:resource_arn,
|
1202
|
+
:tag_keys)
|
1203
|
+
SENSITIVE = []
|
1204
|
+
include Aws::Structure
|
1205
|
+
end
|
1206
|
+
|
1207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/UntagResourceResponse AWS API Documentation
|
1208
|
+
#
|
1209
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1210
|
+
|
1211
|
+
# The input fails to satisfy the specified constraints. You will see
|
1212
|
+
# this exception if invalid inputs are provided for any of the Amazon
|
1213
|
+
# EVS environment operations, or if a list operation is performed on an
|
1214
|
+
# environment resource that is still initializing.
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] message
|
1217
|
+
# Describes the error encountered.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] reason
|
1221
|
+
# The reason for the exception.
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] field_list
|
1225
|
+
# A list of fields that didn't validate.
|
1226
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ValidationException AWS API Documentation
|
1229
|
+
#
|
1230
|
+
class ValidationException < Struct.new(
|
1231
|
+
:message,
|
1232
|
+
:reason,
|
1233
|
+
:field_list)
|
1234
|
+
SENSITIVE = []
|
1235
|
+
include Aws::Structure
|
1236
|
+
end
|
1237
|
+
|
1238
|
+
# Stores information about a field passed inside a request that resulted
|
1239
|
+
# in an exception.
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] name
|
1242
|
+
# The field name.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] message
|
1246
|
+
# A message describing why the field failed validation.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ValidationExceptionField AWS API Documentation
|
1250
|
+
#
|
1251
|
+
class ValidationExceptionField < Struct.new(
|
1252
|
+
:name,
|
1253
|
+
:message)
|
1254
|
+
SENSITIVE = []
|
1255
|
+
include Aws::Structure
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
# The DNS hostnames that Amazon EVS uses to install VMware vCenter
|
1259
|
+
# Server, NSX, SDDC Manager, and Cloud Builder. Each hostname must be
|
1260
|
+
# unique, and resolve to a domain name that you've registered in your
|
1261
|
+
# DNS service of choice. Hostnames cannot be changed.
|
1262
|
+
#
|
1263
|
+
# VMware VCF requires the deployment of two NSX Edge nodes, and three
|
1264
|
+
# NSX Manager virtual machines.
|
1265
|
+
#
|
1266
|
+
# @!attribute [rw] v_center
|
1267
|
+
# The VMware vCenter hostname.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] nsx
|
1271
|
+
# The VMware NSX hostname.
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] nsx_manager_1
|
1275
|
+
# The hostname for the first VMware NSX Manager virtual machine (VM).
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] nsx_manager_2
|
1279
|
+
# The hostname for the second VMware NSX Manager virtual machine (VM).
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] nsx_manager_3
|
1283
|
+
# The hostname for the third VMware NSX Manager virtual machine (VM).
|
1284
|
+
# @return [String]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] nsx_edge_1
|
1287
|
+
# The hostname for the first NSX Edge node.
|
1288
|
+
# @return [String]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] nsx_edge_2
|
1291
|
+
# The hostname for the second NSX Edge node.
|
1292
|
+
# @return [String]
|
1293
|
+
#
|
1294
|
+
# @!attribute [rw] sddc_manager
|
1295
|
+
# The hostname for SDDC Manager.
|
1296
|
+
# @return [String]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] cloud_builder
|
1299
|
+
# The hostname for VMware Cloud Builder.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/VcfHostnames AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class VcfHostnames < Struct.new(
|
1305
|
+
:v_center,
|
1306
|
+
:nsx,
|
1307
|
+
:nsx_manager_1,
|
1308
|
+
:nsx_manager_2,
|
1309
|
+
:nsx_manager_3,
|
1310
|
+
:nsx_edge_1,
|
1311
|
+
:nsx_edge_2,
|
1312
|
+
:sddc_manager,
|
1313
|
+
:cloud_builder)
|
1314
|
+
SENSITIVE = []
|
1315
|
+
include Aws::Structure
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
# The VLANs that Amazon EVS creates during environment creation.
|
1319
|
+
#
|
1320
|
+
# @!attribute [rw] vlan_id
|
1321
|
+
# The unique ID of the VLAN.
|
1322
|
+
# @return [Integer]
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] cidr
|
1325
|
+
# The CIDR block of the VLAN.
|
1326
|
+
# @return [String]
|
1327
|
+
#
|
1328
|
+
# @!attribute [rw] availability_zone
|
1329
|
+
# The availability zone of the VLAN.
|
1330
|
+
# @return [String]
|
1331
|
+
#
|
1332
|
+
# @!attribute [rw] function_name
|
1333
|
+
# The VMware VCF traffic type that is carried over the VLAN. For
|
1334
|
+
# example, a VLAN with a `functionName` of `hcx` is being used to
|
1335
|
+
# carry VMware HCX traffic.
|
1336
|
+
# @return [String]
|
1337
|
+
#
|
1338
|
+
# @!attribute [rw] subnet_id
|
1339
|
+
# The unique ID of the VLAN subnet.
|
1340
|
+
# @return [String]
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] created_at
|
1343
|
+
# The date and time that the VLAN was created.
|
1344
|
+
# @return [Time]
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] modified_at
|
1347
|
+
# The date and time that the VLAN was modified.
|
1348
|
+
# @return [Time]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] vlan_state
|
1351
|
+
# The state of the VLAN.
|
1352
|
+
# @return [String]
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] state_details
|
1355
|
+
# The state details of the VLAN.
|
1356
|
+
# @return [String]
|
1357
|
+
#
|
1358
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/Vlan AWS API Documentation
|
1359
|
+
#
|
1360
|
+
class Vlan < Struct.new(
|
1361
|
+
:vlan_id,
|
1362
|
+
:cidr,
|
1363
|
+
:availability_zone,
|
1364
|
+
:function_name,
|
1365
|
+
:subnet_id,
|
1366
|
+
:created_at,
|
1367
|
+
:modified_at,
|
1368
|
+
:vlan_state,
|
1369
|
+
:state_details)
|
1370
|
+
SENSITIVE = []
|
1371
|
+
include Aws::Structure
|
1372
|
+
end
|
1373
|
+
|
1374
|
+
end
|
1375
|
+
end
|
1376
|
+
|