EVS / Client / create_environment_connector

create_environment_connector

EVS.Client.create_environment_connector(**kwargs)

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.create_environment_connector(
    clientToken='string',
    environmentId='string',
    type='OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
    applianceFqdn='string',
    secretIdentifier='string'
)
Parameters:

  • clientToken (string) –

    Note

    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.

    This field is autopopulated if not provided.

  • environmentId (string) –

    [REQUIRED]

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

  • type (string) –

    [REQUIRED]

    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.

  • applianceFqdn (string) –

    [REQUIRED]

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

  • secretIdentifier (string) –

    [REQUIRED]

    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.

    Warning

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

Return type:

dict

Returns:

Response Syntax

{
    'connector': {
        'environmentId': 'string',
        'connectorId': 'string',
        'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
        'applianceFqdn': 'string',
        'secretArn': 'string',
        'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
        'stateDetails': 'string',
        'status': 'PASSED'|'FAILED'|'UNKNOWN',
        'checks': [
            {
                'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
                'result': 'PASSED'|'FAILED'|'UNKNOWN',
                'lastCheckAttempt': datetime(2015, 1, 1),
                'impairedSince': datetime(2015, 1, 1)
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'modifiedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • connector (dict) –

      A description of the created connector.

      • environmentId (string) –

        The unique ID of the environment that the connector belongs to.

      • connectorId (string) –

        The unique ID of the connector.

      • type (string) –

        The type of the connector.

      • applianceFqdn (string) –

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

      • secretArn (string) –

        The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

      • state (string) –

        The state of the connector.

      • stateDetails (string) –

        A detailed description of the connector state.

      • status (string) –

        The status of the connector.

      • checks (list) –

        A list of checks that are run on the connector.

        • (dict) –

          A check on a connector to identify connectivity health.

          • type (string) –

            The check type.

          • result (string) –

            The check result.

          • lastCheckAttempt (datetime) –

            The date and time of the last check attempt.

          • impairedSince (datetime) –

            The time when connector health began to be impaired.

      • createdAt (datetime) –

        The date and time that the connector was created.

      • modifiedAt (datetime) –

        The date and time that the connector was modified.

Exceptions