aws-cdk-lib.aws_events.CfnConnectionProps

interface CfnConnectionProps

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnConnectionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnConnectionProps
Javasoftware.amazon.awscdk.services.events.CfnConnectionProps
Pythonaws_cdk.aws_events.CfnConnectionProps
TypeScript aws-cdk-lib » aws_events » CfnConnectionProps

Properties for defining a CfnConnection.

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,
        }],
      },
    },
  },

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

Properties

NameTypeDescription
authParametersIResolvable | AuthParametersPropertyA CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
authorizationTypestringThe type of authorization to use for the connection.
description?stringA description for the connection to create.
name?stringThe name for the connection to create.

authParameters

Type: IResolvable | AuthParametersProperty

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


authorizationType

Type: string

The type of authorization to use for the connection.

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


description?

Type: string (optional)

A description for the connection to create.


name?

Type: string (optional)

The name for the connection to create.