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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnConnectorProfile.CustomConnectorProfileCredentialsProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The API keys required for the authentication of the user.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
If the connector uses the custom authentication mechanism, this holds the required credentials.default Object
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
The authentication type that the custom connector uses for authenticating while creating a connector profile.- See Also:
-
getApiKey
The API keys required for the authentication of the user.- See Also:
-
getBasic
The basic credentials that are required for the authentication of the user.- See Also:
-
getCustom
If the connector uses the custom authentication mechanism, this holds the required credentials.- See Also:
-
getOauth2
The OAuth 2.0 credentials required for the authentication of the user.- See Also:
-
builder
@Stability(Stable) static CfnConnectorProfile.CustomConnectorProfileCredentialsProperty.Builder builder()
-