Package software.amazon.awscdk.services.appflow

Interface CfnConnectorProfile.CustomConnectorProfileCredentialsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorProfile.CustomConnectorProfileCredentialsProperty.Jsii$Proxy

Enclosing class:

CfnConnectorProfile

@Stability(Stable)
public static interface CfnConnectorProfile.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.services.appflow.*;
 CustomConnectorProfileCredentialsProperty customConnectorProfileCredentialsProperty = CustomConnectorProfileCredentialsProperty.builder()
         .authenticationType("authenticationType")
         // the properties below are optional
         .apiKey(ApiKeyCredentialsProperty.builder()
                 .apiKey("apiKey")
                 // the properties below are optional
                 .apiSecretKey("apiSecretKey")
                 .build())
         .basic(BasicAuthCredentialsProperty.builder()
                 .password("password")
                 .username("username")
                 .build())
         .custom(CustomAuthCredentialsProperty.builder()
                 .customAuthenticationType("customAuthenticationType")
                 // the properties below are optional
                 .credentialsMap(Map.of(
                         "credentialsMapKey", "credentialsMap"))
                 .build())
         .oauth2(OAuth2CredentialsProperty.builder()
                 .accessToken("accessToken")
                 .clientId("clientId")
                 .clientSecret("clientSecret")
                 .oAuthRequest(ConnectorOAuthRequestProperty.builder()
                         .authCode("authCode")
                         .redirectUri("redirectUri")
                         .build())
                 .refreshToken("refreshToken")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnectorProfile.CustomConnectorProfileCredentialsProperty.Builder	builder()
default Object	getApiKey()	The API keys required for the authentication of the user.
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

getAuthenticationType

@Stability(Stable)
@NotNull
String getAuthenticationType()

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

getApiKey

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

The API keys required for the authentication of the user.

getBasic

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

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

getCustom

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

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

getOauth2

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

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

builder

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

Returns:

a CfnConnectorProfile.CustomConnectorProfileCredentialsProperty.Builder of CfnConnectorProfile.CustomConnectorProfileCredentialsProperty