environment_connectors

Creates, updates, deletes, gets or lists an environment_connectors resource.

Overview

Name	environment_connectors
Type	Resource
Id	aws.evs.environment_connectors

Fields

The following fields are returned by SELECT queries:

list_environment_connectors

Name	Datatype	Description
appliance_fqdn	string	The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to. (pattern: <code>[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*</code>)
checks	array	A list of checks that are run on the connector.
connector_id	string	The unique ID of the connector. (pattern: <code>(cnctr-[a-zA-Z0-9]{10})</code>)
created_at	string (date-time)	The date and time that the connector was created.
environment_id	string	The unique ID of the environment that the connector belongs to. (pattern: <code>(env-[a-zA-Z0-9]{10})</code>)
modified_at	string (date-time)	The date and time that the connector was modified.
secret_arn	string	The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. (pattern: <code>(arn:aws:secretsmanager:[a-z0-9-]+:[0-9]{12}㊙️[a-zA-Z0-9/+=.@!-]+|[a-zA-Z0-9/+=.@!-]+)</code>)
state	string	The state of the connector. (CREATING, CREATE_FAILED, ACTIVE, UPDATING, UPDATE_FAILED, DELETING, DELETED)
state_details	string	A detailed description of the connector state.
status	string	The status of the connector. (PASSED, FAILED, UNKNOWN)
type_	string	The type of the connector. (OPERATIONS_MANAGER, SDDC_MANAGER, VCENTER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_environment_connectors	select	region		Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.
create_environment_connector	insert	region, environmentId, type, applianceFqdn, secretIdentifier		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.
update_environment_connector	update	region, environmentId, connectorId		Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata. You cannot update both the secret and the FQDN in the same request.
delete_environment_connector	delete	region		Deletes a connector from an Amazon EVS environment. Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_environment_connectors

Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.

SELECT
appliance_fqdn,
checks,
connector_id,
created_at,
environment_id,
modified_at,
secret_arn,
state,
state_details,
status,
type_
FROM aws.evs.environment_connectors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_environment_connector

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.

INSERT INTO aws.evs.environment_connectors (
clientToken,
environmentId,
type,
applianceFqdn,
secretIdentifier,
region
)
SELECT 
'{{ clientToken }}',
'{{ environmentId }}' /* required */,
'{{ type }}' /* required */,
'{{ applianceFqdn }}' /* required */,
'{{ secretIdentifier }}' /* required */,
'{{ region }}'
RETURNING
connector
;

Manifest

# Description fields are for documentation purposes
- name: environment_connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_connectors resource.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      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.
  - name: environmentId
    value: "{{ environmentId }}"
    description: |
      A unique ID for the environment to create the connector in.
  - name: type
    value: "{{ type }}"
    description: |
      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.
    valid_values: ['OPERATIONS_MANAGER', 'SDDC_MANAGER', 'VCENTER']
  - name: applianceFqdn
    value: "{{ applianceFqdn }}"
    description: |
      The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.
  - name: secretIdentifier
    value: "{{ secretIdentifier }}"
    description: |
      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.

UPDATE examples

update_environment_connector

Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata. You cannot update both the secret and the FQDN in the same request.

UPDATE aws.evs.environment_connectors
SET 
clientToken = '{{ clientToken }}',
environmentId = '{{ environmentId }}',
connectorId = '{{ connectorId }}',
applianceFqdn = '{{ applianceFqdn }}',
secretIdentifier = '{{ secretIdentifier }}'
WHERE 
region = '{{ region }}' --required
AND environmentId = '{{ environmentId }}' --required
AND connectorId = '{{ connectorId }}' --required
RETURNING
connector;

DELETE examples

delete_environment_connector

Deletes a connector from an Amazon EVS environment. Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.

DELETE FROM aws.evs.environment_connectors
WHERE region = '{{ region }}' --required
;