interface CfnIntegrationProps

Language	Type name
.NET	Amazon.CDK.AWS.CustomerProfiles.CfnIntegrationProps
Java	software.amazon.awscdk.services.customerprofiles.CfnIntegrationProps
Python	aws_cdk.aws_customerprofiles.CfnIntegrationProps
TypeScript	@aws-cdk/aws-customerprofiles » CfnIntegrationProps

Properties for defining a CfnIntegration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as customerprofiles from '@aws-cdk/aws-customerprofiles';
const cfnIntegrationProps: customerprofiles.CfnIntegrationProps = {
  domainName: 'domainName',

  // the properties below are optional
  flowDefinition: {
    flowName: 'flowName',
    kmsArn: 'kmsArn',
    sourceFlowConfig: {
      connectorType: 'connectorType',
      sourceConnectorProperties: {
        marketo: {
          object: 'object',
        },
        s3: {
          bucketName: 'bucketName',

          // the properties below are optional
          bucketPrefix: 'bucketPrefix',
        },
        salesforce: {
          object: 'object',

          // the properties below are optional
          enableDynamicFieldUpdate: false,
          includeDeletedRecords: false,
        },
        serviceNow: {
          object: 'object',
        },
        zendesk: {
          object: 'object',
        },
      },

      // the properties below are optional
      connectorProfileName: 'connectorProfileName',
      incrementalPullConfig: {
        datetimeTypeFieldName: 'datetimeTypeFieldName',
      },
    },
    tasks: [{
      sourceFields: ['sourceFields'],
      taskType: 'taskType',

      // the properties below are optional
      connectorOperator: {
        marketo: 'marketo',
        s3: 's3',
        salesforce: 'salesforce',
        serviceNow: 'serviceNow',
        zendesk: 'zendesk',
      },
      destinationField: 'destinationField',
      taskProperties: [{
        operatorPropertyKey: 'operatorPropertyKey',
        property: 'property',
      }],
    }],
    triggerConfig: {
      triggerType: 'triggerType',

      // the properties below are optional
      triggerProperties: {
        scheduled: {
          scheduleExpression: 'scheduleExpression',

          // the properties below are optional
          dataPullMode: 'dataPullMode',
          firstExecutionFrom: 123,
          scheduleEndTime: 123,
          scheduleOffset: 123,
          scheduleStartTime: 123,
          timezone: 'timezone',
        },
      },
    },

    // the properties below are optional
    description: 'description',
  },
  objectTypeName: 'objectTypeName',
  objectTypeNames: [{
    key: 'key',
    value: 'value',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  uri: 'uri',
};

Properties

Name	Type	Description
domainName	string	The unique name of the domain.
flowDefinition?	FlowDefinitionProperty | IResolvable	The configuration that controls how Customer Profiles retrieves data from the source.
objectTypeName?	string	The name of the profile object type mapping to use.
objectTypeNames?	IResolvable | IResolvable | ObjectTypeMappingProperty[]	The object type mapping.
tags?	CfnTag[]	The tags used to organize, track, or control access for this resource.
uri?	string	The URI of the S3 bucket or any other type of data source.

---

domainName

Type: string

The unique name of the domain.

---

flowDefinition?

Type: FlowDefinitionProperty | IResolvable (optional)

The configuration that controls how Customer Profiles retrieves data from the source.

---

objectTypeName?

Type: string (optional)

The name of the profile object type mapping to use.

---

objectTypeNames?

Type: IResolvable | IResolvable | ObjectTypeMappingProperty[] (optional)

The object type mapping.

---

tags?

Type: CfnTag[] (optional)

The tags used to organize, track, or control access for this resource.

---

uri?

Type: string (optional)

The URI of the S3 bucket or any other type of data source.