Package software.amazon.awscdk.services.appflow

Interface CfnConnectorProfile.OAuth2CredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfile.OAuth2CredentialsProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfile

@Stability(Stable)
public static interface CfnConnectorProfile.OAuth2CredentialsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.appflow.*;
 OAuth2CredentialsProperty oAuth2CredentialsProperty = OAuth2CredentialsProperty.builder()
         .accessToken("accessToken")
         .clientId("clientId")
         .clientSecret("clientSecret")
         .oAuthRequest(ConnectorOAuthRequestProperty.builder()
                 .authCode("authCode")
                 .redirectUri("redirectUri")
                 .build())
         .refreshToken("refreshToken")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorProfile.OAuth2CredentialsProperty.Builder	A builder for CfnConnectorProfile.OAuth2CredentialsProperty
static final class	CfnConnectorProfile.OAuth2CredentialsProperty.Jsii$Proxy	An implementation for CfnConnectorProfile.OAuth2CredentialsProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfile.OAuth2CredentialsProperty.Builder	builder()
default String	getAccessToken()	The access token used to access the connector on your behalf.
default String	getClientId()	The identifier for the desired client.
default String	getClientSecret()	The client secret used by the OAuth client to authenticate to the authorization server.
default Object	getOAuthRequest()	Returns union: either IResolvable or CfnConnectorProfile.ConnectorOAuthRequestProperty
default String	getRefreshToken()	The refresh token used to refresh an expired access token.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessToken

@Stability(Stable)
@Nullable
default String getAccessToken()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-accesstoken

getClientId

@Stability(Stable)
@Nullable
default String getClientId()

The identifier for the desired client.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientid

getClientSecret

@Stability(Stable)
@Nullable
default String getClientSecret()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientsecret

getOAuthRequest

@Stability(Stable)
@Nullable
default Object getOAuthRequest()

Returns union: either IResolvable or CfnConnectorProfile.ConnectorOAuthRequestProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-oauthrequest

getRefreshToken

@Stability(Stable)
@Nullable
default String getRefreshToken()

The refresh token used to refresh an expired access token.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-refreshtoken

builder

@Stability(Stable)
static CfnConnectorProfile.OAuth2CredentialsProperty.Builder builder()

Returns:

a CfnConnectorProfile.OAuth2CredentialsProperty.Builder of CfnConnectorProfile.OAuth2CredentialsProperty