Class: AWSCDK::AppFlow::CfnFlow::PrefixConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_flow/cfn_flow.rb

Overview

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path_prefix_hierarchy: nil, prefix_format: nil, prefix_type: nil) ⇒ PrefixConfigProperty

Returns a new instance of PrefixConfigProperty.

Parameters:

  • path_prefix_hierarchy (Array<String>, nil) (defaults to: nil) —

    Specifies whether the destination file path includes either or both of the following elements:.

  • prefix_format (String, nil) (defaults to: nil) —

    Determines the level of granularity for the date and time that's included in the prefix.

  • prefix_type (String, nil) (defaults to: nil) —

    Determines the format of the prefix, and whether it applies to the file name, file path, or both.



1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'app_flow/cfn_flow.rb', line 1806

def initialize(path_prefix_hierarchy: nil, prefix_format: nil, prefix_type: nil)
  @path_prefix_hierarchy = path_prefix_hierarchy
  Jsii::Type.check_type(@path_prefix_hierarchy, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "pathPrefixHierarchy") unless @path_prefix_hierarchy.nil?
  @prefix_format = prefix_format
  Jsii::Type.check_type(@prefix_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefixFormat") unless @prefix_format.nil?
  @prefix_type = prefix_type
  Jsii::Type.check_type(@prefix_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefixType") unless @prefix_type.nil?
end

Instance Attribute Details

#path_prefix_hierarchy ⇒ Array<String>? (readonly)

Specifies whether the destination file path includes either or both of the following elements:.

  • EXECUTION_ID - The ID that Amazon AppFlow assigns to the flow run.
  • SCHEMA_VERSION - The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
  • Source-to-destination field mappings
  • Field data types
  • Partition keys

Returns:

  • (Array<String>, nil)

See Also:



1825
1826
1827
 
# File 'app_flow/cfn_flow.rb', line 1825

def path_prefix_hierarchy
  @path_prefix_hierarchy
end

#prefix_format ⇒ String? (readonly)

Determines the level of granularity for the date and time that's included in the prefix.

Returns:

  • (String, nil)

See Also:



1830
1831
1832
 
# File 'app_flow/cfn_flow.rb', line 1830

def prefix_format
  @prefix_format
end

#prefix_type ⇒ String? (readonly)

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

Returns:

  • (String, nil)

See Also:



1835
1836
1837
 
# File 'app_flow/cfn_flow.rb', line 1835

def prefix_type
  @prefix_type
end

Class Method Details

.jsii_properties ⇒ Object 



1837
1838
1839
1840
1841
1842
1843
 
# File 'app_flow/cfn_flow.rb', line 1837

def self.jsii_properties
  {
    :path_prefix_hierarchy => "pathPrefixHierarchy",
    :prefix_format => "prefixFormat",
    :prefix_type => "prefixType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1845
1846
1847
1848
1849
1850
1851
1852
1853
 
# File 'app_flow/cfn_flow.rb', line 1845

def to_jsii
  result = {}
  result.merge!({
    "pathPrefixHierarchy" => @path_prefix_hierarchy,
    "prefixFormat" => @prefix_format,
    "prefixType" => @prefix_type,
  })
  result.compact
end