Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . events ]

create-connection

Description

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-connection
--name <value>
[--description <value>]
--authorization-type <value>
--auth-parameters <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name for the connection to create.

--description (string)

A description for the connection to create.

--authorization-type (string)

The type of authorization to use for the connection.

Possible values:

  • BASIC
  • OAUTH_CLIENT_CREDENTIALS
  • API_KEY

--auth-parameters (structure)

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

BasicAuthParameters -> (structure)

A CreateConnectionBasicAuthRequestParameters object that contains the Basic authorization parameters to use for the connection.

Username -> (string)

The user name to use for Basic authorization.

Password -> (string)

The password associated with the user name to use for Basic authorization.

OAuthParameters -> (structure)

A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization parameters to use for the connection.

ClientParameters -> (structure)

A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.

ClientID -> (string)

The client ID to use for OAuth authorization for the connection.

ClientSecret -> (string)

The client secret associated with the client ID to use for OAuth authorization for the connection.

AuthorizationEndpoint -> (string)

The URL to the authorization endpoint when OAuth is specified as the authorization type.

HttpMethod -> (string)

The method to use for the authorization request.

OAuthHttpParameters -> (structure)

A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

HeaderParameters -> (list)

Contains additional header parameters for the connection.

(structure)

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

Key -> (string)

The key for the parameter.

Value -> (string)

The value associated with the key.

IsValueSecret -> (boolean)

Specified whether the value is a secret.

QueryStringParameters -> (list)

Contains additional query string parameters for the connection.

(structure)

Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

Key -> (string)

The key for a query string parameter.

Value -> (string)

The value associated with the key for the query string parameter.

IsValueSecret -> (boolean)

Specifies whether the value is secret.

BodyParameters -> (list)

Contains additional body string parameters for the connection.

(structure)

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

Key -> (string)

The key for the parameter.

Value -> (string)

The value associated with the key.

IsValueSecret -> (boolean)

Specified whether the value is secret.

ApiKeyAuthParameters -> (structure)

A CreateConnectionApiKeyAuthRequestParameters object that contains the API key authorization parameters to use for the connection.

ApiKeyName -> (string)

The name of the API key to use for authorization.

ApiKeyValue -> (string)

The value for the API key to use for authorization.

InvocationHttpParameters -> (structure)

A ConnectionHttpParameters object that contains the API key authorization parameters to use for the connection. Note that if you include additional parameters for the target of a rule via HttpParameters , including query strings, the parameters added for the connection take precedence.

HeaderParameters -> (list)

Contains additional header parameters for the connection.

(structure)

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

Key -> (string)

The key for the parameter.

Value -> (string)

The value associated with the key.

IsValueSecret -> (boolean)

Specified whether the value is a secret.

QueryStringParameters -> (list)

Contains additional query string parameters for the connection.

(structure)

Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

Key -> (string)

The key for a query string parameter.

Value -> (string)

The value associated with the key for the query string parameter.

IsValueSecret -> (boolean)

Specifies whether the value is secret.

BodyParameters -> (list)

Contains additional body string parameters for the connection.

(structure)

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

Key -> (string)

The key for the parameter.

Value -> (string)

The value associated with the key.

IsValueSecret -> (boolean)

Specified whether the value is secret.

JSON Syntax:

{
  "BasicAuthParameters": {
    "Username": "string",
    "Password": "string"
  },
  "OAuthParameters": {
    "ClientParameters": {
      "ClientID": "string",
      "ClientSecret": "string"
    },
    "AuthorizationEndpoint": "string",
    "HttpMethod": "GET"|"POST"|"PUT",
    "OAuthHttpParameters": {
      "HeaderParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ],
      "QueryStringParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ],
      "BodyParameters": [
        {
          "Key": "string",
          "Value": "string",
          "IsValueSecret": true|false
        }
        ...
      ]
    }
  },
  "ApiKeyAuthParameters": {
    "ApiKeyName": "string",
    "ApiKeyValue": "string"
  },
  "InvocationHttpParameters": {
    "HeaderParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ],
    "QueryStringParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ],
    "BodyParameters": [
      {
        "Key": "string",
        "Value": "string",
        "IsValueSecret": true|false
      }
      ...
    ]
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Output

ConnectionArn -> (string)

The ARN of the connection that was created by the request.

ConnectionState -> (string)

The state of the connection that was created by the request.

CreationTime -> (timestamp)

A time stamp for the time that the connection was created.

LastModifiedTime -> (timestamp)

A time stamp for the time that the connection was last updated.