Class: AWSCDK::B2BI::CfnTransformerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
b2_bi/cfn_transformer_props.rb

Overview

Properties for defining a CfnTransformer.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, status:, edi_type: nil, file_format: nil, input_conversion: nil, mapping: nil, mapping_template: nil, output_conversion: nil, sample_document: nil, sample_documents: nil, tags: nil) ⇒ CfnTransformerProps

Returns a new instance of CfnTransformerProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'b2_bi/cfn_transformer_props.rb', line 20

def initialize(name:, status:, edi_type: nil, file_format: nil, input_conversion: nil, mapping: nil, mapping_template: nil, output_conversion: nil, sample_document: nil, sample_documents: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @edi_type = edi_type.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::EdiTypeProperty.new(**edi_type.transform_keys(&:to_sym)) : edi_type
  Jsii::Type.check_type(@edi_type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLkVkaVR5cGVQcm9wZXJ0eSJ9XX19")), "ediType") unless @edi_type.nil?
  @file_format = file_format
  Jsii::Type.check_type(@file_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileFormat") unless @file_format.nil?
  @input_conversion = input_conversion.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::InputConversionProperty.new(**input_conversion.transform_keys(&:to_sym)) : input_conversion
  Jsii::Type.check_type(@input_conversion, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLklucHV0Q29udmVyc2lvblByb3BlcnR5In1dfX0=")), "inputConversion") unless @input_conversion.nil?
  @mapping = mapping.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::MappingProperty.new(**mapping.transform_keys(&:to_sym)) : mapping
  Jsii::Type.check_type(@mapping, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLk1hcHBpbmdQcm9wZXJ0eSJ9XX19")), "mapping") unless @mapping.nil?
  @mapping_template = mapping_template
  Jsii::Type.check_type(@mapping_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mappingTemplate") unless @mapping_template.nil?
  @output_conversion = output_conversion.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::OutputConversionProperty.new(**output_conversion.transform_keys(&:to_sym)) : output_conversion
  Jsii::Type.check_type(@output_conversion, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLk91dHB1dENvbnZlcnNpb25Qcm9wZXJ0eSJ9XX19")), "outputConversion") unless @output_conversion.nil?
  @sample_document = sample_document
  Jsii::Type.check_type(@sample_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sampleDocument") unless @sample_document.nil?
  @sample_documents = sample_documents.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::SampleDocumentsProperty.new(**sample_documents.transform_keys(&:to_sym)) : sample_documents
  Jsii::Type.check_type(@sample_documents, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLlNhbXBsZURvY3VtZW50c1Byb3BlcnR5In1dfX0=")), "sampleDocuments") unless @sample_documents.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#edi_type ⇒ AWSCDK::IResolvable, ... (readonly)

Deprecated.

this property has been deprecated

Returns:

See Also:



60
61
62
 
# File 'b2_bi/cfn_transformer_props.rb', line 60

def edi_type
  @edi_type
end

#file_format ⇒ String? (readonly)

Deprecated.

this property has been deprecated

Returns:

  • (String, nil)

See Also:



64
65
66
 
# File 'b2_bi/cfn_transformer_props.rb', line 64

def file_format
  @file_format
end

#input_conversion ⇒ AWSCDK::IResolvable, ... (readonly)

Returns a structure that contains the format options for the transformation.

Returns:

See Also:



69
70
71
 
# File 'b2_bi/cfn_transformer_props.rb', line 69

def input_conversion
  @input_conversion
end

#mapping ⇒ AWSCDK::IResolvable, ... (readonly)

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

Returns:

See Also:



74
75
76
 
# File 'b2_bi/cfn_transformer_props.rb', line 74

def mapping
  @mapping
end

#mapping_template ⇒ String? (readonly)

Deprecated.

this property has been deprecated

This shape is deprecated: This is a legacy trait.

Please use input-conversion or output-conversion.

Returns:

  • (String, nil)

See Also:



82
83
84
 
# File 'b2_bi/cfn_transformer_props.rb', line 82

def mapping_template
  @mapping_template
end

#name ⇒ String (readonly)

Returns the descriptive name for the transformer.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'b2_bi/cfn_transformer_props.rb', line 49

def name
  @name
end

#output_conversion ⇒ AWSCDK::IResolvable, ... (readonly)

Returns the OutputConversion object, which contains the format options for the outbound transformation.

Returns:

See Also:



87
88
89
 
# File 'b2_bi/cfn_transformer_props.rb', line 87

def output_conversion
  @output_conversion
end

#sample_document ⇒ String? (readonly)

Deprecated.

this property has been deprecated

This shape is deprecated: This is a legacy trait.

Please use input-conversion or output-conversion.

Returns:

  • (String, nil)

See Also:



95
96
97
 
# File 'b2_bi/cfn_transformer_props.rb', line 95

def sample_document
  @sample_document
end

#sample_documents ⇒ AWSCDK::IResolvable, ... (readonly)

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

Returns:

See Also:



100
101
102
 
# File 'b2_bi/cfn_transformer_props.rb', line 100

def sample_documents
  @sample_documents
end

#status ⇒ String (readonly)

Returns the state of the newly created transformer.

The transformer can be either active or inactive . For the transformer to be used in a capability, its status must active .

Returns:

  • (String)

See Also:



56
57
58
 
# File 'b2_bi/cfn_transformer_props.rb', line 56

def status
  @status
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A key-value pair for a specific transformer.

Tags are metadata that you can use to search for and group capabilities for various purposes.

Returns:

See Also:



107
108
109
 
# File 'b2_bi/cfn_transformer_props.rb', line 107

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'b2_bi/cfn_transformer_props.rb', line 109

def self.jsii_properties
  {
    :name => "name",
    :status => "status",
    :edi_type => "ediType",
    :file_format => "fileFormat",
    :input_conversion => "inputConversion",
    :mapping => "mapping",
    :mapping_template => "mappingTemplate",
    :output_conversion => "outputConversion",
    :sample_document => "sampleDocument",
    :sample_documents => "sampleDocuments",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'b2_bi/cfn_transformer_props.rb', line 125

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "status" => @status,
    "ediType" => @edi_type,
    "fileFormat" => @file_format,
    "inputConversion" => @input_conversion,
    "mapping" => @mapping,
    "mappingTemplate" => @mapping_template,
    "outputConversion" => @output_conversion,
    "sampleDocument" => @sample_document,
    "sampleDocuments" => @sample_documents,
    "tags" => @tags,
  })
  result.compact
end