Interface ICfnConnectorProfileProps
Properties for defining a CfnConnectorProfile
.
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConnectorProfileProps
Syntax (vb)
Public Interface ICfnConnectorProfileProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var cfnConnectorProfileProps = new CfnConnectorProfileProps {
ConnectionMode = "connectionMode",
ConnectorProfileName = "connectorProfileName",
ConnectorType = "connectorType",
// the properties below are optional
ConnectorLabel = "connectorLabel",
ConnectorProfileConfig = new ConnectorProfileConfigProperty {
ConnectorProfileCredentials = new ConnectorProfileCredentialsProperty {
Amplitude = new AmplitudeConnectorProfileCredentialsProperty {
ApiKey = "apiKey",
SecretKey = "secretKey"
},
CustomConnector = new CustomConnectorProfileCredentialsProperty {
AuthenticationType = "authenticationType",
// the properties below are optional
ApiKey = new ApiKeyCredentialsProperty {
ApiKey = "apiKey",
// the properties below are optional
ApiSecretKey = "apiSecretKey"
},
Basic = new BasicAuthCredentialsProperty {
Password = "password",
Username = "username"
},
Custom = new CustomAuthCredentialsProperty {
CustomAuthenticationType = "customAuthenticationType",
// the properties below are optional
CredentialsMap = new Dictionary<string, string> {
{ "credentialsMapKey", "credentialsMap" }
}
},
Oauth2 = new OAuth2CredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
OAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
}
},
Datadog = new DatadogConnectorProfileCredentialsProperty {
ApiKey = "apiKey",
ApplicationKey = "applicationKey"
},
Dynatrace = new DynatraceConnectorProfileCredentialsProperty {
ApiToken = "apiToken"
},
GoogleAnalytics = new GoogleAnalyticsConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
InforNexus = new InforNexusConnectorProfileCredentialsProperty {
AccessKeyId = "accessKeyId",
Datakey = "datakey",
SecretAccessKey = "secretAccessKey",
UserId = "userId"
},
Marketo = new MarketoConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
},
Pardot = new PardotConnectorProfileCredentialsProperty {
AccessToken = "accessToken",
ClientCredentialsArn = "clientCredentialsArn",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
Redshift = new RedshiftConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Salesforce = new SalesforceConnectorProfileCredentialsProperty {
AccessToken = "accessToken",
ClientCredentialsArn = "clientCredentialsArn",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
JwtToken = "jwtToken",
OAuth2GrantType = "oAuth2GrantType",
RefreshToken = "refreshToken"
},
SapoData = new SAPODataConnectorProfileCredentialsProperty {
BasicAuthCredentials = new BasicAuthCredentialsProperty {
Password = "password",
Username = "username"
},
OAuthCredentials = new OAuthCredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
}
},
ServiceNow = new ServiceNowConnectorProfileCredentialsProperty {
OAuth2Credentials = new OAuth2CredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
OAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
Password = "password",
Username = "username"
},
Singular = new SingularConnectorProfileCredentialsProperty {
ApiKey = "apiKey"
},
Slack = new SlackConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
},
Snowflake = new SnowflakeConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Trendmicro = new TrendmicroConnectorProfileCredentialsProperty {
ApiSecretKey = "apiSecretKey"
},
Veeva = new VeevaConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Zendesk = new ZendeskConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
}
},
ConnectorProfileProperties = new ConnectorProfilePropertiesProperty {
CustomConnector = new CustomConnectorProfilePropertiesProperty {
OAuth2Properties = new OAuth2PropertiesProperty {
OAuth2GrantType = "oAuth2GrantType",
TokenUrl = "tokenUrl",
TokenUrlCustomProperties = new Dictionary<string, string> {
{ "tokenUrlCustomPropertiesKey", "tokenUrlCustomProperties" }
}
},
ProfileProperties = new Dictionary<string, string> {
{ "profilePropertiesKey", "profileProperties" }
}
},
Datadog = new DatadogConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Dynatrace = new DynatraceConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
InforNexus = new InforNexusConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Marketo = new MarketoConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Pardot = new PardotConnectorProfilePropertiesProperty {
BusinessUnitId = "businessUnitId",
// the properties below are optional
InstanceUrl = "instanceUrl",
IsSandboxEnvironment = false
},
Redshift = new RedshiftConnectorProfilePropertiesProperty {
BucketName = "bucketName",
RoleArn = "roleArn",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ClusterIdentifier = "clusterIdentifier",
DataApiRoleArn = "dataApiRoleArn",
DatabaseName = "databaseName",
DatabaseUrl = "databaseUrl",
IsRedshiftServerless = false,
WorkgroupName = "workgroupName"
},
Salesforce = new SalesforceConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl",
IsSandboxEnvironment = false,
UsePrivateLinkForMetadataAndAuthorization = false
},
SapoData = new SAPODataConnectorProfilePropertiesProperty {
ApplicationHostUrl = "applicationHostUrl",
ApplicationServicePath = "applicationServicePath",
ClientNumber = "clientNumber",
DisableSso = false,
LogonLanguage = "logonLanguage",
OAuthProperties = new OAuthPropertiesProperty {
AuthCodeUrl = "authCodeUrl",
OAuthScopes = new [] { "oAuthScopes" },
TokenUrl = "tokenUrl"
},
PortNumber = 123,
PrivateLinkServiceName = "privateLinkServiceName"
},
ServiceNow = new ServiceNowConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Slack = new SlackConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Snowflake = new SnowflakeConnectorProfilePropertiesProperty {
BucketName = "bucketName",
Stage = "stage",
Warehouse = "warehouse",
// the properties below are optional
AccountName = "accountName",
BucketPrefix = "bucketPrefix",
PrivateLinkServiceName = "privateLinkServiceName",
Region = "region"
},
Veeva = new VeevaConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Zendesk = new ZendeskConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
}
}
},
KmsArn = "kmsArn"
};
Synopsis
Properties
ConnectionMode | Indicates the connection mode and if it is public or private. |
ConnectorLabel | The label for the connector profile being created. |
ConnectorProfileConfig | Defines the connector-specific configuration and credentials. |
ConnectorProfileName | The name of the connector profile. |
ConnectorType | The type of connector, such as Salesforce, Amplitude, and so on. |
KmsArn | The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. |
Properties
ConnectionMode
Indicates the connection mode and if it is public or private.
string ConnectionMode { get; }
Property Value
System.String
Remarks
ConnectorLabel
The label for the connector profile being created.
virtual string ConnectorLabel { get; }
Property Value
System.String
Remarks
ConnectorProfileConfig
Defines the connector-specific configuration and credentials.
virtual object ConnectorProfileConfig { get; }
Property Value
System.Object
Remarks
ConnectorProfileName
The name of the connector profile.
string ConnectorProfileName { get; }
Property Value
System.String
Remarks
The name is unique for each ConnectorProfile
in the AWS account .
ConnectorType
The type of connector, such as Salesforce, Amplitude, and so on.
string ConnectorType { get; }
Property Value
System.String
Remarks
KmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
virtual string KmsArn { get; }
Property Value
System.String
Remarks
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.