Package software.amazon.awscdk.services.customerprofiles

Class CfnIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.customerprofiles.CfnIntegration

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:59.795Z")
@Stability(Stable)
public class CfnIntegration
extends CfnResource
implements IInspectable, ITaggable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIntegration.Builder	A fluent builder for CfnIntegration.
static interface	CfnIntegration.ConnectorOperatorProperty	The operation to be performed on the provided source fields.
static interface	CfnIntegration.FlowDefinitionProperty	The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.
static interface	CfnIntegration.IncrementalPullConfigProperty	Specifies the configuration used when importing incremental records from the source.
static interface	CfnIntegration.MarketoSourcePropertiesProperty	The properties that are applied when Marketo is being used as a source.
static interface	CfnIntegration.ObjectTypeMappingProperty	A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.
static interface	CfnIntegration.S3SourcePropertiesProperty	The properties that are applied when Amazon S3 is being used as the flow source.
static interface	CfnIntegration.SalesforceSourcePropertiesProperty	The properties that are applied when Salesforce is being used as a source.
static interface	CfnIntegration.ScheduledTriggerPropertiesProperty	Specifies the configuration details of a scheduled-trigger flow that you define.
static interface	CfnIntegration.ServiceNowSourcePropertiesProperty	The properties that are applied when ServiceNow is being used as a source.
static interface	CfnIntegration.SourceConnectorPropertiesProperty	Specifies the information that is required to query a particular Amazon AppFlow connector.
static interface	CfnIntegration.SourceFlowConfigProperty	The configuration that controls how Customer Profiles retrieves data from the source.
static interface	CfnIntegration.TaskPropertiesMapProperty	A map used to store task-related information.
static interface	CfnIntegration.TaskProperty	The Task property type specifies the class for modeling different type of tasks.
static interface	CfnIntegration.TriggerConfigProperty	The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
static interface	CfnIntegration.TriggerPropertiesProperty	Specifies the configuration details that control the trigger for a flow.
static interface	CfnIntegration.ZendeskSourcePropertiesProperty	The properties that are applied when using Zendesk as a flow source.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnIntegration(software.constructs.Construct scope, String id, CfnIntegrationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	The timestamp of when the integration was created.
String	getAttrLastUpdatedAt()	The timestamp of when the integration was most recently edited.
protected Map<String,Object>	getCfnProperties()
String	getDomainName()	The unique name of the domain.
Object	getFlowDefinition()	The configuration that controls how Customer Profiles retrieves data from the source.
String	getObjectTypeName()	The name of the profile object type mapping to use.
Object	getObjectTypeNames()	The object type mapping.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags used to organize, track, or control access for this resource.
String	getUri()	The URI of the S3 bucket or any other type of data source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainName(String value)	The unique name of the domain.
void	setFlowDefinition(IResolvable value)	The configuration that controls how Customer Profiles retrieves data from the source.
void	setFlowDefinition(CfnIntegration.FlowDefinitionProperty value)	The configuration that controls how Customer Profiles retrieves data from the source.
void	setObjectTypeName(String value)	The name of the profile object type mapping to use.
void	setObjectTypeNames(List<Object> value)	The object type mapping.
void	setObjectTypeNames(IResolvable value)	The object type mapping.
void	setTagsRaw(List<CfnTag> value)	The tags used to organize, track, or control access for this resource.
void	setUri(String value)	The URI of the S3 bucket or any other type of data source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnIntegrationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

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
 IResolvable value)

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.

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.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

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.