aws-cdk-lib.aws_events.CfnConnection.OAuthParametersProperty

OAuthParametersProperty Struct

Contains the OAuth authorization parameters to use for the connection.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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

authorizationEndpointstringauthorization_endpointstrauthorizationEndpointStringAuthorizationEndpointstringAuthorizationEndpoint*stringrequired#

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

clientParametersIResolvable | CfnConnection.ClientParametersPropertyclient_parameterstyping.Union[IResolvable, ClientParametersProperty]clientParametersIResolvableClientParametersIResolvableClientParametersinterface{}required#

The client parameters for OAuth authorization.

httpMethodstringhttp_methodstrhttpMethodStringHttpMethodstringHttpMethod*stringrequired#

The method to use for the authorization request.

oAuthHttpParameters?optionalIResolvable | CfnConnection.ConnectionHttpParametersPropertyo_auth_http_parameters?optionaltyping.Union[IResolvable, ConnectionHttpParametersProperty]oAuthHttpParameters?optionalIResolvableOAuthHttpParameters?optionalIResolvableOAuthHttpParameters?optionalinterface{}#

Details about the additional parameters to use for the connection.