Package software.amazon.awscdk.cfnpropertymixins.services.appflow

Interface CfnConnectorProfilePropsMixin.OAuthCredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfilePropsMixin.OAuthCredentialsProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfilePropsMixin

@Stability(Stable)
public static interface CfnConnectorProfilePropsMixin.OAuthCredentialsProperty
extends software.amazon.jsii.JsiiSerializable

The OAuth credentials required for OAuth type 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.cfnpropertymixins.services.appflow.*;
 OAuthCredentialsProperty oAuthCredentialsProperty = OAuthCredentialsProperty.builder()
         .accessToken("accessToken")
         .clientId("clientId")
         .clientSecret("clientSecret")
         .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                 .authCode("authCode")
                 .redirectUri("redirectUri")
                 .build())
         .refreshToken("refreshToken")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfilePropsMixin.OAuthCredentialsProperty.Builder	builder()
default String	getAccessToken()	The access token used to access protected SAPOData resources.
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	getConnectorOAuthRequest()	Returns union: either IResolvable or CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty
default String	getRefreshToken()	The refresh token used to refresh 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 protected SAPOData resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-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-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-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-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-clientsecret

getConnectorOAuthRequest

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

Returns union: either IResolvable or CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty

See Also:

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

getRefreshToken

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

The refresh token used to refresh expired access token.

See Also:

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

builder

@Stability(Stable)
static CfnConnectorProfilePropsMixin.OAuthCredentialsProperty.Builder builder()

Returns:

a CfnConnectorProfilePropsMixin.OAuthCredentialsProperty.Builder of CfnConnectorProfilePropsMixin.OAuthCredentialsProperty