This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Events::Connection
<a name="aws-resource-events-connection"></a>

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](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-resource-events-connection-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-events-connection-syntax.json"></a>

```
{
  "Type" : "AWS::Events::Connection",
  "Properties" : {
      "[AuthorizationType](#cfn-events-connection-authorizationtype)" : String,
      "[AuthParameters](#cfn-events-connection-authparameters)" : AuthParameters,
      "[Description](#cfn-events-connection-description)" : String,
      "[InvocationConnectivityParameters](#cfn-events-connection-invocationconnectivityparameters)" : InvocationConnectivityParameters,
      "[KmsKeyIdentifier](#cfn-events-connection-kmskeyidentifier)" : String,
      "[Name](#cfn-events-connection-name)" : String
    }
}
```

### YAML
<a name="aws-resource-events-connection-syntax.yaml"></a>

```
Type: AWS::Events::Connection
Properties:
  [AuthorizationType](#cfn-events-connection-authorizationtype): String
  [AuthParameters](#cfn-events-connection-authparameters): 
    AuthParameters
  [Description](#cfn-events-connection-description): String
  [InvocationConnectivityParameters](#cfn-events-connection-invocationconnectivityparameters): 
    InvocationConnectivityParameters
  [KmsKeyIdentifier](#cfn-events-connection-kmskeyidentifier): String
  [Name](#cfn-events-connection-name): String
```

## Properties
<a name="aws-resource-events-connection-properties"></a>

`AuthorizationType`  <a name="cfn-events-connection-authorizationtype"></a>
The type of authorization to use for the connection.  
OAUTH tokens are refreshed when a 401 or 407 response is returned.
*Required*: No  
*Type*: String  
*Allowed values*: `API_KEY | BASIC | OAUTH_CLIENT_CREDENTIALS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AuthParameters`  <a name="cfn-events-connection-authparameters"></a>
The authorization parameters to use to authorize with the endpoint.   
You must include only authorization parameters for the `AuthorizationType` you specify.  
*Required*: No  
*Type*: [AuthParameters](aws-properties-events-connection-authparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-events-connection-description"></a>
A description for the connection to create.  
*Required*: No  
*Type*: String  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InvocationConnectivityParameters`  <a name="cfn-events-connection-invocationconnectivityparameters"></a>
For connections to private APIs, the parameters to use for invoking the API.  
For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the * *Amazon EventBridge User Guide* *.  
*Required*: No  
*Type*: [InvocationConnectivityParameters](aws-properties-events-connection-invocationconnectivityparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyIdentifier`  <a name="cfn-events-connection-kmskeyidentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service Developer Guide*.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-/:]*$`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-events-connection-name"></a>
The name for the connection to create.  
*Required*: No  
*Type*: String  
*Pattern*: `[\.\-_A-Za-z0-9]+`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-events-connection-return-values"></a>

### Ref
<a name="aws-resource-events-connection-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the connection that was created by the request.

### Fn::GetAtt
<a name="aws-resource-events-connection-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-events-connection-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the connection that was created by the request.

`ArnForPolicy`  <a name="ArnForPolicy-fn::getatt"></a>
Returns the Amazon Resource Name (ARN) of a connection in resource format, so it can be used in the `Resource` element of IAM permission policy statements. For more information, see [Resource types defined by Amazon EventBridge](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html#amazoneventbridge-resources-for-iam-policies) in the *Service Authorization Reference*.  
For example, the following resource defines an IAM policy that grants permission to update a specific connection.  

```
Resources:
  ExamplePolicy:
    Type: AWS::IAM::Policy
    Properties:
      PolicyName: ExamplePolicy
      PolicyDocument:
        Version: '2012-10-17		 	 	 '
        Statement:
          - Effect: Allow
            Action:
              - events:UpdateConnection
            Resource:
              - !GetAtt myConnection.ArnForPolicy
```

`AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn`  <a name="AuthParameters.ConnectivityParameters.ResourceParameters.ResourceAssociationArn-fn::getatt"></a>
For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.  
For more information, see [ Managing service network resource associations for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra) in the * *Amazon EventBridge User Guide* *.

`InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn`  <a name="InvocationConnectivityParameters.ResourceParameters.ResourceAssociationArn-fn::getatt"></a>
For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.  
For more information, see [ Managing service network resource associations for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html#connection-private-snra) in the * *Amazon EventBridge User Guide* *.

`SecretArn`  <a name="SecretArn-fn::getatt"></a>
The ARN for the secret created for the connection.

## Examples
<a name="aws-resource-events-connection--examples"></a>



**Topics**
+ [Create a connection with ApiKey authorization parameters](#aws-resource-events-connection--examples--Create_a_connection_with_ApiKey_authorization_parameters)
+ [Create a connection with OAuth authorization parameters](#aws-resource-events-connection--examples--Create_a_connection_with_OAuth_authorization_parameters)

### Create a connection with ApiKey authorization parameters
<a name="aws-resource-events-connection--examples--Create_a_connection_with_ApiKey_authorization_parameters"></a>

The following example creates a connection named pagerduty-connection using ApiKey authorization and stores a secret from Secrets Manager.

#### JSON
<a name="aws-resource-events-connection--examples--Create_a_connection_with_ApiKey_authorization_parameters--json"></a>

```
{
  "Resources": {
    "Connection": {
      "Type": "AWS::Events::Connection",
      "Properties": {
        "Name": "pagerduty-connection",
        "AuthorizationType": "API_KEY",
        "AuthParameters": {
          "ApiKeyAuthParameters": {
            "ApiKeyName": "Authorization",
            "ApiKeyValue": "{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:pagerdutyApiToken-S9SoDa}}"
          },
          "InvocationHttpParameters": {
            "BodyParameters": [
              {
                "Key": "routing_key",
                "Value": "my-pagerduty-integration-key",
                "IsValueSecret": true
              }
            ]
          }
        }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-events-connection--examples--Create_a_connection_with_ApiKey_authorization_parameters--yaml"></a>

```
Resources:
  Connection:
    Type: AWS::Events::Connection
    Properties:
      Name: pagerduty-connection
      AuthorizationType: API_KEY
      AuthParameters:
        ApiKeyAuthParameters:
          ApiKeyName: Authorization
          ApiKeyValue: '{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:pagerdutyApiToken-S9SoDa}}'
        InvocationHttpParameters:
          BodyParameters:
            - Key: routing_key
              Value: my-pagerduty-integration-key
              IsValueSecret: true
```

### Create a connection with OAuth authorization parameters
<a name="aws-resource-events-connection--examples--Create_a_connection_with_OAuth_authorization_parameters"></a>

The following example creates a connection named auth0-connection using OAuth authorization and stores a secret from Secrets Manager.

#### JSON
<a name="aws-resource-events-connection--examples--Create_a_connection_with_OAuth_authorization_parameters--json"></a>

```
{
  "Resources": {
    "Auth0Connection": {
      "Type": "AWS::Events::Connection",
      "Properties": {
        "Name": "auth0-connection",
        "AuthorizationType": "OAUTH_CLIENT_CREDENTIALS",
        "AuthParameters": {
          "OAuthParameters": {
            "AuthorizationEndpoint": "https://yourUserName.us.auth0.com/oauth/token",
            "ClientParameters": {
              "ClientID": "{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:auth0ClientId}}",
              "ClientSecret": "{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:auth0ClientSecret}}"
            },
            "HttpMethod": "POST",
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "Key": "audience",
                  "Value": "my-auth0-identifier",
                  "IsValueSecret": true
                }
              ]
            }
          }
        }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-events-connection--examples--Create_a_connection_with_OAuth_authorization_parameters--yaml"></a>

```
Resources:
  Auth0Connection:
    Type: AWS::Events::Connection
    Properties:
      Name: auth0-connection
      AuthorizationType: OAUTH_CLIENT_CREDENTIALS
      AuthParameters:
        OAuthParameters:
          AuthorizationEndpoint: https://yourUserName.us.auth0.com/oauth/token
          ClientParameters:
            ClientID: '{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:auth0ClientId}}'
            ClientSecret: '{{resolve:secretsmanager:arn:aws:secretsmanager:us-west-2:123456789012:secret:auth0ClientSecret}}'
          HttpMethod: POST
          OAuthHttpParameters:
            BodyParameters:
              - Key: audience
                Value: my-auth0-identifier
                IsValueSecret: true
```

# AWS::Events::Connection ApiKeyAuthParameters
<a name="aws-properties-events-connection-apikeyauthparameters"></a>

The API key authorization parameters for the connection.

## Syntax
<a name="aws-properties-events-connection-apikeyauthparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-apikeyauthparameters-syntax.json"></a>

```
{
  "[ApiKeyName](#cfn-events-connection-apikeyauthparameters-apikeyname)" : String,
  "[ApiKeyValue](#cfn-events-connection-apikeyauthparameters-apikeyvalue)" : String
}
```

### YAML
<a name="aws-properties-events-connection-apikeyauthparameters-syntax.yaml"></a>

```
  [ApiKeyName](#cfn-events-connection-apikeyauthparameters-apikeyname): String
  [ApiKeyValue](#cfn-events-connection-apikeyauthparameters-apikeyvalue): String
```

## Properties
<a name="aws-properties-events-connection-apikeyauthparameters-properties"></a>

`ApiKeyName`  <a name="cfn-events-connection-apikeyauthparameters-apikeyname"></a>
The name of the API key to use for authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ApiKeyValue`  <a name="cfn-events-connection-apikeyauthparameters-apikeyvalue"></a>
The value for the API key to use for authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection AuthParameters
<a name="aws-properties-events-connection-authparameters"></a>

Tthe authorization parameters to use for the connection.

## Syntax
<a name="aws-properties-events-connection-authparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-authparameters-syntax.json"></a>

```
{
  "[ApiKeyAuthParameters](#cfn-events-connection-authparameters-apikeyauthparameters)" : ApiKeyAuthParameters,
  "[BasicAuthParameters](#cfn-events-connection-authparameters-basicauthparameters)" : BasicAuthParameters,
  "[ConnectivityParameters](#cfn-events-connection-authparameters-connectivityparameters)" : ConnectivityParameters,
  "[InvocationHttpParameters](#cfn-events-connection-authparameters-invocationhttpparameters)" : ConnectionHttpParameters,
  "[OAuthParameters](#cfn-events-connection-authparameters-oauthparameters)" : OAuthParameters
}
```

### YAML
<a name="aws-properties-events-connection-authparameters-syntax.yaml"></a>

```
  [ApiKeyAuthParameters](#cfn-events-connection-authparameters-apikeyauthparameters): 
    ApiKeyAuthParameters
  [BasicAuthParameters](#cfn-events-connection-authparameters-basicauthparameters): 
    BasicAuthParameters
  [ConnectivityParameters](#cfn-events-connection-authparameters-connectivityparameters): 
    ConnectivityParameters
  [InvocationHttpParameters](#cfn-events-connection-authparameters-invocationhttpparameters): 
    ConnectionHttpParameters
  [OAuthParameters](#cfn-events-connection-authparameters-oauthparameters): 
    OAuthParameters
```

## Properties
<a name="aws-properties-events-connection-authparameters-properties"></a>

`ApiKeyAuthParameters`  <a name="cfn-events-connection-authparameters-apikeyauthparameters"></a>
The API Key parameters to use for authorization.  
*Required*: No  
*Type*: [ApiKeyAuthParameters](aws-properties-events-connection-apikeyauthparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BasicAuthParameters`  <a name="cfn-events-connection-authparameters-basicauthparameters"></a>
The authorization parameters for Basic authorization.  
*Required*: No  
*Type*: [BasicAuthParameters](aws-properties-events-connection-basicauthparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConnectivityParameters`  <a name="cfn-events-connection-authparameters-connectivityparameters"></a>
For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.  
For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the * *Amazon EventBridge User Guide* *.  
*Required*: No  
*Type*: [ConnectivityParameters](aws-properties-events-connection-connectivityparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InvocationHttpParameters`  <a name="cfn-events-connection-authparameters-invocationhttpparameters"></a>
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.  
*Required*: No  
*Type*: [ConnectionHttpParameters](aws-properties-events-connection-connectionhttpparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OAuthParameters`  <a name="cfn-events-connection-authparameters-oauthparameters"></a>
The OAuth parameters to use for authorization.  
*Required*: No  
*Type*: [OAuthParameters](aws-properties-events-connection-oauthparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection BasicAuthParameters
<a name="aws-properties-events-connection-basicauthparameters"></a>

The Basic authorization parameters for the connection.

## Syntax
<a name="aws-properties-events-connection-basicauthparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-basicauthparameters-syntax.json"></a>

```
{
  "[Password](#cfn-events-connection-basicauthparameters-password)" : String,
  "[Username](#cfn-events-connection-basicauthparameters-username)" : String
}
```

### YAML
<a name="aws-properties-events-connection-basicauthparameters-syntax.yaml"></a>

```
  [Password](#cfn-events-connection-basicauthparameters-password): String
  [Username](#cfn-events-connection-basicauthparameters-username): String
```

## Properties
<a name="aws-properties-events-connection-basicauthparameters-properties"></a>

`Password`  <a name="cfn-events-connection-basicauthparameters-password"></a>
The password associated with the user name to use for Basic authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Username`  <a name="cfn-events-connection-basicauthparameters-username"></a>
The user name to use for Basic authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection ClientParameters
<a name="aws-properties-events-connection-clientparameters"></a>

The OAuth authorization parameters to use for the connection.

## Syntax
<a name="aws-properties-events-connection-clientparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-clientparameters-syntax.json"></a>

```
{
  "[ClientID](#cfn-events-connection-clientparameters-clientid)" : String,
  "[ClientSecret](#cfn-events-connection-clientparameters-clientsecret)" : String
}
```

### YAML
<a name="aws-properties-events-connection-clientparameters-syntax.yaml"></a>

```
  [ClientID](#cfn-events-connection-clientparameters-clientid): String
  [ClientSecret](#cfn-events-connection-clientparameters-clientsecret): String
```

## Properties
<a name="aws-properties-events-connection-clientparameters-properties"></a>

`ClientID`  <a name="cfn-events-connection-clientparameters-clientid"></a>
The client ID to use for OAuth authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientSecret`  <a name="cfn-events-connection-clientparameters-clientsecret"></a>
The client secret assciated with the client ID to use for OAuth authorization.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[ \t]*[^\x00-\x1F\x7F]+([ \t]+[^\x00-\x1F\x7F]+)*[ \t]*$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection ConnectionHttpParameters
<a name="aws-properties-events-connection-connectionhttpparameters"></a>

Any additional parameters for the connection.

## Syntax
<a name="aws-properties-events-connection-connectionhttpparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-connectionhttpparameters-syntax.json"></a>

```
{
  "[BodyParameters](#cfn-events-connection-connectionhttpparameters-bodyparameters)" : [ Parameter, ... ],
  "[HeaderParameters](#cfn-events-connection-connectionhttpparameters-headerparameters)" : [ Parameter, ... ],
  "[QueryStringParameters](#cfn-events-connection-connectionhttpparameters-querystringparameters)" : [ Parameter, ... ]
}
```

### YAML
<a name="aws-properties-events-connection-connectionhttpparameters-syntax.yaml"></a>

```
  [BodyParameters](#cfn-events-connection-connectionhttpparameters-bodyparameters): 
    - Parameter
  [HeaderParameters](#cfn-events-connection-connectionhttpparameters-headerparameters): 
    - Parameter
  [QueryStringParameters](#cfn-events-connection-connectionhttpparameters-querystringparameters): 
    - Parameter
```

## Properties
<a name="aws-properties-events-connection-connectionhttpparameters-properties"></a>

`BodyParameters`  <a name="cfn-events-connection-connectionhttpparameters-bodyparameters"></a>
Any additional body string parameters for the connection.  
*Required*: No  
*Type*: Array of [Parameter](aws-properties-events-connection-parameter.md)  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HeaderParameters`  <a name="cfn-events-connection-connectionhttpparameters-headerparameters"></a>
Any additional header parameters for the connection.  
*Required*: No  
*Type*: Array of [Parameter](aws-properties-events-connection-parameter.md)  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringParameters`  <a name="cfn-events-connection-connectionhttpparameters-querystringparameters"></a>
Any additional query string parameters for the connection.  
*Required*: No  
*Type*: Array of [Parameter](aws-properties-events-connection-parameter.md)  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection ConnectivityParameters
<a name="aws-properties-events-connection-connectivityparameters"></a>

If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

For more information, see [Authorization methods for connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html) in the * *Amazon EventBridge User Guide* *.

## Syntax
<a name="aws-properties-events-connection-connectivityparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-connectivityparameters-syntax.json"></a>

```
{
  "[ResourceParameters](#cfn-events-connection-connectivityparameters-resourceparameters)" : ResourceParameters
}
```

### YAML
<a name="aws-properties-events-connection-connectivityparameters-syntax.yaml"></a>

```
  [ResourceParameters](#cfn-events-connection-connectivityparameters-resourceparameters): 
    ResourceParameters
```

## Properties
<a name="aws-properties-events-connection-connectivityparameters-properties"></a>

`ResourceParameters`  <a name="cfn-events-connection-connectivityparameters-resourceparameters"></a>
The parameters for EventBridge to use when invoking the resource endpoint.  
*Required*: Yes  
*Type*: [ResourceParameters](aws-properties-events-connection-resourceparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection InvocationConnectivityParameters
<a name="aws-properties-events-connection-invocationconnectivityparameters"></a>

For connections to private APIs, the parameters to use for invoking the API.

For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the * *Amazon EventBridge User Guide* *.

## Syntax
<a name="aws-properties-events-connection-invocationconnectivityparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-invocationconnectivityparameters-syntax.json"></a>

```
{
  "[ResourceParameters](#cfn-events-connection-invocationconnectivityparameters-resourceparameters)" : ResourceParameters
}
```

### YAML
<a name="aws-properties-events-connection-invocationconnectivityparameters-syntax.yaml"></a>

```
  [ResourceParameters](#cfn-events-connection-invocationconnectivityparameters-resourceparameters): 
    ResourceParameters
```

## Properties
<a name="aws-properties-events-connection-invocationconnectivityparameters-properties"></a>

`ResourceParameters`  <a name="cfn-events-connection-invocationconnectivityparameters-resourceparameters"></a>
The parameters for EventBridge to use when invoking the resource endpoint.  
*Required*: Yes  
*Type*: [ResourceParameters](aws-properties-events-connection-resourceparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection OAuthParameters
<a name="aws-properties-events-connection-oauthparameters"></a>

Contains the OAuth authorization parameters to use for the connection.

## Syntax
<a name="aws-properties-events-connection-oauthparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-oauthparameters-syntax.json"></a>

```
{
  "[AuthorizationEndpoint](#cfn-events-connection-oauthparameters-authorizationendpoint)" : String,
  "[ClientParameters](#cfn-events-connection-oauthparameters-clientparameters)" : ClientParameters,
  "[HttpMethod](#cfn-events-connection-oauthparameters-httpmethod)" : String,
  "[OAuthHttpParameters](#cfn-events-connection-oauthparameters-oauthhttpparameters)" : ConnectionHttpParameters
}
```

### YAML
<a name="aws-properties-events-connection-oauthparameters-syntax.yaml"></a>

```
  [AuthorizationEndpoint](#cfn-events-connection-oauthparameters-authorizationendpoint): String
  [ClientParameters](#cfn-events-connection-oauthparameters-clientparameters): 
    ClientParameters
  [HttpMethod](#cfn-events-connection-oauthparameters-httpmethod): String
  [OAuthHttpParameters](#cfn-events-connection-oauthparameters-oauthhttpparameters): 
    ConnectionHttpParameters
```

## Properties
<a name="aws-properties-events-connection-oauthparameters-properties"></a>

`AuthorizationEndpoint`  <a name="cfn-events-connection-oauthparameters-authorizationendpoint"></a>
The URL to the authorization endpoint when OAuth is specified as the authorization type.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientParameters`  <a name="cfn-events-connection-oauthparameters-clientparameters"></a>
The client parameters for OAuth authorization.  
*Required*: Yes  
*Type*: [ClientParameters](aws-properties-events-connection-clientparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HttpMethod`  <a name="cfn-events-connection-oauthparameters-httpmethod"></a>
The method to use for the authorization request.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GET | POST | PUT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OAuthHttpParameters`  <a name="cfn-events-connection-oauthparameters-oauthhttpparameters"></a>
Details about the additional parameters to use for the connection.  
*Required*: No  
*Type*: [ConnectionHttpParameters](aws-properties-events-connection-connectionhttpparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection Parameter
<a name="aws-properties-events-connection-parameter"></a>

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

## Syntax
<a name="aws-properties-events-connection-parameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-parameter-syntax.json"></a>

```
{
  "[IsValueSecret](#cfn-events-connection-parameter-isvaluesecret)" : Boolean,
  "[Key](#cfn-events-connection-parameter-key)" : String,
  "[Value](#cfn-events-connection-parameter-value)" : String
}
```

### YAML
<a name="aws-properties-events-connection-parameter-syntax.yaml"></a>

```
  [IsValueSecret](#cfn-events-connection-parameter-isvaluesecret): Boolean
  [Key](#cfn-events-connection-parameter-key): String
  [Value](#cfn-events-connection-parameter-value): String
```

## Properties
<a name="aws-properties-events-connection-parameter-properties"></a>

`IsValueSecret`  <a name="cfn-events-connection-parameter-isvaluesecret"></a>
Specifies whether the value is secret.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Key`  <a name="cfn-events-connection-parameter-key"></a>
The key for a query string parameter.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[^\x00-\x1F\x7F]+`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-events-connection-parameter-value"></a>
The value associated with the key for the query string parameter.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[^\x00-\x09\x0B\x0C\x0E-\x1F\x7F]+`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Events::Connection ResourceParameters
<a name="aws-properties-events-connection-resourceparameters"></a>

The parameters for EventBridge to use when invoking the resource endpoint.

## Syntax
<a name="aws-properties-events-connection-resourceparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-events-connection-resourceparameters-syntax.json"></a>

```
{
  "[ResourceAssociationArn](#cfn-events-connection-resourceparameters-resourceassociationarn)" : String,
  "[ResourceConfigurationArn](#cfn-events-connection-resourceparameters-resourceconfigurationarn)" : String
}
```

### YAML
<a name="aws-properties-events-connection-resourceparameters-syntax.yaml"></a>

```
  [ResourceAssociationArn](#cfn-events-connection-resourceparameters-resourceassociationarn): String
  [ResourceConfigurationArn](#cfn-events-connection-resourceparameters-resourceconfigurationarn): String
```

## Properties
<a name="aws-properties-events-connection-resourceparameters-properties"></a>

`ResourceAssociationArn`  <a name="cfn-events-connection-resourceparameters-resourceassociationarn"></a>
For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.  
The value of this property is set by EventBridge. Any value you specify in your template is ignored.
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:servicenetworkresourceassociation/snra-[0-9a-z]{17}$`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceConfigurationArn`  <a name="cfn-events-connection-resourceparameters-resourceconfigurationarn"></a>
The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}$`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)