Amazonka.CustomerProfiles.Types.FlowDefinition

Documentation

data FlowDefinition

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.

See: newFlowDefinition smart constructor.

Constructors

FlowDefinition'

Fields

• description :: Maybe Text

  A description of the flow you want to create.

• flowName :: Text

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

• kmsArn :: Text

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

• sourceFlowConfig :: SourceFlowConfig

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

• tasks :: [Task]

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

• triggerConfig :: TriggerConfig

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

Instances

ToJSON FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

toJSON :: FlowDefinition -> Value

toEncoding :: FlowDefinition -> Encoding

toJSONList :: [FlowDefinition] -> Value

toEncodingList :: [FlowDefinition] -> Encoding

Generic FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Associated Types

type Rep FlowDefinition :: Type -> Type

Methods

from :: FlowDefinition -> Rep FlowDefinition x

to :: Rep FlowDefinition x -> FlowDefinition

Read FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

readsPrec :: Int -> ReadS FlowDefinition

readList :: ReadS [FlowDefinition]

readPrec :: ReadPrec FlowDefinition

readListPrec :: ReadPrec [FlowDefinition]

Show FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

showsPrec :: Int -> FlowDefinition -> ShowS

show :: FlowDefinition -> String

showList :: [FlowDefinition] -> ShowS

NFData FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

rnf :: FlowDefinition -> ()

Eq FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

(==) :: FlowDefinition -> FlowDefinition -> Bool

(/=) :: FlowDefinition -> FlowDefinition -> Bool

Hashable FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

Methods

hashWithSalt :: Int -> FlowDefinition -> Int

hash :: FlowDefinition -> Int

type Rep FlowDefinition

Defined in Amazonka.CustomerProfiles.Types.FlowDefinition

type Rep FlowDefinition = D1 ('MetaData "FlowDefinition" "Amazonka.CustomerProfiles.Types.FlowDefinition" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "FlowDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "flowName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "kmsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "sourceFlowConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SourceFlowConfig) :*: (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Task]) :*: S1 ('MetaSel ('Just "triggerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TriggerConfig)))))

newFlowDefinition

Arguments

:: Text

$sel:flowName:FlowDefinition'

-> Text

$sel:kmsArn:FlowDefinition'

-> SourceFlowConfig

$sel:sourceFlowConfig:FlowDefinition'

-> TriggerConfig

$sel:triggerConfig:FlowDefinition'

-> FlowDefinition

Create a value of FlowDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:FlowDefinition', flowDefinition_description - A description of the flow you want to create.

$sel:flowName:FlowDefinition', flowDefinition_flowName - The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.

$sel:kmsArn:FlowDefinition', flowDefinition_kmsArn - The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.

$sel:sourceFlowConfig:FlowDefinition', flowDefinition_sourceFlowConfig - The configuration that controls how Customer Profiles retrieves data from the source.

$sel:tasks:FlowDefinition', flowDefinition_tasks - A list of tasks that Customer Profiles performs while transferring the data in the flow run.

$sel:triggerConfig:FlowDefinition', flowDefinition_triggerConfig - The trigger settings that determine how and when the flow runs.

flowDefinition_description :: Lens' FlowDefinition (Maybe Text)

A description of the flow you want to create.

flowDefinition_flowName :: Lens' FlowDefinition Text

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

flowDefinition_kmsArn :: Lens' FlowDefinition Text

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

flowDefinition_sourceFlowConfig :: Lens' FlowDefinition SourceFlowConfig

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

flowDefinition_tasks :: Lens' FlowDefinition [Task]

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

flowDefinition_triggerConfig :: Lens' FlowDefinition TriggerConfig

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