Class: AWSCDK::Glue::CfnCrawler

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

Overview

The AWS::Glue::Crawler resource specifies an AWS Glue crawler.

For more information, see Cataloging Tables with a Crawler and Crawler Structure in the AWS Glue Developer Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCrawler

Create a new AWS::Glue::Crawler.

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::CfnCrawlerProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'glue/cfn_crawler.rb', line 20

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

Class Method Details

.arn_for_crawler(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_crawler(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nbHVlLklDcmF3bGVyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnCrawler", "arnForCrawler", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'glue/cfn_crawler.rb', line 206

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

.from_crawler_name(scope, id, crawler_name) ⇒ AWSCDK::Interfaces::AWSGlue::ICrawlerRef

Creates a new ICrawlerRef from a crawlerName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • crawler_name (String)

Returns:



97
98
99
100
101
102
 
# File 'glue/cfn_crawler.rb', line 97

def self.from_crawler_name(scope, id, crawler_name)
  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(crawler_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "crawlerName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnCrawler", "fromCrawlerName", [scope, id, crawler_name])
end

.is_cfn_crawler(x) ⇒ Boolean

Checks whether the given object is a CfnCrawler.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


108
109
110
111
 
# File 'glue/cfn_crawler.rb', line 108

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

.jsii_overridable_methods ⇒ Object 



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
81
82
 
# File 'glue/cfn_crawler.rb', line 28

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 },
    :crawler_ref => { kind: :property, name: "crawlerRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :targets => { kind: :property, name: "targets", is_optional: false },
    :classifiers => { kind: :property, name: "classifiers", is_optional: true },
    :configuration => { kind: :property, name: "configuration", is_optional: true },
    :crawler_security_configuration => { kind: :property, name: "crawlerSecurityConfiguration", is_optional: true },
    :database_name => { kind: :property, name: "databaseName", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :lake_formation_configuration => { kind: :property, name: "lakeFormationConfiguration", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :recrawl_policy => { kind: :property, name: "recrawlPolicy", is_optional: true },
    :schedule => { kind: :property, name: "schedule", is_optional: true },
    :schema_change_policy => { kind: :property, name: "schemaChangePolicy", is_optional: true },
    :table_prefix => { kind: :property, name: "tablePrefix", 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.



433
434
435
436
 
# File 'glue/cfn_crawler.rb', line 433

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:



445
446
447
448
 
# File 'glue/cfn_crawler.rb', line 445

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:



455
456
457
458
 
# File 'glue/cfn_crawler.rb', line 455

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:



466
467
468
469
470
 
# File 'glue/cfn_crawler.rb', line 466

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.


523
524
525
526
527
 
# File 'glue/cfn_crawler.rb', line 523

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.



533
534
535
536
 
# File 'glue/cfn_crawler.rb', line 533

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.



545
546
547
548
549
 
# File 'glue/cfn_crawler.rb', line 545

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:



558
559
560
561
 
# File 'glue/cfn_crawler.rb', line 558

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:



580
581
582
583
584
585
 
# File 'glue/cfn_crawler.rb', line 580

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'glue/cfn_crawler.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


589
590
591
592
 
# File 'glue/cfn_crawler.rb', line 589

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


169
170
171
 
# File 'glue/cfn_crawler.rb', line 169

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'glue/cfn_crawler.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#classifiers ⇒ Array<String>?

A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler.

Returns:

  • (Array<String>, nil) 


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

def classifiers()
  jsii_get_property("classifiers")
end

#classifiers=(value) ⇒ Object 



268
269
270
271
 
# File 'glue/cfn_crawler.rb', line 268

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

#configuration ⇒ String?

Crawler configuration information.

Returns:

  • (String, nil) 


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

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



280
281
282
283
 
# File 'glue/cfn_crawler.rb', line 280

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

#crawler_ref ⇒ AWSCDK::Interfaces::AWSGlue::CrawlerReference

A reference to a Crawler resource.

Returns:



213
214
215
 
# File 'glue/cfn_crawler.rb', line 213

def crawler_ref()
  jsii_get_property("crawlerRef")
end

#crawler_security_configuration ⇒ String?

The name of the SecurityConfiguration structure to be used by this crawler.

Returns:

  • (String, nil) 


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

def crawler_security_configuration()
  jsii_get_property("crawlerSecurityConfiguration")
end

#crawler_security_configuration=(value) ⇒ Object 



292
293
294
295
 
# File 'glue/cfn_crawler.rb', line 292

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


121
122
123
 
# File 'glue/cfn_crawler.rb', line 121

def creation_stack()
  jsii_get_property("creationStack")
end

#database_name ⇒ String?

The name of the database in which the crawler's output is stored.

Returns:

  • (String, nil) 


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

def database_name()
  jsii_get_property("databaseName")
end

#database_name=(value) ⇒ Object 



304
305
306
307
 
# File 'glue/cfn_crawler.rb', line 304

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

#description ⇒ String?

A description of the crawler.

Returns:

  • (String, nil) 


312
313
314
 
# File 'glue/cfn_crawler.rb', line 312

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



316
317
318
319
 
# File 'glue/cfn_crawler.rb', line 316

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'glue/cfn_crawler.rb', line 181

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:



602
603
604
605
606
 
# File 'glue/cfn_crawler.rb', line 602

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:



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



683
684
685
686
 
# File 'glue/cfn_crawler.rb', line 683

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

#lake_formation_configuration ⇒ AWSCDK::IResolvable, ...

Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

Returns:



324
325
326
 
# File 'glue/cfn_crawler.rb', line 324

def lake_formation_configuration()
  jsii_get_property("lakeFormationConfiguration")
end

#lake_formation_configuration=(value) ⇒ Object 



328
329
330
331
332
 
# File 'glue/cfn_crawler.rb', line 328

def lake_formation_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCrawler::LakeFormationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNyYXdsZXIuTGFrZUZvcm1hdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "lakeFormationConfiguration") unless value.nil?
  jsii_set_property("lakeFormationConfiguration", value)
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) 


133
134
135
 
# File 'glue/cfn_crawler.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the crawler.

Returns:

  • (String, nil) 


337
338
339
 
# File 'glue/cfn_crawler.rb', line 337

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



341
342
343
344
 
# File 'glue/cfn_crawler.rb', line 341

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'glue/cfn_crawler.rb', line 116

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:



624
625
626
 
# File 'glue/cfn_crawler.rb', line 624

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:



631
632
633
 
# File 'glue/cfn_crawler.rb', line 631

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.



424
425
426
427
 
# File 'glue/cfn_crawler.rb', line 424

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

#recrawl_policy ⇒ AWSCDK::IResolvable, ...

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

Returns:



349
350
351
 
# File 'glue/cfn_crawler.rb', line 349

def recrawl_policy()
  jsii_get_property("recrawlPolicy")
end

#recrawl_policy=(value) ⇒ Object 



353
354
355
356
357
 
# File 'glue/cfn_crawler.rb', line 353

def recrawl_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCrawler::RecrawlPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNyYXdsZXIuUmVjcmF3bFBvbGljeVByb3BlcnR5In1dfX0=")), "recrawlPolicy") unless value.nil?
  jsii_set_property("recrawlPolicy", value)
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) 


152
153
154
 
# File 'glue/cfn_crawler.rb', line 152

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:



642
643
644
645
 
# File 'glue/cfn_crawler.rb', line 642

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


649
650
651
652
 
# File 'glue/cfn_crawler.rb', line 649

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:



659
660
661
662
663
 
# File 'glue/cfn_crawler.rb', line 659

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

#role ⇒ String

The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

Returns:

  • (String) 


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

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object 



231
232
233
234
 
# File 'glue/cfn_crawler.rb', line 231

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

#schedule ⇒ AWSCDK::IResolvable, ...

For scheduled crawlers, the schedule when the crawler runs.

Returns:



362
363
364
 
# File 'glue/cfn_crawler.rb', line 362

def schedule()
  jsii_get_property("schedule")
end

#schedule=(value) ⇒ Object 



366
367
368
369
370
 
# File 'glue/cfn_crawler.rb', line 366

def schedule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCrawler::ScheduleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNyYXdsZXIuU2NoZWR1bGVQcm9wZXJ0eSJ9XX19")), "schedule") unless value.nil?
  jsii_set_property("schedule", value)
end

#schema_change_policy ⇒ AWSCDK::IResolvable, ...

The policy that specifies update and delete behaviors for the crawler.

Returns:



375
376
377
 
# File 'glue/cfn_crawler.rb', line 375

def schema_change_policy()
  jsii_get_property("schemaChangePolicy")
end

#schema_change_policy=(value) ⇒ Object 



379
380
381
382
383
 
# File 'glue/cfn_crawler.rb', line 379

def schema_change_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCrawler::SchemaChangePolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNyYXdsZXIuU2NoZW1hQ2hhbmdlUG9saWN5UHJvcGVydHkifV19fQ==")), "schemaChangePolicy") unless value.nil?
  jsii_set_property("schemaChangePolicy", 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.



668
669
670
 
# File 'glue/cfn_crawler.rb', line 668

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:



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

def stack()
  jsii_get_property("stack")
end

#table_prefix ⇒ String?

The prefix added to the names of tables that are created.

Returns:

  • (String, nil) 


388
389
390
 
# File 'glue/cfn_crawler.rb', line 388

def table_prefix()
  jsii_get_property("tablePrefix")
end

#table_prefix=(value) ⇒ Object 



392
393
394
395
 
# File 'glue/cfn_crawler.rb', line 392

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



220
221
222
 
# File 'glue/cfn_crawler.rb', line 220

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

The tags to use with this crawler.

Returns:

  • (Object) 


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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



243
244
245
246
 
# File 'glue/cfn_crawler.rb', line 243

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

#targets ⇒ AWSCDK::IResolvable, AWSCDK::Glue::CfnCrawler::TargetsProperty

A collection of targets to crawl.

Returns:



251
252
253
 
# File 'glue/cfn_crawler.rb', line 251

def targets()
  jsii_get_property("targets")
end

#targets=(value) ⇒ Object 



255
256
257
258
259
 
# File 'glue/cfn_crawler.rb', line 255

def targets=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCrawler::TargetsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNyYXdsZXIuVGFyZ2V0c1Byb3BlcnR5In1dfX0=")), "targets")
  jsii_set_property("targets", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



400
401
402
 
# File 'glue/cfn_crawler.rb', line 400

def to_string()
  jsii_call_method("toString", [])
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}) 


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

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


199
200
201
 
# File 'glue/cfn_crawler.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


674
675
676
677
 
# File 'glue/cfn_crawler.rb', line 674

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) 


413
414
415
416
417
418
 
# File 'glue/cfn_crawler.rb', line 413

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