aws-cdk-lib.aws_appflow.CfnConnectorProfile.OAuth2CredentialsProperty

interface OAuth2CredentialsProperty

LanguageType name
.NETAmazon.CDK.AWS.AppFlow.CfnConnectorProfile.OAuth2CredentialsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappflow#CfnConnectorProfile_OAuth2CredentialsProperty
Javasoftware.amazon.awscdk.services.appflow.CfnConnectorProfile.OAuth2CredentialsProperty
Pythonaws_cdk.aws_appflow.CfnConnectorProfile.OAuth2CredentialsProperty
TypeScript aws-cdk-lib » aws_appflow » CfnConnectorProfile » OAuth2CredentialsProperty

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appflow as appflow } from 'aws-cdk-lib';
const oAuth2CredentialsProperty: appflow.CfnConnectorProfile.OAuth2CredentialsProperty = {
  accessToken: 'accessToken',
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  oAuthRequest: {
    authCode: 'authCode',
    redirectUri: 'redirectUri',
  },
  refreshToken: 'refreshToken',
};

Properties

NameTypeDescription
accessToken?stringThe access token used to access the connector on your behalf.
clientId?stringThe identifier for the desired client.
clientSecret?stringThe client secret used by the OAuth client to authenticate to the authorization server.
oAuthRequest?IResolvable | ConnectorOAuthRequestPropertyCfnConnectorProfile.OAuth2CredentialsProperty.OAuthRequest.
refreshToken?stringThe refresh token used to refresh an expired access token.

accessToken?

Type: string (optional)

The access token used to access the connector on your behalf.


clientId?

Type: string (optional)

The identifier for the desired client.


clientSecret?

Type: string (optional)

The client secret used by the OAuth client to authenticate to the authorization server.


oAuthRequest?

Type: IResolvable | ConnectorOAuthRequestProperty (optional)

CfnConnectorProfile.OAuth2CredentialsProperty.OAuthRequest.


refreshToken?

Type: string (optional)

The refresh token used to refresh an expired access token.