ConnectionSummary
The summary of a connection.
Contents
- connectionId
-
The ID of a connection.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: Yes
- domainId
-
The domain ID of a connection.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- domainUnitId
-
The domain unit ID of a connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-z0-9_\-]+$Required: Yes
- name
-
The connection name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: Yes
- physicalEndpoints
-
The connection physical endpoints.
Type: Array of PhysicalEndpoint objects
Required: Yes
- type
-
The connection type.
Type: String
Valid Values:
ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAARequired: Yes
- environmentId
-
The environment ID of a connection.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- projectId
-
The connection project ID.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- props
-
The connection props.
Type: ConnectionPropertiesOutput object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
