Module Values_1.ConnectionInputSource

A structure that is used to specify a connection to create or update.

Sourcetype nonrec t = {
  1. name : Values_0.NameString.t;
    (*

    The name of the connection.

    *)
  2. description : Values_0.DescriptionString.t option;
    (*

    The description of the connection.

    *)
  3. connectionType : ConnectionType.t;
    (*

    The type of the connection. Currently, these types are supported: JDBC - Designates a connection to a database through Java Database Connectivity (JDBC). JDBC Connections use the following ConnectionParameters. Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL. Required: All of (USERNAME, PASSWORD) or SECRET_ID. Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC. KAFKA - Designates a connection to an Apache Kafka streaming platform. KAFKA Connections use the following ConnectionParameters. Required: KAFKA_BOOTSTRAP_SERVERS. Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA. Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA. Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM. Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA. Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA. MONGODB - Designates a connection to a MongoDB document database. MONGODB Connections use the following ConnectionParameters. Required: CONNECTION_URL. Required: All of (USERNAME, PASSWORD) or SECRET_ID. VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift. VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena. NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC). NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue. MARKETPLACE Connections use the following ConnectionParameters. Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL. Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID. CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue. For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an Glue connectionin the Glue User Guide. SFTP is not supported. For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties. For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

    *)
  4. matchCriteria : MatchCriteria.t option;
    (*

    A list of criteria that can be used in selecting this connection.

    *)
  5. connectionProperties : ConnectionProperties.t;
    (*

    These key-value pairs define parameters for the connection.

    *)
  6. sparkProperties : PropertyMap.t option;
    (*

    Connection properties specific to the Spark compute environment.

    *)
  7. athenaProperties : PropertyMap.t option;
    (*

    Connection properties specific to the Athena compute environment.

    *)
  8. pythonProperties : PropertyMap.t option;
    (*

    Connection properties specific to the Python compute environment.

    *)
  9. physicalConnectionRequirements : PhysicalConnectionRequirements.t option;
    (*

    The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

    *)
  10. authenticationConfiguration : Values_0.AuthenticationConfigurationInput.t option;
    (*

    The authentication properties of the connection.

    *)
  11. validateCredentials : Values_0.Boolean.t option;
    (*

    A flag to validate the credentials during create connection. Default is true.

    *)
  12. validateForComputeEnvironments : ComputeEnvironmentList.t option;
    (*

    The compute environments that the specified connection properties are validated against.

    *)
}
Sourceval context_ : string
Sourceval make : ?description:??? -> ?matchCriteria:??? -> ?sparkProperties:??? -> ?athenaProperties:??? -> ?pythonProperties:??? -> ?physicalConnectionRequirements:??? -> ?authenticationConfiguration:??? -> ?validateCredentials:??? -> ?validateForComputeEnvironments:??? -> name:Values_0.NameString.t -> connectionType:ConnectionType.t -> connectionProperties:ConnectionProperties.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Values_0.Boolean.t | `Enum of string | `List of [> `Enum of string | `String of Values_0.NameString.t ] list | `Map of ([> `Enum of string | `String of PropertyKey.t ] * [> `String of Values_0.ValueString.t ]) list | `String of Values_0.NameString.t | `Structure of (string * [> `Enum of string | `List of [> `String of Values_0.NameString.t ] list | `Map of ([> `String of string ] * [> `String of string ]) list | `String of Values_0.NameString.t | `Structure of (string * [> `Enum of string | `Map of ([> `String of string ] * [> `String of string ]) list | `String of string | `Structure of (string * [> `String of string ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t