Skip to content

CreateEnvironmentConnectorRequest

Source code in docs_src/capo_evs/types/create_environment_connector_request.py
class CreateEnvironmentConnectorRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_evs.types.client_token.ClientToken"]
    """<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>"""
    environment_id: "capo_evs.types.environment_id.EnvironmentId"
    """<p>A unique ID for the environment to create the connector in.</p>"""
    type: "capo_evs.types.connector_type.ConnectorType"
    """<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>"""
    appliance_fqdn: "capo_evs.types.appliance_fqdn.ApplianceFqdn"
    """<p>The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.</p>"""
    secret_identifier: "capo_evs.types.secret_identifier.SecretIdentifier"
    """<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>"""

appliance_fqdn instance-attribute

appliance_fqdn: ApplianceFqdn

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

client_token instance-attribute

client_token: NotRequired[ClientToken]

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

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.

environment_id instance-attribute

environment_id: EnvironmentId

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

secret_identifier instance-attribute

secret_identifier: SecretIdentifier

The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields.

Do not use credentials with Administrator privileges. We recommend using a service account with read-only permissions.

type instance-attribute

The type of connector to create.

  • OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments.

  • SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.

  • VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.