interface OAuthParametersProperty

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

Contains the OAuth authorization parameters to use for the connection.

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 oAuthParametersProperty: events.CfnConnection.OAuthParametersProperty = {
  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,
    }],
  },
};

Properties

Name	Type	Description
authorizationEndpoint	`string`	The URL to the authorization endpoint when OAuth is specified as the authorization type.
clientParameters	`IResolvable` `\|` `ClientParametersProperty`	The client parameters for OAuth authorization.
httpMethod	`string`	The method to use for the authorization request.
oAuthHttpParameters?	`IResolvable` `\|` `ConnectionHttpParametersProperty`	Details about the additional parameters to use for the connection.

authorizationEndpoint

Type: string

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

clientParameters

Type: IResolvable | ClientParametersProperty

The client parameters for OAuth authorization.

httpMethod

Type: string

The method to use for the authorization request.

oAuthHttpParameters?

Type: IResolvable | ConnectionHttpParametersProperty (optional)

Details about the additional parameters to use for the connection.