Package software.amazon.awscdk.services.customerprofiles

Class CfnIntegration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.customerprofiles.CfnIntegration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.059Z") @Stability(Stable) public class CfnIntegration extends CfnResource implements IInspectable
A CloudFormation AWS::CustomerProfiles::Integration.

Specifies an Amazon Connect Customer Profiles Integration.

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.customerprofiles.*;
 CfnIntegration cfnIntegration = CfnIntegration.Builder.create(this, "MyCfnIntegration")
         .domainName("domainName")
         // the properties below are optional
         .flowDefinition(FlowDefinitionProperty.builder()
                 .flowName("flowName")
                 .kmsArn("kmsArn")
                 .sourceFlowConfig(SourceFlowConfigProperty.builder()
                         .connectorType("connectorType")
                         .sourceConnectorProperties(SourceConnectorPropertiesProperty.builder()
                                 .marketo(MarketoSourcePropertiesProperty.builder()
                                         .object("object")
                                         .build())
                                 .s3(S3SourcePropertiesProperty.builder()
                                         .bucketName("bucketName")
                                         // the properties below are optional
                                         .bucketPrefix("bucketPrefix")
                                         .build())
                                 .salesforce(SalesforceSourcePropertiesProperty.builder()
                                         .object("object")
                                         // the properties below are optional
                                         .enableDynamicFieldUpdate(false)
                                         .includeDeletedRecords(false)
                                         .build())
                                 .serviceNow(ServiceNowSourcePropertiesProperty.builder()
                                         .object("object")
                                         .build())
                                 .zendesk(ZendeskSourcePropertiesProperty.builder()
                                         .object("object")
                                         .build())
                                 .build())
                         // the properties below are optional
                         .connectorProfileName("connectorProfileName")
                         .incrementalPullConfig(IncrementalPullConfigProperty.builder()
                                 .datetimeTypeFieldName("datetimeTypeFieldName")
                                 .build())
                         .build())
                 .tasks(List.of(TaskProperty.builder()
                         .sourceFields(List.of("sourceFields"))
                         .taskType("taskType")
                         // the properties below are optional
                         .connectorOperator(ConnectorOperatorProperty.builder()
                                 .marketo("marketo")
                                 .s3("s3")
                                 .salesforce("salesforce")
                                 .serviceNow("serviceNow")
                                 .zendesk("zendesk")
                                 .build())
                         .destinationField("destinationField")
                         .taskProperties(List.of(TaskPropertiesMapProperty.builder()
                                 .operatorPropertyKey("operatorPropertyKey")
                                 .property("property")
                                 .build()))
                         .build()))
                 .triggerConfig(TriggerConfigProperty.builder()
                         .triggerType("triggerType")
                         // the properties below are optional
                         .triggerProperties(TriggerPropertiesProperty.builder()
                                 .scheduled(ScheduledTriggerPropertiesProperty.builder()
                                         .scheduleExpression("scheduleExpression")
                                         // the properties below are optional
                                         .dataPullMode("dataPullMode")
                                         .firstExecutionFrom(123)
                                         .scheduleEndTime(123)
                                         .scheduleOffset(123)
                                         .scheduleStartTime(123)
                                         .timezone("timezone")
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .description("description")
                 .build())
         .objectTypeName("objectTypeName")
         .objectTypeNames(List.of(ObjectTypeMappingProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .uri("uri")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIntegration

      protected CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnIntegration

      protected CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnIntegration

      @Stability(Stable) public CfnIntegration(@NotNull Construct scope, @NotNull String id, @NotNull CfnIntegrationProps props)
      Create a new AWS::CustomerProfiles::Integration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the integration was created.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the integration was most recently edited.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags used to organize, track, or control access for this resource.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The unique name of the domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The unique name of the domain.

    • getFlowDefinition

      @Stability(Stable) @Nullable public Object getFlowDefinition()
      The configuration that controls how Customer Profiles retrieves data from the source.

    • setFlowDefinition

      @Stability(Stable) public void setFlowDefinition(@Nullable CfnIntegration.FlowDefinitionProperty value)
      The configuration that controls how Customer Profiles retrieves data from the source.

    • setFlowDefinition

      @Stability(Stable) public void setFlowDefinition(@Nullable IResolvable value)
      The configuration that controls how Customer Profiles retrieves data from the source.

    • getObjectTypeName

      @Stability(Stable) @Nullable public String getObjectTypeName()
      The name of the profile object type mapping to use.

    • setObjectTypeName

      @Stability(Stable) public void setObjectTypeName(@Nullable String value)
      The name of the profile object type mapping to use.

    • getObjectTypeNames

      @Stability(Stable) @Nullable public Object getObjectTypeNames()
      The object type mapping.

    • setObjectTypeNames

      @Stability(Stable) public void setObjectTypeNames(@Nullable IResolvable value)
      The object type mapping.

    • setObjectTypeNames

      @Stability(Stable) public void setObjectTypeNames(@Nullable List<Object> value)
      The object type mapping.

    • getUri

      @Stability(Stable) @Nullable public String getUri()
      The URI of the S3 bucket or any other type of data source.

    • setUri

      @Stability(Stable) public void setUri(@Nullable String value)
      The URI of the S3 bucket or any other type of data source.