@aws-sdk/client-evs 3.864.0 → 3.865.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/README.md +1 -1
- package/dist-types/Evs.d.ts +1 -1
- package/dist-types/EvsClient.d.ts +1 -1
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateEnvironmentHostCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEnvironmentHostCommand.d.ts +1 -1
- package/dist-types/commands/GetEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/ListEnvironmentHostsCommand.d.ts +1 -1
- package/dist-types/commands/ListEnvironmentVlansCommand.d.ts +1 -1
- package/dist-types/commands/ListEnvironmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +15 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript Evs Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<
|
|
9
|
+
<p>Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).</p> <p>Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.</p>
|
|
10
10
|
|
|
11
11
|
## Installing
|
|
12
12
|
|
package/dist-types/Evs.d.ts
CHANGED
|
@@ -81,7 +81,7 @@ export interface Evs {
|
|
|
81
81
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
82
82
|
}
|
|
83
83
|
/**
|
|
84
|
-
* <
|
|
84
|
+
* <p>Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).</p> <p>Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.</p>
|
|
85
85
|
* @public
|
|
86
86
|
*/
|
|
87
87
|
export declare class Evs extends EvsClient implements Evs {
|
|
@@ -180,7 +180,7 @@ export type EvsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
|
|
|
180
180
|
export interface EvsClientResolvedConfig extends EvsClientResolvedConfigType {
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* <
|
|
183
|
+
* <p>Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).</p> <p>Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.</p>
|
|
184
184
|
* @public
|
|
185
185
|
*/
|
|
186
186
|
export declare class EvsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, EvsClientResolvedConfig> {
|
|
@@ -27,7 +27,7 @@ declare const CreateEnvironmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.</p> <p>During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.</p> <p>It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.</p> <note> <p>You cannot use the <code>dedicatedHostId</code> and <code>placementGroupId</code> parameters together in the same <code>CreateEnvironment</code> action. This results in a <code>ValidationException</code> response.</p> </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const CreateEnvironmentHostCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.</p> <p>This action can only be used after the Amazon EVS environment is deployed.</p> <p>You can use the <code>dedicatedHostId</code> parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.</p> <p> You can use the <code>placementGroupId</code> parameter to specify a cluster or partition placement group to launch EC2 instances into.</p> <note> <p>You cannot use the <code>dedicatedHostId</code> and <code>placementGroupId</code> parameters together in the same <code>CreateEnvironmentHost</code> action. This results in a <code>ValidationException</code> response.</p> </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteEnvironmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes an Amazon EVS environment.</p> <p>Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the <code>DeleteEnvironmentHost</code> action.</p> <p>Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const DeleteEnvironmentHostCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes a host from an Amazon EVS environment.</p> <note> <p>Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.</p> </note>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const GetEnvironmentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Returns a description of the specified environment.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListEnvironmentHostsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>List the hosts within an environment.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListEnvironmentVlansCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Lists environment VLANs that are associated with the specified environment.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListEnvironmentsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Lists the tags for an Amazon EVS resource.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Associates the specified tags to an Amazon EVS resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const UntagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <
|
|
30
|
+
* <p>Deletes specified tags from an Amazon EVS resource.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <
|
|
2
|
+
* <p>Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).</p> <p>Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.</p>
|
|
3
3
|
*
|
|
4
4
|
* @packageDocumentation
|
|
5
5
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { EvsServiceException as __BaseException } from "./EvsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <
|
|
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
5
|
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface ConnectivityInfo {
|
|
@@ -23,7 +23,7 @@ export declare const _InstanceType: {
|
|
|
23
23
|
*/
|
|
24
24
|
export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
|
|
25
25
|
/**
|
|
26
|
-
* <
|
|
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
27
|
* @public
|
|
28
28
|
*/
|
|
29
29
|
export interface HostInfoForCreate {
|
|
@@ -54,7 +54,7 @@ export interface HostInfoForCreate {
|
|
|
54
54
|
dedicatedHostId?: string | undefined;
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* <
|
|
57
|
+
* <p>An object that represents an initial VLAN subnet for the Amazon EVS environment. Amazon EVS creates initial VLAN subnets when you first create the environment. 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> <note> <p>For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.</p> </note>
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
60
|
export interface InitialVlanInfo {
|
|
@@ -65,7 +65,7 @@ export interface InitialVlanInfo {
|
|
|
65
65
|
cidr: string | undefined;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* <
|
|
68
|
+
* <p>The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.</p>
|
|
69
69
|
* @public
|
|
70
70
|
*/
|
|
71
71
|
export interface InitialVlans {
|
|
@@ -121,7 +121,7 @@ export interface InitialVlans {
|
|
|
121
121
|
expansionVlan2: InitialVlanInfo | undefined;
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* <
|
|
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
125
|
* @public
|
|
126
126
|
*/
|
|
127
127
|
export interface LicenseInfo {
|
|
@@ -137,7 +137,7 @@ export interface LicenseInfo {
|
|
|
137
137
|
vsanKey: string | undefined;
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* <
|
|
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
141
|
* @public
|
|
142
142
|
*/
|
|
143
143
|
export interface ServiceAccessSecurityGroups {
|
|
@@ -148,7 +148,7 @@ export interface ServiceAccessSecurityGroups {
|
|
|
148
148
|
securityGroups?: string[] | undefined;
|
|
149
149
|
}
|
|
150
150
|
/**
|
|
151
|
-
* <
|
|
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
152
|
* @public
|
|
153
153
|
*/
|
|
154
154
|
export interface VcfHostnames {
|
|
@@ -317,7 +317,7 @@ export declare const CheckType: {
|
|
|
317
317
|
*/
|
|
318
318
|
export type CheckType = (typeof CheckType)[keyof typeof CheckType];
|
|
319
319
|
/**
|
|
320
|
-
* <
|
|
320
|
+
* <p>A check on the environment to identify environment health and validate VMware VCF licensing compliance.</p>
|
|
321
321
|
* @public
|
|
322
322
|
*/
|
|
323
323
|
export interface Check {
|
|
@@ -338,7 +338,7 @@ export interface Check {
|
|
|
338
338
|
impairedSince?: Date | undefined;
|
|
339
339
|
}
|
|
340
340
|
/**
|
|
341
|
-
* <
|
|
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
342
|
* @public
|
|
343
343
|
*/
|
|
344
344
|
export interface Secret {
|
|
@@ -364,7 +364,7 @@ export declare const EnvironmentState: {
|
|
|
364
364
|
*/
|
|
365
365
|
export type EnvironmentState = (typeof EnvironmentState)[keyof typeof EnvironmentState];
|
|
366
366
|
/**
|
|
367
|
-
* <
|
|
367
|
+
* <p>An object that represents an Amazon EVS environment.</p>
|
|
368
368
|
* @public
|
|
369
369
|
*/
|
|
370
370
|
export interface Environment {
|
|
@@ -480,7 +480,7 @@ export interface CreateEnvironmentResponse {
|
|
|
480
480
|
environment?: Environment | undefined;
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
|
-
* <
|
|
483
|
+
* <p>Stores information about a field passed inside a request that resulted in an exception.</p>
|
|
484
484
|
* @public
|
|
485
485
|
*/
|
|
486
486
|
export interface ValidationExceptionField {
|
|
@@ -552,7 +552,7 @@ export interface CreateEnvironmentHostRequest {
|
|
|
552
552
|
host: HostInfoForCreate | undefined;
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
|
-
* <
|
|
555
|
+
* <p>A list of environments with summarized environment details.</p>
|
|
556
556
|
* @public
|
|
557
557
|
*/
|
|
558
558
|
export interface EnvironmentSummary {
|
|
@@ -615,7 +615,7 @@ export declare const HostState: {
|
|
|
615
615
|
*/
|
|
616
616
|
export type HostState = (typeof HostState)[keyof typeof HostState];
|
|
617
617
|
/**
|
|
618
|
-
* <
|
|
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
619
|
* @public
|
|
620
620
|
*/
|
|
621
621
|
export interface NetworkInterface {
|
|
@@ -626,7 +626,7 @@ export interface NetworkInterface {
|
|
|
626
626
|
networkInterfaceId?: string | undefined;
|
|
627
627
|
}
|
|
628
628
|
/**
|
|
629
|
-
* <
|
|
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
630
|
* @public
|
|
631
631
|
*/
|
|
632
632
|
export interface Host {
|
|
@@ -932,7 +932,7 @@ export declare const VlanState: {
|
|
|
932
932
|
*/
|
|
933
933
|
export type VlanState = (typeof VlanState)[keyof typeof VlanState];
|
|
934
934
|
/**
|
|
935
|
-
* <
|
|
935
|
+
* <p>The VLANs that Amazon EVS creates during environment creation.</p>
|
|
936
936
|
* @public
|
|
937
937
|
*/
|
|
938
938
|
export interface Vlan {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-evs",
|
|
3
3
|
"description": "AWS SDK for JavaScript Evs Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.865.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|