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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_propertiesHash<String,String>

These key-value pairs define parameters for the connection.

Returns:

  • (Hash<String,String>)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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

#connection_typeString

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

SFTP is not supported.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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

#descriptionString

The description of the connection.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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

#match_criteriaArray<String>

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

Returns:

  • (Array<String>)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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

#nameString

The name of the connection.

Returns:

  • (String)


1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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

#physical_connection_requirementsTypes::PhysicalConnectionRequirements

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



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1952

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