Interface CfnConnectorProfileProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConnectorProfileProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:29:55.561Z")
@Stability(Stable)
public interface CfnConnectorProfileProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnConnectorProfile.
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.*;
CfnConnectorProfileProps cfnConnectorProfileProps = CfnConnectorProfileProps.builder()
.connectionMode("connectionMode")
.connectorProfileName("connectorProfileName")
.connectorType("connectorType")
// the properties below are optional
.connectorLabel("connectorLabel")
.connectorProfileConfig(ConnectorProfileConfigProperty.builder()
.connectorProfileCredentials(ConnectorProfileCredentialsProperty.builder()
.amplitude(AmplitudeConnectorProfileCredentialsProperty.builder()
.apiKey("apiKey")
.secretKey("secretKey")
.build())
.customConnector(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())
.datadog(DatadogConnectorProfileCredentialsProperty.builder()
.apiKey("apiKey")
.applicationKey("applicationKey")
.build())
.dynatrace(DynatraceConnectorProfileCredentialsProperty.builder()
.apiToken("apiToken")
.build())
.googleAnalytics(GoogleAnalyticsConnectorProfileCredentialsProperty.builder()
.clientId("clientId")
.clientSecret("clientSecret")
// the properties below are optional
.accessToken("accessToken")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.refreshToken("refreshToken")
.build())
.inforNexus(InforNexusConnectorProfileCredentialsProperty.builder()
.accessKeyId("accessKeyId")
.datakey("datakey")
.secretAccessKey("secretAccessKey")
.userId("userId")
.build())
.marketo(MarketoConnectorProfileCredentialsProperty.builder()
.clientId("clientId")
.clientSecret("clientSecret")
// the properties below are optional
.accessToken("accessToken")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.build())
.pardot(PardotConnectorProfileCredentialsProperty.builder()
.accessToken("accessToken")
.clientCredentialsArn("clientCredentialsArn")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.refreshToken("refreshToken")
.build())
.redshift(RedshiftConnectorProfileCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.salesforce(SalesforceConnectorProfileCredentialsProperty.builder()
.accessToken("accessToken")
.clientCredentialsArn("clientCredentialsArn")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.jwtToken("jwtToken")
.oAuth2GrantType("oAuth2GrantType")
.refreshToken("refreshToken")
.build())
.sapoData(SAPODataConnectorProfileCredentialsProperty.builder()
.basicAuthCredentials(BasicAuthCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.oAuthCredentials(OAuthCredentialsProperty.builder()
.accessToken("accessToken")
.clientId("clientId")
.clientSecret("clientSecret")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.refreshToken("refreshToken")
.build())
.build())
.serviceNow(ServiceNowConnectorProfileCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.singular(SingularConnectorProfileCredentialsProperty.builder()
.apiKey("apiKey")
.build())
.slack(SlackConnectorProfileCredentialsProperty.builder()
.clientId("clientId")
.clientSecret("clientSecret")
// the properties below are optional
.accessToken("accessToken")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.build())
.snowflake(SnowflakeConnectorProfileCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.trendmicro(TrendmicroConnectorProfileCredentialsProperty.builder()
.apiSecretKey("apiSecretKey")
.build())
.veeva(VeevaConnectorProfileCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.zendesk(ZendeskConnectorProfileCredentialsProperty.builder()
.clientId("clientId")
.clientSecret("clientSecret")
// the properties below are optional
.accessToken("accessToken")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.build())
.build())
.connectorProfileProperties(ConnectorProfilePropertiesProperty.builder()
.customConnector(CustomConnectorProfilePropertiesProperty.builder()
.oAuth2Properties(OAuth2PropertiesProperty.builder()
.oAuth2GrantType("oAuth2GrantType")
.tokenUrl("tokenUrl")
.tokenUrlCustomProperties(Map.of(
"tokenUrlCustomPropertiesKey", "tokenUrlCustomProperties"))
.build())
.profileProperties(Map.of(
"profilePropertiesKey", "profileProperties"))
.build())
.datadog(DatadogConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.dynatrace(DynatraceConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.inforNexus(InforNexusConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.marketo(MarketoConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.pardot(PardotConnectorProfilePropertiesProperty.builder()
.businessUnitId("businessUnitId")
// the properties below are optional
.instanceUrl("instanceUrl")
.isSandboxEnvironment(false)
.build())
.redshift(RedshiftConnectorProfilePropertiesProperty.builder()
.bucketName("bucketName")
.roleArn("roleArn")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.clusterIdentifier("clusterIdentifier")
.dataApiRoleArn("dataApiRoleArn")
.databaseName("databaseName")
.databaseUrl("databaseUrl")
.isRedshiftServerless(false)
.workgroupName("workgroupName")
.build())
.salesforce(SalesforceConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.isSandboxEnvironment(false)
.usePrivateLinkForMetadataAndAuthorization(false)
.build())
.sapoData(SAPODataConnectorProfilePropertiesProperty.builder()
.applicationHostUrl("applicationHostUrl")
.applicationServicePath("applicationServicePath")
.clientNumber("clientNumber")
.logonLanguage("logonLanguage")
.oAuthProperties(OAuthPropertiesProperty.builder()
.authCodeUrl("authCodeUrl")
.oAuthScopes(List.of("oAuthScopes"))
.tokenUrl("tokenUrl")
.build())
.portNumber(123)
.privateLinkServiceName("privateLinkServiceName")
.build())
.serviceNow(ServiceNowConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.slack(SlackConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.snowflake(SnowflakeConnectorProfilePropertiesProperty.builder()
.bucketName("bucketName")
.stage("stage")
.warehouse("warehouse")
// the properties below are optional
.accountName("accountName")
.bucketPrefix("bucketPrefix")
.privateLinkServiceName("privateLinkServiceName")
.region("region")
.build())
.veeva(VeevaConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.zendesk(ZendeskConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.build())
.build())
.build())
.kmsArn("kmsArn")
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnConnectorProfilePropsstatic final classAn implementation forCfnConnectorProfileProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Indicates the connection mode and if it is public or private.default StringThe label for the connector profile being created.default ObjectDefines the connector-specific configuration and credentials.The name of the connector profile.The type of connector, such as Salesforce, Amplitude, and so on.default StringThe ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConnectionMode
Indicates the connection mode and if it is public or private. -
getConnectorProfileName
The name of the connector profile.The name is unique for each
ConnectorProfilein the AWS account . -
getConnectorType
The type of connector, such as Salesforce, Amplitude, and so on. -
getConnectorLabel
The label for the connector profile being created. -
getConnectorProfileConfig
Defines the connector-specific configuration and credentials. -
getKmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
-
builder
- Returns:
- a
CfnConnectorProfileProps.BuilderofCfnConnectorProfileProps
-