interface OAuthAuthorizationProps

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

Properties for Authorization.oauth().

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_events as events } from 'aws-cdk-lib';

declare const httpParameter: events.HttpParameter;
declare const secretValue: cdk.SecretValue;
const oAuthAuthorizationProps: events.OAuthAuthorizationProps = {
  authorizationEndpoint: 'authorizationEndpoint',
  clientId: 'clientId',
  clientSecret: secretValue,
  httpMethod: events.HttpMethod.POST,

  // the properties below are optional
  bodyParameters: {
    bodyParametersKey: httpParameter,
  },
  headerParameters: {
    headerParametersKey: httpParameter,
  },
  queryStringParameters: {
    queryStringParametersKey: httpParameter,
  },
};

Properties

Name	Type	Description
authorizationEndpoint	string	The URL to the authorization endpoint.
clientId	string	The client ID to use for OAuth authorization for the connection.
clientSecret	SecretValue	The client secret associated with the client ID to use for OAuth authorization for the connection.
httpMethod	HttpMethod	The method to use for the authorization request.
bodyParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the OAuth request body.
headerParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the OAuth request header.
queryStringParameters?	{ [string]: HttpParameter }	Additional string parameters to add to the OAuth request query string.

---

authorizationEndpoint

Type: string

The URL to the authorization endpoint.

---

clientId

Type: string

The client ID to use for OAuth authorization for the connection.

---

clientSecret

Type: SecretValue

The client secret associated with the client ID to use for OAuth authorization for the connection.

---

httpMethod

Type: HttpMethod

The method to use for the authorization request.

(Can only choose POST, GET or PUT).

---

bodyParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the OAuth request body.

---

headerParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the OAuth request header.

---

queryStringParameters?

Type: { [string]: HttpParameter } (optional, default: No additional parameters)

Additional string parameters to add to the OAuth request query string.