Class: AWSCDK::Glue::CfnMLTransform

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSGlue::IMLTransformRef
Defined in:
glue/cfn_ml_transform.rb

Overview

The AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMLTransform

Create a new AWS::Glue::MLTransform.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

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

  • props (AWSCDK::Glue::CfnMLTransformProps)

    Resource properties.



18
19
20
21
22
23
24
# File 'glue/cfn_ml_transform.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Glue::CfnMLTransformProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2x1ZS5DZm5NTFRyYW5zZm9ybVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


184
185
186
# File 'glue/cfn_ml_transform.rb', line 184

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

.is_cfn_ml_transform(x) ⇒ Boolean

Checks whether the given object is a CfnMLTransform.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


86
87
88
89
# File 'glue/cfn_ml_transform.rb', line 86

def self.is_cfn_ml_transform(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnMLTransform", "isCfnMLTransform", [x])
end

.jsii_overridable_methodsObject



26
27
28
29
30
31
32
33
34
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
# File 'glue/cfn_ml_transform.rb', line 26

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_id => { kind: :property, name: "attrId", is_optional: false },
    :ml_transform_ref => { kind: :property, name: "mlTransformRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :input_record_tables => { kind: :property, name: "inputRecordTables", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :transform_parameters => { kind: :property, name: "transformParameters", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :glue_version => { kind: :property, name: "glueVersion", is_optional: true },
    :max_capacity => { kind: :property, name: "maxCapacity", is_optional: true },
    :max_retries => { kind: :property, name: "maxRetries", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :number_of_workers => { kind: :property, name: "numberOfWorkers", is_optional: true },
    :timeout => { kind: :property, name: "timeout", is_optional: true },
    :transform_encryption => { kind: :property, name: "transformEncryption", is_optional: true },
    :worker_type => { kind: :property, name: "workerType", 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.



404
405
406
407
# File 'glue/cfn_ml_transform.rb', line 404

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:



416
417
418
419
# File 'glue/cfn_ml_transform.rb', line 416

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:



426
427
428
429
# File 'glue/cfn_ml_transform.rb', line 426

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.



437
438
439
440
441
# File 'glue/cfn_ml_transform.rb', line 437

def (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.


494
495
496
497
498
# File 'glue/cfn_ml_transform.rb', line 494

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.



504
505
506
507
# File 'glue/cfn_ml_transform.rb', line 504

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.



516
517
518
519
520
# File 'glue/cfn_ml_transform.rb', line 516

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:



529
530
531
532
# File 'glue/cfn_ml_transform.rb', line 529

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:



551
552
553
554
555
556
# File 'glue/cfn_ml_transform.rb', line 551

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_idString

Returns:

  • (String)


189
190
191
# File 'glue/cfn_ml_transform.rb', line 189

def attr_id()
  jsii_get_property("attrId")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



137
138
139
# File 'glue/cfn_ml_transform.rb', line 137

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


142
143
144
# File 'glue/cfn_ml_transform.rb', line 142

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


560
561
562
563
# File 'glue/cfn_ml_transform.rb', line 560

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


147
148
149
# File 'glue/cfn_ml_transform.rb', line 147

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


154
155
156
# File 'glue/cfn_ml_transform.rb', line 154

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


99
100
101
# File 'glue/cfn_ml_transform.rb', line 99

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

A user-defined, long-form description text for the machine learning transform.

Returns:

  • (String, nil)


260
261
262
# File 'glue/cfn_ml_transform.rb', line 260

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



264
265
266
267
# File 'glue/cfn_ml_transform.rb', line 264

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

#envAWSCDK::Interfaces::ResourceEnvironment



159
160
161
# File 'glue/cfn_ml_transform.rb', line 159

def env()
  jsii_get_property("env")
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:



573
574
575
576
577
# File 'glue/cfn_ml_transform.rb', line 573

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.



584
585
586
587
# File 'glue/cfn_ml_transform.rb', line 584

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

#glue_versionString?

This value determines which version of AWS Glue this machine learning transform is compatible with.

Returns:

  • (String, nil)


272
273
274
# File 'glue/cfn_ml_transform.rb', line 272

def glue_version()
  jsii_get_property("glueVersion")
end

#glue_version=(value) ⇒ Object



276
277
278
279
# File 'glue/cfn_ml_transform.rb', line 276

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

#input_record_tablesAWSCDK::IResolvable, AWSCDK::Glue::CfnMLTransform::InputRecordTablesProperty

A list of AWS Glue table definitions used by the transform.



210
211
212
# File 'glue/cfn_ml_transform.rb', line 210

def input_record_tables()
  jsii_get_property("inputRecordTables")
end

#input_record_tables=(value) ⇒ Object



214
215
216
217
218
# File 'glue/cfn_ml_transform.rb', line 214

def input_record_tables=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnMLTransform::InputRecordTablesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbk1MVHJhbnNmb3JtLklucHV0UmVjb3JkVGFibGVzUHJvcGVydHkifV19fQ==")), "inputRecordTables")
  jsii_set_property("inputRecordTables", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



654
655
656
657
# File 'glue/cfn_ml_transform.rb', line 654

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

#logical_idString

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)


111
112
113
# File 'glue/cfn_ml_transform.rb', line 111

def logical_id()
  jsii_get_property("logicalId")
end

#max_capacityNumeric?

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.

Returns:

  • (Numeric, nil)


284
285
286
# File 'glue/cfn_ml_transform.rb', line 284

def max_capacity()
  jsii_get_property("maxCapacity")
end

#max_capacity=(value) ⇒ Object



288
289
290
291
# File 'glue/cfn_ml_transform.rb', line 288

def max_capacity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxCapacity") unless value.nil?
  jsii_set_property("maxCapacity", value)
end

#max_retriesNumeric?

The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

Returns:

  • (Numeric, nil)


296
297
298
# File 'glue/cfn_ml_transform.rb', line 296

def max_retries()
  jsii_get_property("maxRetries")
end

#max_retries=(value) ⇒ Object



300
301
302
303
# File 'glue/cfn_ml_transform.rb', line 300

def max_retries=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxRetries") unless value.nil?
  jsii_set_property("maxRetries", value)
end

#ml_transform_refAWSCDK::Interfaces::AWSGlue::MLTransformReference

A reference to a MLTransform resource.



196
197
198
# File 'glue/cfn_ml_transform.rb', line 196

def ml_transform_ref()
  jsii_get_property("mlTransformRef")
end

#nameString?

A user-defined name for the machine learning transform.

Names are required to be unique. Name is optional:.

Returns:

  • (String, nil)


310
311
312
# File 'glue/cfn_ml_transform.rb', line 310

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



314
315
316
317
# File 'glue/cfn_ml_transform.rb', line 314

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


94
95
96
# File 'glue/cfn_ml_transform.rb', line 94

def node()
  jsii_get_property("node")
end

#number_of_workersNumeric?

The number of workers of a defined workerType that are allocated when a task of the transform runs.

Returns:

  • (Numeric, nil)


322
323
324
# File 'glue/cfn_ml_transform.rb', line 322

def number_of_workers()
  jsii_get_property("numberOfWorkers")
end

#number_of_workers=(value) ⇒ Object



326
327
328
329
# File 'glue/cfn_ml_transform.rb', line 326

def number_of_workers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfWorkers") unless value.nil?
  jsii_set_property("numberOfWorkers", value)
end

#obtain_dependenciesArray<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:



595
596
597
# File 'glue/cfn_ml_transform.rb', line 595

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



602
603
604
# File 'glue/cfn_ml_transform.rb', line 602

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
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.



395
396
397
398
# File 'glue/cfn_ml_transform.rb', line 395

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

#refString

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)


130
131
132
# File 'glue/cfn_ml_transform.rb', line 130

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:



613
614
615
616
# File 'glue/cfn_ml_transform.rb', line 613

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})


620
621
622
623
# File 'glue/cfn_ml_transform.rb', line 620

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:



630
631
632
633
634
# File 'glue/cfn_ml_transform.rb', line 630

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

#roleString

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

Returns:

  • (String)


223
224
225
# File 'glue/cfn_ml_transform.rb', line 223

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object



227
228
229
230
# File 'glue/cfn_ml_transform.rb', line 227

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

#should_synthesizeBoolean

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.



639
640
641
# File 'glue/cfn_ml_transform.rb', line 639

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



120
121
122
# File 'glue/cfn_ml_transform.rb', line 120

def stack()
  jsii_get_property("stack")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



203
204
205
# File 'glue/cfn_ml_transform.rb', line 203

def tags()
  jsii_get_property("tags")
end

#tags_rawObject

The tags to use with this machine learning transform.

Returns:

  • (Object)


235
236
237
# File 'glue/cfn_ml_transform.rb', line 235

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



239
240
241
242
# File 'glue/cfn_ml_transform.rb', line 239

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#timeoutNumeric?

The timeout in minutes of the machine learning transform.

Returns:

  • (Numeric, nil)


334
335
336
# File 'glue/cfn_ml_transform.rb', line 334

def timeout()
  jsii_get_property("timeout")
end

#timeout=(value) ⇒ Object



338
339
340
341
# File 'glue/cfn_ml_transform.rb', line 338

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



371
372
373
# File 'glue/cfn_ml_transform.rb', line 371

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

#transform_encryptionAWSCDK::IResolvable, ...

The encryption-at-rest settings of the transform that apply to accessing user data.



346
347
348
# File 'glue/cfn_ml_transform.rb', line 346

def transform_encryption()
  jsii_get_property("transformEncryption")
end

#transform_encryption=(value) ⇒ Object



350
351
352
353
354
# File 'glue/cfn_ml_transform.rb', line 350

def transform_encryption=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnMLTransform::TransformEncryptionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbk1MVHJhbnNmb3JtLlRyYW5zZm9ybUVuY3J5cHRpb25Qcm9wZXJ0eSJ9XX19")), "transformEncryption") unless value.nil?
  jsii_set_property("transformEncryption", value)
end

#transform_parametersAWSCDK::IResolvable, AWSCDK::Glue::CfnMLTransform::TransformParametersProperty

The algorithm-specific parameters that are associated with the machine learning transform.



247
248
249
# File 'glue/cfn_ml_transform.rb', line 247

def transform_parameters()
  jsii_get_property("transformParameters")
end

#transform_parameters=(value) ⇒ Object



251
252
253
254
255
# File 'glue/cfn_ml_transform.rb', line 251

def transform_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnMLTransform::TransformParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbk1MVHJhbnNmb3JtLlRyYW5zZm9ybVBhcmFtZXRlcnNQcm9wZXJ0eSJ9XX19")), "transformParameters")
  jsii_set_property("transformParameters", value)
end

#updated_properitesHash{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})


167
168
169
# File 'glue/cfn_ml_transform.rb', line 167

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


177
178
179
# File 'glue/cfn_ml_transform.rb', line 177

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


645
646
647
648
# File 'glue/cfn_ml_transform.rb', line 645

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)


384
385
386
387
388
389
# File 'glue/cfn_ml_transform.rb', line 384

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

#worker_typeString?

The type of predefined worker that is allocated when a task of this transform runs.

Returns:

  • (String, nil)


359
360
361
# File 'glue/cfn_ml_transform.rb', line 359

def worker_type()
  jsii_get_property("workerType")
end

#worker_type=(value) ⇒ Object



363
364
365
366
# File 'glue/cfn_ml_transform.rb', line 363

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