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

Interface CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfilePropsMixin

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

The connector-specific profile credentials that are required when using the custom connector.

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.*;
 CustomConnectorProfileCredentialsProperty customConnectorProfileCredentialsProperty = CustomConnectorProfileCredentialsProperty.builder()
         .apiKey(ApiKeyCredentialsProperty.builder()
                 .apiKey("apiKey")
                 .apiSecretKey("apiSecretKey")
                 .build())
         .authenticationType("authenticationType")
         .basic(BasicAuthCredentialsProperty.builder()
                 .password("password")
                 .username("username")
                 .build())
         .custom(CustomAuthCredentialsProperty.builder()
                 .credentialsMap(Map.of(
                         "credentialsMapKey", "credentialsMap"))
                 .customAuthenticationType("customAuthenticationType")
                 .build())
         .oauth2(OAuth2CredentialsProperty.builder()
                 .accessToken("accessToken")
                 .clientId("clientId")
                 .clientSecret("clientSecret")
                 .oAuthRequest(ConnectorOAuthRequestProperty.builder()
                         .authCode("authCode")
                         .redirectUri("redirectUri")
                         .build())
                 .refreshToken("refreshToken")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty.Builder	builder()
default Object	getApiKey()	The API keys required for the authentication of the user.
default String	getAuthenticationType()	The authentication type that the custom connector uses for authenticating while creating a connector profile.
default Object	getBasic()	The basic credentials that are required for the authentication of the user.
default Object	getCustom()	If the connector uses the custom authentication mechanism, this holds the required credentials.
default Object	getOauth2()	The OAuth 2.0 credentials required for the authentication of the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKey

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

The API keys required for the authentication of the user.

Returns union: either IResolvable or CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty

See Also:

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

getAuthenticationType

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

The authentication type that the custom connector uses for authenticating while creating a connector profile.

See Also:

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

getBasic

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

The basic credentials that are required for the authentication of the user.

Returns union: either IResolvable or CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty

See Also:

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

getCustom

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

If the connector uses the custom authentication mechanism, this holds the required credentials.

Returns union: either IResolvable or CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty

See Also:

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

getOauth2

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

The OAuth 2.0 credentials required for the authentication of the user.

Returns union: either IResolvable or CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty

See Also:

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

builder

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

Returns:

a CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty.Builder of CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty