Class: AWSCDK::CustomerProfiles::CfnIntegration::FlowDefinitionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_integration.rb

Overview

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 Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flow_name:, kms_arn:, source_flow_config:, tasks:, trigger_config:, description: nil) ⇒ FlowDefinitionProperty

Returns a new instance of FlowDefinitionProperty.

Parameters:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'customer_profiles/cfn_integration.rb', line 690

def initialize(flow_name:, kms_arn:, source_flow_config:, tasks:, trigger_config:, description: nil)
  @flow_name = flow_name
  Jsii::Type.check_type(@flow_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "flowName")
  @kms_arn = kms_arn
  Jsii::Type.check_type(@kms_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsArn")
  @source_flow_config = source_flow_config.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnIntegration::SourceFlowConfigProperty.new(**source_flow_config.transform_keys(&:to_sym)) : source_flow_config
  Jsii::Type.check_type(@source_flow_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkludGVncmF0aW9uLlNvdXJjZUZsb3dDb25maWdQcm9wZXJ0eSJ9XX19")), "sourceFlowConfig")
  @tasks = tasks
  Jsii::Type.check_type(@tasks, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5JbnRlZ3JhdGlvbi5UYXNrUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "tasks")
  @trigger_config = trigger_config.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnIntegration::TriggerConfigProperty.new(**trigger_config.transform_keys(&:to_sym)) : trigger_config
  Jsii::Type.check_type(@trigger_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkludGVncmF0aW9uLlRyaWdnZXJDb25maWdQcm9wZXJ0eSJ9XX19")), "triggerConfig")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description of the flow you want to create.

Returns:

  • (String, nil)

See Also:



736
737
738
 
# File 'customer_profiles/cfn_integration.rb', line 736

def description
  @description
end

#flow_name ⇒ String (readonly)

The specified name of the flow.

Use underscores (_) or hyphens (-) only. Spaces are not allowed.

Returns:

  • (String)

See Also:



711
712
713
 
# File 'customer_profiles/cfn_integration.rb', line 711

def flow_name
  @flow_name
end

#kms_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



716
717
718
 
# File 'customer_profiles/cfn_integration.rb', line 716

def kms_arn
  @kms_arn
end

#source_flow_config ⇒ AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::SourceFlowConfigProperty (readonly)

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

Returns:

See Also:



721
722
723
 
# File 'customer_profiles/cfn_integration.rb', line 721

def source_flow_config
  @source_flow_config
end

#tasks ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::TaskProperty> (readonly)

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

Returns:

See Also:



726
727
728
 
# File 'customer_profiles/cfn_integration.rb', line 726

def tasks
  @tasks
end

#trigger_config ⇒ AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::TriggerConfigProperty (readonly)

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

Returns:

See Also:



731
732
733
 
# File 'customer_profiles/cfn_integration.rb', line 731

def trigger_config
  @trigger_config
end

Class Method Details

.jsii_properties ⇒ Object 



738
739
740
741
742
743
744
745
746
747
 
# File 'customer_profiles/cfn_integration.rb', line 738

def self.jsii_properties
  {
    :flow_name => "flowName",
    :kms_arn => "kmsArn",
    :source_flow_config => "sourceFlowConfig",
    :tasks => "tasks",
    :trigger_config => "triggerConfig",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'customer_profiles/cfn_integration.rb', line 749

def to_jsii
  result = {}
  result.merge!({
    "flowName" => @flow_name,
    "kmsArn" => @kms_arn,
    "sourceFlowConfig" => @source_flow_config,
    "tasks" => @tasks,
    "triggerConfig" => @trigger_config,
    "description" => @description,
  })
  result.compact
end