Amazonka.Glue.Types.ConnectionInput

Documentation

data ConnectionInput

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

See: newConnectionInput smart constructor.

Constructors

ConnectionInput'

Fields

• description :: Maybe Text

  The description of the connection.

• matchCriteria :: Maybe [Text]

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

• physicalConnectionRequirements :: Maybe PhysicalConnectionRequirements

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

• name :: Text

  The name of the connection.

• connectionType :: ConnectionType

  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.

• connectionProperties :: HashMap ConnectionPropertyKey Text

  These key-value pairs define parameters for the connection.

Instances

ToJSON ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

toJSON :: ConnectionInput -> Value

toEncoding :: ConnectionInput -> Encoding

toJSONList :: [ConnectionInput] -> Value

toEncodingList :: [ConnectionInput] -> Encoding

Generic ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Associated Types

type Rep ConnectionInput :: Type -> Type

Methods

from :: ConnectionInput -> Rep ConnectionInput x

to :: Rep ConnectionInput x -> ConnectionInput

Read ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

readsPrec :: Int -> ReadS ConnectionInput

readList :: ReadS [ConnectionInput]

readPrec :: ReadPrec ConnectionInput

readListPrec :: ReadPrec [ConnectionInput]

Show ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

showsPrec :: Int -> ConnectionInput -> ShowS

show :: ConnectionInput -> String

showList :: [ConnectionInput] -> ShowS

NFData ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

rnf :: ConnectionInput -> ()

Eq ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

(==) :: ConnectionInput -> ConnectionInput -> Bool

(/=) :: ConnectionInput -> ConnectionInput -> Bool

Hashable ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

Methods

hashWithSalt :: Int -> ConnectionInput -> Int

hash :: ConnectionInput -> Int

type Rep ConnectionInput

Defined in Amazonka.Glue.Types.ConnectionInput

type Rep ConnectionInput = D1 ('MetaData "ConnectionInput" "Amazonka.Glue.Types.ConnectionInput" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "ConnectionInput'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "matchCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "physicalConnectionRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PhysicalConnectionRequirements)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectionType) :*: S1 ('MetaSel ('Just "connectionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap ConnectionPropertyKey Text))))))

newConnectionInput

Arguments

:: Text

$sel:name:ConnectionInput'

-> ConnectionType

$sel:connectionType:ConnectionInput'

-> ConnectionInput

Create a value of ConnectionInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:ConnectionInput', connectionInput_description - The description of the connection.

$sel:matchCriteria:ConnectionInput', connectionInput_matchCriteria - A list of criteria that can be used in selecting this connection.

$sel:physicalConnectionRequirements:ConnectionInput', connectionInput_physicalConnectionRequirements - A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

$sel:name:ConnectionInput', connectionInput_name - The name of the connection.

$sel:connectionType:ConnectionInput', connectionInput_connectionType - 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.

$sel:connectionProperties:ConnectionInput', connectionInput_connectionProperties - These key-value pairs define parameters for the connection.

connectionInput_description :: Lens' ConnectionInput (Maybe Text)

The description of the connection.

connectionInput_matchCriteria :: Lens' ConnectionInput (Maybe [Text])

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

connectionInput_physicalConnectionRequirements :: Lens' ConnectionInput (Maybe PhysicalConnectionRequirements)

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

connectionInput_name :: Lens' ConnectionInput Text

The name of the connection.

connectionInput_connectionType :: Lens' ConnectionInput ConnectionType

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.

connectionInput_connectionProperties :: Lens' ConnectionInput (HashMap ConnectionPropertyKey Text)

These key-value pairs define parameters for the connection.