Connector
An object that represents a connector for an Amazon EVS environment. A connector establishes a vCenter connection using the credentials stored in AWS Secrets Manager.
Contents
Note
In the following list, the required parameters are described first.
- applianceFqdn
-
The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
[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])?)*Required: No
- checks
-
A list of checks that are run on the connector.
Type: Array of ConnectorCheck objects
Required: No
- connectorId
-
The unique ID of the connector.
Type: String
Pattern:
(cnctr-[a-zA-Z0-9]{10})Required: No
- createdAt
-
The date and time that the connector was created.
Type: Timestamp
Required: No
- environmentId
-
The unique ID of the environment that the connector belongs to.
Type: String
Pattern:
(env-[a-zA-Z0-9]{10})Required: No
- modifiedAt
-
The date and time that the connector was modified.
Type: Timestamp
Required: No
- secretArn
-
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that stores the credentials for the VCF appliance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:[a-zA-Z0-9/_+=.@!-]+|[a-zA-Z0-9/_+=.@!-]+)Required: No
- state
-
The state of the connector.
Type: String
Valid Values:
CREATING | CREATE_FAILED | ACTIVE | UPDATING | UPDATE_FAILED | DELETING | DELETEDRequired: No
- stateDetails
-
A detailed description of the connector state.
Type: String
Required: No
- status
-
The status of the connector.
Type: String
Valid Values:
PASSED | FAILED | UNKNOWNRequired: No
- type
-
The type of the connector.
Type: String
Valid Values:
VCENTERRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
