interface CfnConnectionProps

Language	Type name
.NET	Amazon.CDK.AWS.Events.CfnConnectionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnConnectionProps
Java	software.amazon.awscdk.services.events.CfnConnectionProps
Python	aws_cdk.aws_events.CfnConnectionProps
TypeScript	aws-cdk-lib » aws_events » CfnConnectionProps

Properties for defining a CfnConnection.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const cfnConnectionProps: events.CfnConnectionProps = {
  authorizationType: 'authorizationType',
  authParameters: {
    apiKeyAuthParameters: {
      apiKeyName: 'apiKeyName',
      apiKeyValue: 'apiKeyValue',
    },
    basicAuthParameters: {
      password: 'password',
      username: 'username',
    },
    invocationHttpParameters: {
      bodyParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
      headerParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
      queryStringParameters: [{
        key: 'key',
        value: 'value',

        // the properties below are optional
        isValueSecret: false,
      }],
    },
    oAuthParameters: {
      authorizationEndpoint: 'authorizationEndpoint',
      clientParameters: {
        clientId: 'clientId',
        clientSecret: 'clientSecret',
      },
      httpMethod: 'httpMethod',

      // the properties below are optional
      oAuthHttpParameters: {
        bodyParameters: [{
          key: 'key',
          value: 'value',

          // the properties below are optional
          isValueSecret: false,
        }],
        headerParameters: [{
          key: 'key',
          value: 'value',

          // the properties below are optional
          isValueSecret: false,
        }],
        queryStringParameters: [{
          key: 'key',
          value: 'value',

          // the properties below are optional
          isValueSecret: false,
        }],
      },
    },
  },
  description: 'description',
  name: 'name',
};

Properties

Name	Type	Description
authParameters?	IResolvable | AuthParametersProperty	A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
authorizationType?	string	The type of authorization to use for the connection.
description?	string	A description for the connection to create.
name?	string	The name for the connection to create.

---

authParameters?

Type: IResolvable | AuthParametersProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authparameters

---

authorizationType?

Type: string (optional)

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

---

description?

Type: string (optional)

A description for the connection to create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

---

name?

Type: string (optional)

The name for the connection to create.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name