CreateConnection
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.
Request Syntax
{
"AuthorizationType": "string
",
"AuthParameters": {
"ApiKeyAuthParameters": {
"ApiKeyName": "string
",
"ApiKeyValue": "string
"
},
"BasicAuthParameters": {
"Password": "string
",
"Username": "string
"
},
"ConnectivityParameters": {
"ResourceParameters": {
"ResourceConfigurationArn": "string
"
}
},
"InvocationHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
]
},
"OAuthParameters": {
"AuthorizationEndpoint": "string
",
"ClientParameters": {
"ClientID": "string
",
"ClientSecret": "string
"
},
"HttpMethod": "string
",
"OAuthHttpParameters": {
"BodyParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
],
"HeaderParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
],
"QueryStringParameters": [
{
"IsValueSecret": boolean
,
"Key": "string
",
"Value": "string
"
}
]
}
}
},
"Description": "string
",
"InvocationConnectivityParameters": {
"ResourceParameters": {
"ResourceConfigurationArn": "string
"
}
},
"Name": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AuthorizationType
-
The type of authorization to use for the connection.
Note
OAUTH tokens are refreshed when a 401 or 407 response is returned.
Type: String
Valid Values:
BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY
Required: Yes
- AuthParameters
-
The authorization parameters to use to authorize with the endpoint.
You must include only authorization parameters for the
AuthorizationType
you specify.Type: CreateConnectionAuthRequestParameters object
Required: Yes
- Description
-
A description for the connection to create.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.*
Required: No
- InvocationConnectivityParameters
-
For connections to private APIs, the parameters to use for invoking the API.
For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
Type: ConnectivityResourceParameters object
Required: No
- Name
-
The name for the connection to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax
{
"ConnectionArn": "string",
"ConnectionState": "string",
"CreationTime": number,
"LastModifiedTime": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ConnectionArn
-
The ARN of the connection that was created by the request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
- ConnectionState
-
The state of the connection that was created by the request.
Type: String
Valid Values:
CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY
- CreationTime
-
A time stamp for the time that the connection was created.
Type: Timestamp
- LastModifiedTime
-
A time stamp for the time that the connection was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have the necessary permissions for this action.
HTTP Status Code: 400
- InternalException
-
This exception occurs due to unexpected causes.
HTTP Status Code: 500
- LimitExceededException
-
The request failed because it attempted to create resource beyond the allowed service quota.
HTTP Status Code: 400
- ResourceAlreadyExistsException
-
The resource you are trying to create already exists.
HTTP Status Code: 400
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
- ThrottlingException
-
This request cannot be completed due to throttling issues.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: