create-connection¶

Description¶

Creates a connection definition in the Data Catalog.

Synopsis¶

  create-connection
[--catalog-id <value>]
--connection-input <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--catalog-id (string)

The ID of the Data Catalog in which to create the connection. If none is provided, the Amazon Web Services account ID is used by default.

--connection-input (structure)

A ConnectionInput object defining the connection to create.

Name -> (string)

The name of the connection.

Description -> (string)

The description of the connection.

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

MatchCriteria -> (list)

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

(string)

ConnectionProperties -> (map)

These key-value pairs define parameters for the connection.

key -> (string)

value -> (string)

PhysicalConnectionRequirements -> (structure)

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

SubnetId -> (string)

The subnet ID used by the connection.

SecurityGroupIdList -> (list)

The security group ID list used by the connection.

(string)

AvailabilityZone -> (string)

The connection’s Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

Shorthand Syntax:

Name=string,Description=string,ConnectionType=string,MatchCriteria=string,string,ConnectionProperties={KeyName1=string,KeyName2=string},PhysicalConnectionRequirements={SubnetId=string,SecurityGroupIdList=[string,string],AvailabilityZone=string}

JSON Syntax:

{
  "Name": "string",
  "Description": "string",
  "ConnectionType": "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM",
  "MatchCriteria": ["string", ...],
  "ConnectionProperties": {"HOST"|"PORT"|"USERNAME"|"PASSWORD"|"ENCRYPTED_PASSWORD"|"JDBC_DRIVER_JAR_URI"|"JDBC_DRIVER_CLASS_NAME"|"JDBC_ENGINE"|"JDBC_ENGINE_VERSION"|"CONFIG_FILES"|"INSTANCE_ID"|"JDBC_CONNECTION_URL"|"JDBC_ENFORCE_SSL"|"CUSTOM_JDBC_CERT"|"SKIP_CUSTOM_JDBC_CERT_VALIDATION"|"CUSTOM_JDBC_CERT_STRING"|"CONNECTION_URL"|"KAFKA_BOOTSTRAP_SERVERS"|"KAFKA_SSL_ENABLED"|"KAFKA_CUSTOM_CERT"|"KAFKA_SKIP_CUSTOM_CERT_VALIDATION"|"KAFKA_CLIENT_KEYSTORE"|"KAFKA_CLIENT_KEYSTORE_PASSWORD"|"KAFKA_CLIENT_KEY_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD"|"ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD"|"SECRET_ID"|"CONNECTOR_URL"|"CONNECTOR_TYPE"|"CONNECTOR_CLASS_NAME": "string"
    ...},
  "PhysicalConnectionRequirements": {
    "SubnetId": "string",
    "SecurityGroupIdList": ["string", ...],
    "AvailabilityZone": "string"
  }
}

--tags (map)

The tags you assign to the connection.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a connection for AWS Glue data stores

The following create-connection example creates a connection in the AWS Glue Data Catalog that provides connection information for a Kafka data store.

aws glue create-connection \
    --connection-input '{ \
        "Name":"conn-kafka-custom", \
        "Description":"kafka connection with ssl to custom kafka", \
        "ConnectionType":"KAFKA",  \
        "ConnectionProperties":{  \
            "KAFKA_BOOTSTRAP_SERVERS":"<Kafka-broker-server-url>:<SSL-Port>", \
            "KAFKA_SSL_ENABLED":"true", \
            "KAFKA_CUSTOM_CERT": "s3://bucket/prefix/cert-file.pem" \
        }, \
        "PhysicalConnectionRequirements":{ \
            "SubnetId":"subnet-1234", \
            "SecurityGroupIdList":["sg-1234"], \
            "AvailabilityZone":"us-east-1a"} \
    }' \
    --region us-east-1
    --endpoint https://glue.us-east-1.amazonaws.com

This command produces no output.

For more information, see Defining Connections in the AWS Glue Data Catalog in the AWS Glue Developer Guide.

Output¶

None

Table of Contents

Feedback

User Guide