Class: Aws::Glue::Types::ConnectionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_configuration ⇒ Types::AuthenticationConfigurationInput

The authentication properties of the connection. Used for a Salesforce connection.

Returns:



3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#connection_properties ⇒ Hash<String,String>

These key-value pairs define parameters for the connection.

Returns:

  • (Hash<String,String>) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#connection_type ⇒ String

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.

  • SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

    • Requires the AuthenticationConfiguration member to be configured.

    ^

  • 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.

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.

Returns:

  • (String) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the connection.

Returns:

  • (String) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#match_criteria ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the connection.

Returns:

  • (String) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#physical_connection_requirements ⇒ Types::PhysicalConnectionRequirements

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

Returns:



3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#validate_credentials ⇒ Boolean

A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

Returns:

  • (Boolean) 


3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 3490

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements,
  :authentication_configuration,
  :validate_credentials)
  SENSITIVE = []
  include Aws::Structure
end