AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::CustomerProfiles::Types::FlowDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass FlowDefinition data as a hash:

{
  description: "FlowDescription",
  flow_name: "FlowName", # required
  kms_arn: "KmsArn", # required
  source_flow_config: { # required
    connector_profile_name: "ConnectorProfileName",
    connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
    incremental_pull_config: {
      datetime_type_field_name: "DatetimeTypeFieldName",
    },
    source_connector_properties: { # required
      marketo: {
        object: "Object", # required
      },
      s3: {
        bucket_name: "BucketName", # required
        bucket_prefix: "BucketPrefix",
      },
      salesforce: {
        object: "Object", # required
        enable_dynamic_field_update: false,
        include_deleted_records: false,
      },
      service_now: {
        object: "Object", # required
      },
      zendesk: {
        object: "Object", # required
      },
    },
  },
  tasks: [ # required
    {
      connector_operator: {
        marketo: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
        s3: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
        salesforce: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
        service_now: "PROJECTION", # accepts PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
        zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
      },
      destination_field: "DestinationField",
      source_fields: ["stringTo2048"], # required
      task_properties: {
        "VALUE" => "Property",
      },
      task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
    },
  ],
  trigger_config: { # required
    trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
    trigger_properties: {
      scheduled: {
        schedule_expression: "ScheduleExpression", # required
        data_pull_mode: "Incremental", # accepts Incremental, Complete
        schedule_start_time: Time.now,
        schedule_end_time: Time.now,
        timezone: "Timezone",
        schedule_offset: 1,
        first_execution_from: Time.now,
      },
    },
  },
}

The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the flow you want to create.

Returns:

  • (String)


1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end

#flow_nameString

The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.

Returns:

  • (String)


1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end

#kms_arnString

The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.

Returns:

  • (String)


1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_flow_configTypes::SourceFlowConfig

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



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end

#tasksArray<Types::Task>

A list of tasks that Customer Profiles performs while transferring the data in the flow run.

Returns:



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_configTypes::TriggerConfig

The trigger settings that determine how and when the flow runs.



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 1058

class FlowDefinition < Struct.new(
  :description,
  :flow_name,
  :kms_arn,
  :source_flow_config,
  :tasks,
  :trigger_config)
  SENSITIVE = []
  include Aws::Structure
end