ConnectionArgs class
The set of arguments for Connection. The set of arguments for Connection.
Constructors
-
ConnectionArgs({Input<
Map< ? athenaProperties, Input<String, String> ?>ConnectionAuthenticationConfiguration?> ? authenticationConfiguration, Input<String?> ? catalogId, Input<Map< ? connectionProperties, Input<String, String> ?>String?> ? connectionType, Input<String?> ? description, Input<List< ? matchCriterias, Input<String> ?>String?> ? name, Input<ConnectionPhysicalConnectionRequirements?> ? physicalConnectionRequirements, Input<String?> ? region, Input<Map< ? tags})String, String> ?> -
Creates a new ConnectionArgs.
athenaPropertiesMap of key-value pairs used as connection properties specific to the Athena compute environment.authenticationConfigurationConfiguration block for authentication options. SeeauthenticationConfigurationbelow.catalogIdID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.connectionPropertiesMap of key-value pairs used as parameters for this connection. For more information, see the AWS Documentation.connectionTypeType of the connection. Valid values:AZURECOSMOS,AZURESQL,BIGQUERY,CUSTOM,DYNAMODB,JDBC,KAFKA,MARKETPLACE,MONGODB,NETWORK,OPENSEARCH,SNOWFLAKE. Defaults toJDBC. Some connection types require theSparkPropertiesproperty with a JSON document that contains the actual connection properties. For specific examples, refer to Example Usage.descriptionDescription of the connection.matchCriteriasList of criteria that can be used in selecting this connection.nameName of the connection.physicalConnectionRequirementsMap of physical connection requirements, such as VPC and SecurityGroup. SeephysicalConnectionRequirementsbelow.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.const -
ConnectionArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
athenaProperties
→ Input<
Map< ?String, String> ?> -
Map of key-value pairs used as connection properties specific to the Athena compute environment.
final
-
authenticationConfiguration
→ Input<
ConnectionAuthenticationConfiguration?> ? -
Configuration block for authentication options. See
authenticationConfigurationbelow.final -
catalogId
→ Input<
String?> ? -
ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
final
-
connectionProperties
→ Input<
Map< ?String, String> ?> -
Map of key-value pairs used as parameters for this connection. For more information, see the AWS Documentation.
final
-
connectionType
→ Input<
String?> ? -
Type of the connection. Valid values:
AZURECOSMOS,AZURESQL,BIGQUERY,CUSTOM,DYNAMODB,JDBC,KAFKA,MARKETPLACE,MONGODB,NETWORK,OPENSEARCH,SNOWFLAKE. Defaults toJDBC. Some connection types require theSparkPropertiesproperty with a JSON document that contains the actual connection properties. For specific examples, refer to Example Usage.final -
description
→ Input<
String?> ? -
Description of the connection.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
matchCriterias
→ Input<
List< ?String> ?> -
List of criteria that can be used in selecting this connection.
final
-
name
→ Input<
String?> ? -
Name of the connection.
final
-
physicalConnectionRequirements
→ Input<
ConnectionPhysicalConnectionRequirements?> ? -
Map of physical connection requirements, such as VPC and SecurityGroup. See
physicalConnectionRequirementsbelow.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited