<a id="cli-aws-glue-create-connection"></a>

# create-connection

## Description

Creates a connection definition in the Data Catalog.

Connections used for creating federated resources require the IAM `glue:PassConnection` permission.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/CreateConnection)

## Synopsis

```
  create-connection
[--catalog-id <value>]
--connection-input <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

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

> Constraints:

> * min: `1`
> * max: `255`
> * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

`--connection-input` (structure) [required]

> A `ConnectionInput` object defining the connection to create.

> Name -> (string) [required]

> > The name of the connection.

> > Constraints:

> > * min: `1`
> > * max: `255`
> > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

> Description -> (string)

> > The description of the connection.

> > Constraints:

> > * min: `0`
> > * max: `2048`
> > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`

> ConnectionType -> (string) [required]

> > 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` .
> > * `VIEW_VALIDATION_REDSHIFT` - Designates a connection used for view validation by Amazon Redshift.
> > * `VIEW_VALIDATION_ATHENA` - Designates a connection used for view validation by Amazon Athena.
> > * `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.

> > For more information on the connection parameters needed for a particular connector, see the documentation for the connector in [Adding an Glue connection](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) in the Glue User Guide.

> > > `SFTP` is not supported.

> > For more information about how optional ConnectionProperties are used to configure features in Glue, consult [Glue connection properties](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html) .

> > For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult [Using connectors and connections](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html) .

> > Possible values:

> > * `JDBC`
> > * `SFTP`
> > * `MONGODB`
> > * `KAFKA`
> > * `NETWORK`
> > * `MARKETPLACE`
> > * `CUSTOM`
> > * `SALESFORCE`
> > * `VIEW_VALIDATION_REDSHIFT`
> > * `VIEW_VALIDATION_ATHENA`
> > * `GOOGLEADS`
> > * `GOOGLESHEETS`
> > * `GOOGLEANALYTICS4`
> > * `SERVICENOW`
> > * `MARKETO`
> > * `SAPODATA`
> > * `ZENDESK`
> > * `JIRACLOUD`
> > * `NETSUITEERP`
> > * `HUBSPOT`
> > * `FACEBOOKADS`
> > * `INSTAGRAMADS`
> > * `ZOHOCRM`
> > * `SALESFORCEPARDOT`
> > * `SALESFORCEMARKETINGCLOUD`
> > * `ADOBEANALYTICS`
> > * `SLACK`
> > * `LINKEDIN`
> > * `MIXPANEL`
> > * `ASANA`
> > * `STRIPE`
> > * `SMARTSHEET`
> > * `DATADOG`
> > * `WOOCOMMERCE`
> > * `INTERCOM`
> > * `SNAPCHATADS`
> > * `PAYPAL`
> > * `QUICKBOOKS`
> > * `FACEBOOKPAGEINSIGHTS`
> > * `FRESHDESK`
> > * `TWILIO`
> > * `DOCUSIGNMONITOR`
> > * `FRESHSALES`
> > * `ZOOM`
> > * `GOOGLESEARCHCONSOLE`
> > * `SALESFORCECOMMERCECLOUD`
> > * `SAPCONCUR`
> > * `DYNATRACE`
> > * `MICROSOFTDYNAMIC365FINANCEANDOPS`
> > * `MICROSOFTTEAMS`
> > * `BLACKBAUDRAISEREDGENXT`
> > * `MAILCHIMP`
> > * `GITLAB`
> > * `PENDO`
> > * `PRODUCTBOARD`
> > * `CIRCLECI`
> > * `PIPEDIVE`
> > * `SENDGRID`
> > * `AZURECOSMOS`
> > * `AZURESQL`
> > * `BIGQUERY`
> > * `BLACKBAUD`
> > * `CLOUDERAHIVE`
> > * `CLOUDERAIMPALA`
> > * `CLOUDWATCH`
> > * `CLOUDWATCHMETRICS`
> > * `CMDB`
> > * `DATALAKEGEN2`
> > * `DB2`
> > * `DB2AS400`
> > * `DOCUMENTDB`
> > * `DOMO`
> > * `DYNAMODB`
> > * `GOOGLECLOUDSTORAGE`
> > * `HBASE`
> > * `KUSTOMER`
> > * `MICROSOFTDYNAMICS365CRM`
> > * `MONDAY`
> > * `MYSQL`
> > * `OKTA`
> > * `OPENSEARCH`
> > * `ORACLE`
> > * `PIPEDRIVE`
> > * `POSTGRESQL`
> > * `SAPHANA`
> > * `SQLSERVER`
> > * `SYNAPSE`
> > * `TERADATA`
> > * `TERADATANOS`
> > * `TIMESTREAM`
> > * `TPCDS`
> > * `VERTICA`

