Class: AWSCDK::AppFlow::CfnFlow::DataTransferAPIProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::AppFlow::CfnFlow::DataTransferAPIProperty

Defined in:

app_flow/cfn_flow.rb

Overview

The API of the connector application that Amazon AppFlow uses to transfer your data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html

Instance Attribute Summary

• #name ⇒ String readonly

  The name of the connector application API.

• #type ⇒ String readonly

  You can specify one of the following types:.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, type:) ⇒ DataTransferAPIProperty constructor

  A new instance of DataTransferAPIProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, type:) ⇒ DataTransferAPIProperty

Returns a new instance of DataTransferAPIProperty.

Parameters:

• name (String) —

  The name of the connector application API.

• type (String) —

  You can specify one of the following types:.

# File 'app_flow/cfn_flow.rb', line 1065

def initialize(name:, type:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
end

Instance Attribute Details

#name ⇒ String (readonly)

The name of the connector application API.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html#cfn-appflow-flow-datatransferapi-name

# File 'app_flow/cfn_flow.rb', line 1076

def name
  @name
end

#type ⇒ String (readonly)

You can specify one of the following types:.

• AUTOMATIC - The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers.
• SYNC - A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
• ASYNC - An asynchronous API. This type of API optimizes a flow for large datasets.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datatransferapi.html#cfn-appflow-flow-datatransferapi-type

# File 'app_flow/cfn_flow.rb', line 1085

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'app_flow/cfn_flow.rb', line 1087

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'app_flow/cfn_flow.rb', line 1094

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
  })
  result.compact
end