Class: AWSCDK::B2BI::CfnTransformer

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSB2Bi::ITransformerRef
Defined in:
b2_bi/cfn_transformer.rb

Overview

Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:.

  • Inbound EDI : the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
  • Outbound EDI : the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

The following fields are provided for backwards compatibility only: file_format , mapping_template , edi_type , and sample_document .

  • Use the mapping data type in place of mapping_template and file_format
  • Use the sample_documents data type in place of sample_document
  • Use either the input_conversion or output_conversion in place of edi_type

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTransformer

Create a new AWS::B2BI::Transformer.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::B2BI::CfnTransformerProps) —

    Resource properties.



27
28
29
30
31
32
33
 
# File 'b2_bi/cfn_transformer.rb', line 27

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformerProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYjJiaS5DZm5UcmFuc2Zvcm1lclByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_transformer(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_transformer(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iMmJpLklUcmFuc2Zvcm1lclJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_b2bi.CfnTransformer", "arnForTransformer", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'b2_bi/cfn_transformer.rb', line 201

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_b2bi.CfnTransformer", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_transformer(x) ⇒ Boolean

Checks whether the given object is a CfnTransformer.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'b2_bi/cfn_transformer.rb', line 103

def self.is_cfn_transformer(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_b2bi.CfnTransformer", "isCfnTransformer", [x])
end

.jsii_overridable_methods ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'b2_bi/cfn_transformer.rb', line 35

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_transformer_arn => { kind: :property, name: "attrTransformerArn", is_optional: false },
    :attr_transformer_id => { kind: :property, name: "attrTransformerId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :transformer_ref => { kind: :property, name: "transformerRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :status => { kind: :property, name: "status", is_optional: false },
    :edi_type => { kind: :property, name: "ediType", is_optional: true },
    :file_format => { kind: :property, name: "fileFormat", is_optional: true },
    :input_conversion => { kind: :property, name: "inputConversion", is_optional: true },
    :mapping => { kind: :property, name: "mapping", is_optional: true },
    :mapping_template => { kind: :property, name: "mappingTemplate", is_optional: true },
    :output_conversion => { kind: :property, name: "outputConversion", is_optional: true },
    :sample_document => { kind: :property, name: "sampleDocument", is_optional: true },
    :sample_documents => { kind: :property, name: "sampleDocuments", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



423
424
425
426
 
# File 'b2_bi/cfn_transformer.rb', line 423

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



435
436
437
438
 
# File 'b2_bi/cfn_transformer.rb', line 435

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



445
446
447
448
 
# File 'b2_bi/cfn_transformer.rb', line 445

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



456
457
458
459
460
 
# File 'b2_bi/cfn_transformer.rb', line 456

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


513
514
515
516
517
 
# File 'b2_bi/cfn_transformer.rb', line 513

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



523
524
525
526
 
# File 'b2_bi/cfn_transformer.rb', line 523

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



535
536
537
538
539
 
# File 'b2_bi/cfn_transformer.rb', line 535

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



548
549
550
551
 
# File 'b2_bi/cfn_transformer.rb', line 548

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



570
571
572
573
574
575
 
# File 'b2_bi/cfn_transformer.rb', line 570

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

Returns a timestamp indicating when the transformer was created.

For example, 2023-07-20T19:58:44.624Z .

Returns:

  • (String) 


210
211
212
 
# File 'b2_bi/cfn_transformer.rb', line 210

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_modified_at ⇒ String

Returns a timestamp representing the date and time for the most recent change for the transformer object.

Returns:

  • (String) 


217
218
219
 
# File 'b2_bi/cfn_transformer.rb', line 217

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_transformer_arn ⇒ String

Returns an Amazon Resource Name (ARN) for a specific transformer.

Returns:

  • (String) 


224
225
226
 
# File 'b2_bi/cfn_transformer.rb', line 224

def attr_transformer_arn()
  jsii_get_property("attrTransformerArn")
end

#attr_transformer_id ⇒ String

The system-assigned unique identifier for the transformer.

Returns:

  • (String) 


231
232
233
 
# File 'b2_bi/cfn_transformer.rb', line 231

def attr_transformer_id()
  jsii_get_property("attrTransformerId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



238
239
240
 
# File 'b2_bi/cfn_transformer.rb', line 238

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



154
155
156
 
# File 'b2_bi/cfn_transformer.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 'b2_bi/cfn_transformer.rb', line 159

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


579
580
581
582
 
# File 'b2_bi/cfn_transformer.rb', line 579

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


164
165
166
 
# File 'b2_bi/cfn_transformer.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 'b2_bi/cfn_transformer.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 'b2_bi/cfn_transformer.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#edi_type ⇒ AWSCDK::IResolvable, ...

Deprecated.

this property has been deprecated

Returns:



275
276
277
 
# File 'b2_bi/cfn_transformer.rb', line 275

def edi_type()
  jsii_get_property("ediType")
end

#edi_type=(value) ⇒ Object 



279
280
281
282
283
 
# File 'b2_bi/cfn_transformer.rb', line 279

def edi_type=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::EdiTypeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLkVkaVR5cGVQcm9wZXJ0eSJ9XX19")), "ediType") unless value.nil?
  jsii_set_property("ediType", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'b2_bi/cfn_transformer.rb', line 176

def env()
  jsii_get_property("env")
end

#file_format ⇒ String?

Deprecated.

this property has been deprecated

Returns:

  • (String, nil) 


287
288
289
 
# File 'b2_bi/cfn_transformer.rb', line 287

def file_format()
  jsii_get_property("fileFormat")
end

#file_format=(value) ⇒ Object 



291
292
293
294
 
# File 'b2_bi/cfn_transformer.rb', line 291

def file_format=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileFormat") unless value.nil?
  jsii_set_property("fileFormat", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



592
593
594
595
596
 
# File 'b2_bi/cfn_transformer.rb', line 592

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



603
604
605
606
 
# File 'b2_bi/cfn_transformer.rb', line 603

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#input_conversion ⇒ AWSCDK::IResolvable, ...

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

Returns:



299
300
301
 
# File 'b2_bi/cfn_transformer.rb', line 299

def input_conversion()
  jsii_get_property("inputConversion")
end

#input_conversion=(value) ⇒ Object 



303
304
305
306
307
 
# File 'b2_bi/cfn_transformer.rb', line 303

def input_conversion=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::InputConversionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLklucHV0Q29udmVyc2lvblByb3BlcnR5In1dfX0=")), "inputConversion") unless value.nil?
  jsii_set_property("inputConversion", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



673
674
675
676
 
# File 'b2_bi/cfn_transformer.rb', line 673

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


128
129
130
 
# File 'b2_bi/cfn_transformer.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#mapping ⇒ AWSCDK::IResolvable, ...

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

Returns:



312
313
314
 
# File 'b2_bi/cfn_transformer.rb', line 312

def mapping()
  jsii_get_property("mapping")
end

#mapping=(value) ⇒ Object 



316
317
318
319
320
 
# File 'b2_bi/cfn_transformer.rb', line 316

def mapping=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::MappingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLk1hcHBpbmdQcm9wZXJ0eSJ9XX19")), "mapping") unless value.nil?
  jsii_set_property("mapping", value)
end

#mapping_template ⇒ String?

Deprecated.

this property has been deprecated

This shape is deprecated: This is a legacy trait.

Returns:

  • (String, nil) 


326
327
328
 
# File 'b2_bi/cfn_transformer.rb', line 326

def mapping_template()
  jsii_get_property("mappingTemplate")
end

#mapping_template=(value) ⇒ Object 



330
331
332
333
 
# File 'b2_bi/cfn_transformer.rb', line 330

def mapping_template=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mappingTemplate") unless value.nil?
  jsii_set_property("mappingTemplate", value)
end

#name ⇒ String

Returns the descriptive name for the transformer.

Returns:

  • (String) 


252
253
254
 
# File 'b2_bi/cfn_transformer.rb', line 252

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



256
257
258
259
 
# File 'b2_bi/cfn_transformer.rb', line 256

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'b2_bi/cfn_transformer.rb', line 111

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



614
615
616
 
# File 'b2_bi/cfn_transformer.rb', line 614

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



621
622
623
 
# File 'b2_bi/cfn_transformer.rb', line 621

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#output_conversion ⇒ AWSCDK::IResolvable, ...

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

Returns:



338
339
340
 
# File 'b2_bi/cfn_transformer.rb', line 338

def output_conversion()
  jsii_get_property("outputConversion")
end

#output_conversion=(value) ⇒ Object 



342
343
344
345
346
 
# File 'b2_bi/cfn_transformer.rb', line 342

def output_conversion=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::OutputConversionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLk91dHB1dENvbnZlcnNpb25Qcm9wZXJ0eSJ9XX19")), "outputConversion") unless value.nil?
  jsii_set_property("outputConversion", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



414
415
416
417
 
# File 'b2_bi/cfn_transformer.rb', line 414

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


147
148
149
 
# File 'b2_bi/cfn_transformer.rb', line 147

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



632
633
634
635
 
# File 'b2_bi/cfn_transformer.rb', line 632

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


639
640
641
642
 
# File 'b2_bi/cfn_transformer.rb', line 639

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



649
650
651
652
653
 
# File 'b2_bi/cfn_transformer.rb', line 649

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#sample_document ⇒ String?

Deprecated.

this property has been deprecated

This shape is deprecated: This is a legacy trait.

Returns:

  • (String, nil) 


352
353
354
 
# File 'b2_bi/cfn_transformer.rb', line 352

def sample_document()
  jsii_get_property("sampleDocument")
end

#sample_document=(value) ⇒ Object 



356
357
358
359
 
# File 'b2_bi/cfn_transformer.rb', line 356

def sample_document=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sampleDocument") unless value.nil?
  jsii_set_property("sampleDocument", value)
end

#sample_documents ⇒ AWSCDK::IResolvable, ...

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:



364
365
366
 
# File 'b2_bi/cfn_transformer.rb', line 364

def sample_documents()
  jsii_get_property("sampleDocuments")
end

#sample_documents=(value) ⇒ Object 



368
369
370
371
372
 
# File 'b2_bi/cfn_transformer.rb', line 368

def sample_documents=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::B2BI::CfnTransformer::SampleDocumentsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblRyYW5zZm9ybWVyLlNhbXBsZURvY3VtZW50c1Byb3BlcnR5In1dfX0=")), "sampleDocuments") unless value.nil?
  jsii_set_property("sampleDocuments", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



658
659
660
 
# File 'b2_bi/cfn_transformer.rb', line 658

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



137
138
139
 
# File 'b2_bi/cfn_transformer.rb', line 137

def stack()
  jsii_get_property("stack")
end

#status ⇒ String

Returns the state of the newly created transformer.

Returns:

  • (String) 


264
265
266
 
# File 'b2_bi/cfn_transformer.rb', line 264

def status()
  jsii_get_property("status")
end

#status=(value) ⇒ Object 



268
269
270
271
 
# File 'b2_bi/cfn_transformer.rb', line 268

def status=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  jsii_set_property("status", value)
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A key-value pair for a specific transformer.

Returns:



377
378
379
 
# File 'b2_bi/cfn_transformer.rb', line 377

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



381
382
383
384
385
 
# File 'b2_bi/cfn_transformer.rb', line 381

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



390
391
392
 
# File 'b2_bi/cfn_transformer.rb', line 390

def to_string()
  jsii_call_method("toString", [])
end

#transformer_ref ⇒ AWSCDK::Interfaces::AWSB2Bi::TransformerReference

A reference to a Transformer resource.

Returns:



245
246
247
 
# File 'b2_bi/cfn_transformer.rb', line 245

def transformer_ref()
  jsii_get_property("transformerRef")
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'b2_bi/cfn_transformer.rb', line 184

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


194
195
196
 
# File 'b2_bi/cfn_transformer.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


664
665
666
667
 
# File 'b2_bi/cfn_transformer.rb', line 664

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


403
404
405
406
407
408
 
# File 'b2_bi/cfn_transformer.rb', line 403

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end