Class: Aws::Appflow::Types::CreateFlowRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the flow you want to create.

Returns:

  • (String) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#destination_flow_config_list ⇒ Array<Types::DestinationFlowConfig>

The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#flow_name ⇒ String

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

Returns:

  • (String) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#kms_arn ⇒ String

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

Returns:

  • (String) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_catalog_config ⇒ Types::MetadataCatalogConfig

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source_flow_config ⇒ Types::SourceFlowConfig

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for your flow.

Returns:

  • (Hash<String,String>) 


1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tasks ⇒ Array<Types::Task>

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_config ⇒ Types::TriggerConfig

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

Returns:



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 1399

class CreateFlowRequest < Struct.new(
  :flow_name,
  :description,
  :kms_arn,
  :trigger_config,
  :source_flow_config,
  :destination_flow_config_list,
  :tasks,
  :tags,
  :metadata_catalog_config,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end