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

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

Overview

Note:

When making an API call, you may pass ConnectionInput data as a hash:

{
  name: "NameString", # required
  description: "DescriptionString",
  connection_type: "JDBC", # required, accepts JDBC, SFTP, MONGODB, KAFKA, NETWORK, MARKETPLACE, CUSTOM
  match_criteria: ["NameString"],
  connection_properties: { # required
    "HOST" => "ValueString",
  },
  physical_connection_requirements: {
    subnet_id: "NameString",
    security_group_id_list: ["NameString"],
    availability_zone: "NameString",
  },
}

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

#connection_properties ⇒ Hash<String,String>

These key-value pairs define parameters for the connection.

Returns:

  • (Hash<String,String>) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

class ConnectionInput < Struct.new(
  :name,
  :description,
  :connection_type,
  :match_criteria,
  :connection_properties,
  :physical_connection_requirements)
  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).

  • KAFKA - Designates a connection to an Apache Kafka streaming platform.

  • MONGODB - Designates a connection to a MongoDB document database.

  • NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

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

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

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

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

#description ⇒ String

The description of the connection.

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

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

#match_criteria ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

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

#name ⇒ String

The name of the connection.

Returns:

  • (String) 


2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

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

#physical_connection_requirements ⇒ Types::PhysicalConnectionRequirements

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

Returns:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2352

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