@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.338Z") @Stability(value=Stable) public interface CfnConnectorProfileProps extends software.amazon.jsii.JsiiSerializable
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.*;
Object credentialsMap;
Object oAuthCredentials;
Object profileProperties;
Object tokenUrlCustomProperties;
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(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())
.redshift(RedshiftConnectorProfileCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.salesforce(SalesforceConnectorProfileCredentialsProperty.builder()
.accessToken("accessToken")
.clientCredentialsArn("clientCredentialsArn")
.connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
.authCode("authCode")
.redirectUri("redirectUri")
.build())
.refreshToken("refreshToken")
.build())
.sapoData(SAPODataConnectorProfileCredentialsProperty.builder()
.basicAuthCredentials(BasicAuthCredentialsProperty.builder()
.password("password")
.username("username")
.build())
.oAuthCredentials(oAuthCredentials)
.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())
// the properties below are optional
.connectorProfileProperties(ConnectorProfilePropertiesProperty.builder()
.customConnector(CustomConnectorProfilePropertiesProperty.builder()
.oAuth2Properties(OAuth2PropertiesProperty.builder()
.oAuth2GrantType("oAuth2GrantType")
.tokenUrl("tokenUrl")
.tokenUrlCustomProperties(tokenUrlCustomProperties)
.build())
.profileProperties(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())
.redshift(RedshiftConnectorProfilePropertiesProperty.builder()
.bucketName("bucketName")
.databaseUrl("databaseUrl")
.roleArn("roleArn")
// the properties below are optional
.bucketPrefix("bucketPrefix")
.build())
.salesforce(SalesforceConnectorProfilePropertiesProperty.builder()
.instanceUrl("instanceUrl")
.isSandboxEnvironment(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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnConnectorProfileProps.Builder
A builder for
CfnConnectorProfileProps |
static class |
CfnConnectorProfileProps.Jsii$Proxy
An implementation for
CfnConnectorProfileProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnConnectorProfileProps.Builder |
builder() |
String |
getConnectionMode()
Indicates the connection mode and if it is public or private.
|
default String |
getConnectorLabel()
`AWS::AppFlow::ConnectorProfile.ConnectorLabel`.
|
default Object |
getConnectorProfileConfig()
Defines the connector-specific configuration and credentials.
|
String |
getConnectorProfileName()
The name of the connector profile.
|
String |
getConnectorType()
The type of connector, such as Salesforce, Amplitude, and so on.
|
default String |
getKmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
@Stability(value=Stable) @NotNull String getConnectionMode()
@Stability(value=Stable) @NotNull String getConnectorProfileName()
The name is unique for each ConnectorProfile in the AWS account .
@Stability(value=Stable) @NotNull String getConnectorType()
@Stability(value=Stable) @Nullable default String getConnectorLabel()
@Stability(value=Stable) @Nullable default Object getConnectorProfileConfig()
@Stability(value=Stable) @Nullable default String getKmsArn()
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.
@Stability(value=Stable) static CfnConnectorProfileProps.Builder builder()
CfnConnectorProfileProps.Builder of CfnConnectorProfilePropsCopyright © 2022. All rights reserved.