> MatchCriteria -> (list)

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

> > Constraints:

> > * min: `0`
> > * max: `10`

> > (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `255`
> > > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

> ConnectionProperties -> (map) [required]

> > These key-value pairs define parameters for the connection.

> > Constraints:

> > * min: `0`
> > * max: `100`

> > key -> (string)

> > > Possible values:

> > > * `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`
> > > * `KAFKA_SASL_MECHANISM`
> > > * `KAFKA_SASL_PLAIN_USERNAME`
> > > * `KAFKA_SASL_PLAIN_PASSWORD`
> > > * `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD`
> > > * `KAFKA_SASL_SCRAM_USERNAME`
> > > * `KAFKA_SASL_SCRAM_PASSWORD`
> > > * `KAFKA_SASL_SCRAM_SECRETS_ARN`
> > > * `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`
> > > * `KAFKA_SASL_GSSAPI_KEYTAB`
> > > * `KAFKA_SASL_GSSAPI_KRB5_CONF`
> > > * `KAFKA_SASL_GSSAPI_SERVICE`
> > > * `KAFKA_SASL_GSSAPI_PRINCIPAL`
> > > * `SECRET_ID`
> > > * `CONNECTOR_URL`
> > > * `CONNECTOR_TYPE`
> > > * `CONNECTOR_CLASS_NAME`
> > > * `ENDPOINT`
> > > * `ENDPOINT_TYPE`
> > > * `ROLE_ARN`
> > > * `REGION`
> > > * `WORKGROUP_NAME`
> > > * `CLUSTER_IDENTIFIER`
> > > * `DATABASE`

> > value -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `1024`

> SparkProperties -> (map)

> > Connection properties specific to the Spark compute environment.

> > key -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > value -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `2048`

> AthenaProperties -> (map)

> > Connection properties specific to the Athena compute environment.

> > key -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > value -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `2048`

> PythonProperties -> (map)

> > Connection properties specific to the Python compute environment.

> > key -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > value -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `2048`

> PhysicalConnectionRequirements -> (structure)

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

> > > Constraints:

> > > * min: `1`
> > > * max: `255`
> > > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

> > SecurityGroupIdList -> (list)

> > > The security group ID list used by the connection.

> > > Constraints:

> > > * min: `0`
> > > * max: `50`

> > > (string)

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `255`
> > > > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

> > AvailabilityZone -> (string)

> > > The connection’s Availability Zone.

> > > Constraints:

> > > * min: `1`
> > > * max: `255`
> > > * pattern: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`

> AuthenticationConfiguration -> (structure)

> > The authentication properties of the connection.

> > AuthenticationType -> (string)

> > > A structure containing the authentication configuration in the CreateConnection request.

> > > Possible values:

> > > * `BASIC`
> > > * `OAUTH2`
> > > * `CUSTOM`
> > > * `IAM`

> > OAuth2Properties -> (structure)

> > > The properties for OAuth2 authentication in the CreateConnection request.

> > > OAuth2GrantType -> (string)

> > > > The OAuth2 grant type in the CreateConnection request. For example, `AUTHORIZATION_CODE` , `JWT_BEARER` , `REFRESH_TOKEN` , or `CLIENT_CREDENTIALS` .

> > > > Possible values:

> > > > * `AUTHORIZATION_CODE`
> > > > * `CLIENT_CREDENTIALS`
> > > > * `JWT_BEARER`
> > > > * `REFRESH_TOKEN`

> > > OAuth2ClientApplication -> (structure)

> > > > The client application type in the CreateConnection request. For example, `AWS_MANAGED` or `USER_MANAGED` .

> > > > UserManagedClientApplicationClientId -> (string)

> > > > > The client application clientID if the ClientAppType is `USER_MANAGED` .

> > > > > Constraints:

> > > > > * max: `2048`
> > > > > * pattern: `\S+`

> > > > AWSManagedClientApplicationReference -> (string)

> > > > > The reference to the SaaS-side client app that is Amazon Web Services managed.

> > > > > Constraints:

> > > > > * max: `2048`
> > > > > * pattern: `\S+`

> > > TokenUrl -> (string)

> > > > The URL of the provider’s authentication server, to exchange an authorization code for an access token.

> > > > Constraints:

> > > > * max: `256`
> > > > * pattern: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]`

> > > TokenUrlParametersMap -> (map)

> > > > A map of parameters that are added to the token `GET` request.

> > > > key -> (string)

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `128`

> > > > value -> (string)

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `512`

> > > AuthorizationCodeProperties -> (structure)

> > > > The set of properties required for the the OAuth2 `AUTHORIZATION_CODE` grant type.

> > > > AuthorizationCode -> (string)

> > > > > An authorization code to be used in the third leg of the `AUTHORIZATION_CODE` grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `4096`
> > > > > * pattern: `\S+`

> > > > RedirectUri -> (string)

> > > > > The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.

> > > > > Constraints:

> > > > > * max: `512`
> > > > > * pattern: `^(https?):\/\/[^\s/$.?#].[^\s]*$`

> > > OAuth2Credentials -> (structure)

> > > > The credentials used when the authentication type is OAuth2 authentication.

> > > > UserManagedClientApplicationClientSecret -> (string)

> > > > > The client application client secret if the client application is user managed.

> > > > > Constraints:

> > > > > * max: `512`
> > > > > * pattern: `^[\x20-\x7E]*$`

> > > > AccessToken -> (string)

> > > > > The access token used when the authentication type is OAuth2.

> > > > > Constraints:

> > > > > * max: `4096`
> > > > > * pattern: `^[\x20-\x7E]*$`

> > > > RefreshToken -> (string)

> > > > > The refresh token used when the authentication type is OAuth2.

> > > > > Constraints:

> > > > > * max: `4096`
> > > > > * pattern: `^[\x20-\x7E]*$`

> > > > JwtToken -> (string)

> > > > > The JSON Web Token (JWT) used when the authentication type is OAuth2.

> > > > > Constraints:

> > > > > * max: `8000`
> > > > > * pattern: `^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)`

> > SecretArn -> (string)

> > > The secret manager ARN to store credentials in the CreateConnection request.

> > > Constraints:

> > > * pattern: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$`

> > KmsKeyArn -> (string)

> > > The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

> > > Constraints:

> > > * pattern: `^$|arn:aws[a-z0-9-]*:kms:.*`

> > BasicAuthenticationCredentials -> (structure)

> > > The credentials used when the authentication type is basic authentication.

> > > Username -> (string)

> > > > The username to connect to the data source.

> > > > Constraints:

> > > > * max: `512`
> > > > * pattern: `\S+`

> > > Password -> (string)

> > > > The password to connect to the data source.

> > > > Constraints:

> > > > * max: `512`
> > > > * pattern: `.*`

> > CustomAuthenticationCredentials -> (map)

> > > The credentials used when the authentication type is custom authentication.

> > > key -> (string)

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`

> > > value -> (string)

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `2048`

> ValidateCredentials -> (boolean)

> > A flag to validate the credentials during create connection. Default is true.

> ValidateForComputeEnvironments -> (list)

> > The compute environments that the specified connection properties are validated against.

> > (string)

> > > Possible values:

> > > * `SPARK`
> > > * `ATHENA`
> > > * `PYTHON`

JSON Syntax:

```json
{
  "Name": "string",
  "Description": "string",
  "ConnectionType": "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"|"GOOGLEADS"|"GOOGLESHEETS"|"GOOGLEANALYTICS4"|"SERVICENOW"|"MARKETO"|"SAPODATA"|"ZENDESK"|"JIRACLOUD"|"NETSUITEERP"|"HUBSPOT"|"FACEBOOKADS"|"INSTAGRAMADS"|"ZOHOCRM"|"SALESFORCEPARDOT"|"SALESFORCEMARKETINGCLOUD"|"ADOBEANALYTICS"|"SLACK"|"LINKEDIN"|"MIXPANEL"|"ASANA"|"STRIPE"|"SMARTSHEET"|"DATADOG"|"WOOCOMMERCE"|"INTERCOM"|"SNAPCHATADS"|"PAYPAL"|"QUICKBOOKS"|"FACEBOOKPAGEINSIGHTS"|"FRESHDESK"|"TWILIO"|"DOCUSIGNMONITOR"|"FRESHSALES"|"ZOOM"|"GOOGLESEARCHCONSOLE"|"SALESFORCECOMMERCECLOUD"|"SAPCONCUR"|"DYNATRACE"|"MICROSOFTDYNAMIC365FINANCEANDOPS"|"MICROSOFTTEAMS"|"BLACKBAUDRAISEREDGENXT"|"MAILCHIMP"|"GITLAB"|"PENDO"|"PRODUCTBOARD"|"CIRCLECI"|"PIPEDIVE"|"SENDGRID"|"AZURECOSMOS"|"AZURESQL"|"BIGQUERY"|"BLACKBAUD"|"CLOUDERAHIVE"|"CLOUDERAIMPALA"|"CLOUDWATCH"|"CLOUDWATCHMETRICS"|"CMDB"|"DATALAKEGEN2"|"DB2"|"DB2AS400"|"DOCUMENTDB"|"DOMO"|"DYNAMODB"|"GOOGLECLOUDSTORAGE"|"HBASE"|"KUSTOMER"|"MICROSOFTDYNAMICS365CRM"|"MONDAY"|"MYSQL"|"OKTA"|"OPENSEARCH"|"ORACLE"|"PIPEDRIVE"|"POSTGRESQL"|"SAPHANA"|"SQLSERVER"|"SYNAPSE"|"TERADATA"|"TERADATANOS"|"TIMESTREAM"|"TPCDS"|"VERTICA",
  "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"|"KAFKA_SASL_MECHANISM"|"KAFKA_SASL_PLAIN_USERNAME"|"KAFKA_SASL_PLAIN_PASSWORD"|"ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD"|"KAFKA_SASL_SCRAM_USERNAME"|"KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_SCRAM_SECRETS_ARN"|"ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD"|"KAFKA_SASL_GSSAPI_KEYTAB"|"KAFKA_SASL_GSSAPI_KRB5_CONF"|"KAFKA_SASL_GSSAPI_SERVICE"|"KAFKA_SASL_GSSAPI_PRINCIPAL"|"SECRET_ID"|"CONNECTOR_URL"|"CONNECTOR_TYPE"|"CONNECTOR_CLASS_NAME"|"ENDPOINT"|"ENDPOINT_TYPE"|"ROLE_ARN"|"REGION"|"WORKGROUP_NAME"|"CLUSTER_IDENTIFIER"|"DATABASE": "string"
    ...},
  "SparkProperties": {"string": "string"
    ...},
  "AthenaProperties": {"string": "string"
    ...},
  "PythonProperties": {"string": "string"
    ...},
  "PhysicalConnectionRequirements": {
    "SubnetId": "string",
    "SecurityGroupIdList": ["string", ...],
    "AvailabilityZone": "string"
  },
  "AuthenticationConfiguration": {
    "AuthenticationType": "BASIC"|"OAUTH2"|"CUSTOM"|"IAM",
    "OAuth2Properties": {
      "OAuth2GrantType": "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER"|"REFRESH_TOKEN",
      "OAuth2ClientApplication": {
        "UserManagedClientApplicationClientId": "string",
        "AWSManagedClientApplicationReference": "string"
      },
      "TokenUrl": "string",
      "TokenUrlParametersMap": {"string": "string"
        ...},
      "AuthorizationCodeProperties": {
        "AuthorizationCode": "string",
        "RedirectUri": "string"
      },
      "OAuth2Credentials": {
        "UserManagedClientApplicationClientSecret": "string",
        "AccessToken": "string",
        "RefreshToken": "string",
        "JwtToken": "string"
      }
    },
    "SecretArn": "string",
    "KmsKeyArn": "string",
    "BasicAuthenticationCredentials": {
      "Username": "string",
      "Password": "string"
    },
    "CustomAuthenticationCredentials": {"string": "string"
      ...}
  },
  "ValidateCredentials": true|false,
  "ValidateForComputeEnvironments": ["SPARK"|"ATHENA"|"PYTHON", ...]
}
```

`--tags` (map)

> The tags you assign to the connection.

> Constraints:

> * min: `0`
> * max: `50`

> key -> (string)

> > Constraints:

> > * min: `1`
> > * max: `128`

> value -> (string)

> > Constraints:

> > * min: `0`
> > * max: `256`

Shorthand Syntax:

```
KeyName1=string,KeyName2=string
```

JSON Syntax:

```json
{"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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

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

```bash
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://amzn-s3-demo-bucket/prefix/cert-file.pem" \
        }, \
        "PhysicalConnectionRequirements":{ \
            "SubnetId":"subnet-1234", \
            "SecurityGroupIdList":["sg-1234"], \
            "AvailabilityZone":"us-west-2a"} \
    }'
```

This command produces no output.

For more information, see [Defining Connections in the AWS Glue Data Catalog](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) in the *AWS Glue Developer Guide*.

## Output

CreateConnectionStatus -> (string)

> The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.

> Possible values:

> * `READY`
> * `IN_PROGRESS`
> * `FAILED`