Class: Aws::Appflow::Types::FlowDefinition

Inherits:

Struct

• Object
• Struct
• Aws::Appflow::Types::FlowDefinition

Defined in:

gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

The properties of the flow, such as its source, destination, trigger type, and so on.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Specifies when the flow was created.

• #created_by ⇒ String

  The ARN of the user who created the flow.

• #description ⇒ String

  A user-entered description of the flow.

• #destination_connector_label ⇒ String

  The label of the destination connector in the flow.

• #destination_connector_type ⇒ String

  Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

• #flow_arn ⇒ String

  The flow's Amazon Resource Name (ARN).

• #flow_name ⇒ String

  The specified name of the flow.

• #flow_status ⇒ String

  Indicates the current status of the flow.

• #last_run_execution_details ⇒ Types::ExecutionDetails

  Describes the details of the most recent flow run.

• #last_updated_at ⇒ Time

  Specifies when the flow was last updated.

• #last_updated_by ⇒ String

  Specifies the account user name that most recently updated the flow.

• #source_connector_label ⇒ String

  The label of the source connector in the flow.

• #source_connector_type ⇒ String

  Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

• #tags ⇒ Hash<String,String>

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

• #trigger_type ⇒ String

  Specifies the type of flow trigger.

Instance Attribute Details

#created_at ⇒ Time

Specifies when the flow was created.

Returns:

• (Time)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ String

The ARN of the user who created the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A user-entered description of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#destination_connector_label ⇒ String

The label of the destination connector in the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#destination_connector_type ⇒ String

Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#flow_arn ⇒ String

The flow's Amazon Resource Name (ARN).

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  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)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#flow_status ⇒ String

Indicates the current status of the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_run_execution_details ⇒ Types::ExecutionDetails

Describes the details of the most recent flow run.

Returns:

• (Types::ExecutionDetails)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

Specifies when the flow was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_by ⇒ String

Specifies the account user name that most recently updated the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#source_connector_label ⇒ String

The label of the source connector in the flow.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#source_connector_type ⇒ String

Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  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>)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end

#trigger_type ⇒ String

Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2476

class FlowDefinition < Struct.new(
  :flow_arn,
  :description,
  :flow_name,
  :flow_status,
  :source_connector_type,
  :source_connector_label,
  :destination_connector_type,
  :destination_connector_label,
  :trigger_type,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags,
  :last_run_execution_details)
  SENSITIVE = []
  include Aws::Structure
end