Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1422147110.4 KB

Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name.

You can create only one connector of each type per environment. For environments where Amazon EVS installs VCF, the SDDC_MANAGER connector is created automatically.

Amazon EVS requires an active connector to SDDC Manager or VCF Operations Manager to monitor environment health and license compliance.

post/#X-Amz-Target=AmazonElasticVMwareService.CreateEnvironmentConnector

Headers

X-Amz-Target'AmazonElasticVMwareService.CreateEnvironmentConnector' required

Request body

clientTokenstring
<p><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 connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p></p>
environmentIdstring required

A unique ID for the environment to create the connector in.

type'OPERATIONS_MANAGER' | 'SDDC_MANAGER' | 'VCENTER' required
<p>The type of connector to create.</p> <ul> <li> <p> <code>OPERATIONS_MANAGER</code>: Connector to an Operations Manager appliance. Required for VCF 9x environments.</p> </li> <li> <p> <code>SDDC_MANAGER</code>: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.</p> </li> <li> <p> <code>VCENTER</code>: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.</p> </li> </ul>
applianceFqdnstring required

The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.

secretIdentifierstring required
<p>The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. <code>SDDC_MANAGER</code> requires an <code>apiKey</code> field; <code>OPERATIONS_MANAGER</code> and <code>VCENTER</code> require <code>username</code> and <code>password</code> fields.</p> <important> <p>Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.</p> </important>

Response

Success