CfnConnectorProfileMixinProps
- class aws_cdk.mixins_preview.aws_appflow.mixins.CfnConnectorProfileMixinProps(*, connection_mode=None, connector_label=None, connector_profile_config=None, connector_profile_name=None, connector_type=None, kms_arn=None)
Bases:
objectProperties for CfnConnectorProfilePropsMixin.
- Parameters:
connection_mode (
Optional[str]) – Indicates the connection mode and if it is public or private.connector_label (
Optional[str]) – The label for the connector profile being created.connector_profile_config (
Union[IResolvable,ConnectorProfileConfigProperty,Dict[str,Any],None]) – Defines the connector-specific configuration and credentials.connector_profile_name (
Optional[str]) – The name of the connector profile. The name is unique for eachConnectorProfilein the AWS account .connector_type (
Optional[str]) – The type of connector, such as Salesforce, Amplitude, and so on.kms_arn (
Optional[str]) – 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.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_appflow import mixins as appflow_mixins cfn_connector_profile_mixin_props = appflow_mixins.CfnConnectorProfileMixinProps( connection_mode="connectionMode", connector_label="connectorLabel", connector_profile_config=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileConfigProperty( connector_profile_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty( amplitude=appflow_mixins.CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty( api_key="apiKey", secret_key="secretKey" ), custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty( api_key=appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty( api_key="apiKey", api_secret_key="apiSecretKey" ), authentication_type="authenticationType", basic=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty( password="password", username="username" ), custom=appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty( credentials_map={ "credentials_map_key": "credentialsMap" }, custom_authentication_type="customAuthenticationType" ), oauth2=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ) ), datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty( api_key="apiKey", application_key="applicationKey" ), dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty( api_token="apiToken" ), google_analytics=appflow_mixins.CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty( access_key_id="accessKeyId", datakey="datakey", secret_access_key="secretAccessKey", user_id="userId" ), marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty( password="password", username="username" ), salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty( access_token="accessToken", client_credentials_arn="clientCredentialsArn", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), jwt_token="jwtToken", o_auth2_grant_type="oAuth2GrantType", refresh_token="refreshToken" ), sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty( basic_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty( password="password", username="username" ), o_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ) ), service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty( o_auth2_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ), refresh_token="refreshToken" ), password="password", username="username" ), singular=appflow_mixins.CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty( api_key="apiKey" ), slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ), snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty( password="password", username="username" ), trendmicro=appflow_mixins.CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty( api_secret_key="apiSecretKey" ), veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty( password="password", username="username" ), zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty( access_token="accessToken", client_id="clientId", client_secret="clientSecret", connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty( auth_code="authCode", redirect_uri="redirectUri" ) ) ), connector_profile_properties=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty( custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty( o_auth2_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty( o_auth2_grant_type="oAuth2GrantType", token_url="tokenUrl", token_url_custom_properties={ "token_url_custom_properties_key": "tokenUrlCustomProperties" } ), profile_properties={ "profile_properties_key": "profileProperties" } ), datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty( business_unit_id="businessUnitId", instance_url="instanceUrl", is_sandbox_environment=False ), redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty( bucket_name="bucketName", bucket_prefix="bucketPrefix", cluster_identifier="clusterIdentifier", data_api_role_arn="dataApiRoleArn", database_name="databaseName", database_url="databaseUrl", is_redshift_serverless=False, role_arn="roleArn", workgroup_name="workgroupName" ), salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty( instance_url="instanceUrl", is_sandbox_environment=False, use_private_link_for_metadata_and_authorization=False ), sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty( application_host_url="applicationHostUrl", application_service_path="applicationServicePath", client_number="clientNumber", disable_sso=False, logon_language="logonLanguage", o_auth_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty( auth_code_url="authCodeUrl", o_auth_scopes=["oAuthScopes"], token_url="tokenUrl" ), port_number=123, private_link_service_name="privateLinkServiceName" ), service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty( account_name="accountName", bucket_name="bucketName", bucket_prefix="bucketPrefix", private_link_service_name="privateLinkServiceName", region="region", stage="stage", warehouse="warehouse" ), veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty( instance_url="instanceUrl" ), zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty( instance_url="instanceUrl" ) ) ), connector_profile_name="connectorProfileName", connector_type="connectorType", kms_arn="kmsArn" )
Attributes
- connection_mode
Indicates the connection mode and if it is public or private.
- connector_label
The label for the connector profile being created.
- connector_profile_config
Defines the connector-specific configuration and credentials.
- connector_profile_name
The name of the connector profile.
The name is unique for each
ConnectorProfilein the AWS account .
- connector_type
The type of connector, such as Salesforce, Amplitude, and so on.
- kms_arn
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.