Class CfnIntegration

A CloudFormation AWS::CustomerProfiles::Integration.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnIntegration

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.CustomerProfiles

Assembly: Amazon.CDK.AWS.CustomerProfiles.dll

Syntax (csharp)

public class CfnIntegration : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnIntegration
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

Specifies an Amazon Connect Customer Profiles Integration.

CloudformationResource: AWS::CustomerProfiles::Integration

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

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.CustomerProfiles;

var cfnIntegration = new CfnIntegration(this, "MyCfnIntegration", new CfnIntegrationProps {
    DomainName = "domainName",

    // the properties below are optional
    FlowDefinition = new FlowDefinitionProperty {
        FlowName = "flowName",
        KmsArn = "kmsArn",
        SourceFlowConfig = new SourceFlowConfigProperty {
            ConnectorType = "connectorType",
            SourceConnectorProperties = new SourceConnectorPropertiesProperty {
                Marketo = new MarketoSourcePropertiesProperty {
                    Object = "object"
                },
                S3 = new S3SourcePropertiesProperty {
                    BucketName = "bucketName",

                    // the properties below are optional
                    BucketPrefix = "bucketPrefix"
                },
                Salesforce = new SalesforceSourcePropertiesProperty {
                    Object = "object",

                    // the properties below are optional
                    EnableDynamicFieldUpdate = false,
                    IncludeDeletedRecords = false
                },
                ServiceNow = new ServiceNowSourcePropertiesProperty {
                    Object = "object"
                },
                Zendesk = new ZendeskSourcePropertiesProperty {
                    Object = "object"
                }
            },

            // the properties below are optional
            ConnectorProfileName = "connectorProfileName",
            IncrementalPullConfig = new IncrementalPullConfigProperty {
                DatetimeTypeFieldName = "datetimeTypeFieldName"
            }
        },
        Tasks = new [] { new TaskProperty {
            SourceFields = new [] { "sourceFields" },
            TaskType = "taskType",

            // the properties below are optional
            ConnectorOperator = new ConnectorOperatorProperty {
                Marketo = "marketo",
                S3 = "s3",
                Salesforce = "salesforce",
                ServiceNow = "serviceNow",
                Zendesk = "zendesk"
            },
            DestinationField = "destinationField",
            TaskProperties = new [] { new TaskPropertiesMapProperty {
                OperatorPropertyKey = "operatorPropertyKey",
                Property = "property"
            } }
        } },
        TriggerConfig = new TriggerConfigProperty {
            TriggerType = "triggerType",

            // the properties below are optional
            TriggerProperties = new TriggerPropertiesProperty {
                Scheduled = new ScheduledTriggerPropertiesProperty {
                    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 = new [] { new ObjectTypeMappingProperty {
        Key = "key",
        Value = "value"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Uri = "uri"
});

Synopsis

Constructors

CfnIntegration(Construct, String, ICfnIntegrationProps)	Create a new `AWS::CustomerProfiles::Integration`.
CfnIntegration(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnIntegration(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrCreatedAt	The timestamp of when the integration was created.
AttrLastUpdatedAt	The timestamp of when the integration was most recently edited.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
DomainName	The unique name of the domain.
FlowDefinition	The configuration that controls how Customer Profiles retrieves data from the source.
ObjectTypeName	The name of the profile object type mapping to use.
ObjectTypeNames	The object type mapping.
Tags	The tags used to organize, track, or control access for this resource.
Uri	The URI of the S3 bucket or any other type of data source.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnIntegration(Construct, String, ICfnIntegrationProps)

Create a new AWS::CustomerProfiles::Integration.

public CfnIntegration(Construct scope, string id, ICfnIntegrationProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnIntegrationProps

resource properties.

CfnIntegration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIntegration(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnIntegration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIntegration(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrCreatedAt

The timestamp of when the integration was created.

public virtual string AttrCreatedAt { get; }

Property Value

System.String

Remarks

CloudformationAttribute: CreatedAt

AttrLastUpdatedAt

The timestamp of when the integration was most recently edited.

public virtual string AttrLastUpdatedAt { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LastUpdatedAt

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

DomainName

The unique name of the domain.

public virtual string DomainName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-domainname

FlowDefinition

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

public virtual object FlowDefinition { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-flowdefinition

ObjectTypeName

The name of the profile object type mapping to use.

public virtual string ObjectTypeName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypename

ObjectTypeNames

The object type mapping.

public virtual object ObjectTypeNames { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypenames

Uri

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

public virtual string Uri { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-uri

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable