Class: AWSCDK::Glue::CfnCrawler::S3TargetProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_crawler.rb

Overview

Specifies a data store in Amazon Simple Storage Service (Amazon S3).

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection_name: nil, dlq_event_queue_arn: nil, event_queue_arn: nil, exclusions: nil, path: nil, sample_size: nil) ⇒ S3TargetProperty

Returns a new instance of S3TargetProperty.

Parameters:

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

    The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

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

    A valid Amazon dead-letter SQS ARN.

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

    A valid Amazon SQS ARN.

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

    A list of glob patterns used to exclude from the crawl.

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

    The path to the Amazon S3 target.

  • sample_size (Numeric, nil) (defaults to: nil) —

    Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'glue/cfn_crawler.rb', line 1239

def initialize(connection_name: nil, dlq_event_queue_arn: nil, event_queue_arn: nil, exclusions: nil, path: nil, sample_size: nil)
  @connection_name = connection_name
  Jsii::Type.check_type(@connection_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionName") unless @connection_name.nil?
  @dlq_event_queue_arn = dlq_event_queue_arn
  Jsii::Type.check_type(@dlq_event_queue_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dlqEventQueueArn") unless @dlq_event_queue_arn.nil?
  @event_queue_arn = event_queue_arn
  Jsii::Type.check_type(@event_queue_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventQueueArn") unless @event_queue_arn.nil?
  @exclusions = exclusions
  Jsii::Type.check_type(@exclusions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "exclusions") unless @exclusions.nil?
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless @path.nil?
  @sample_size = sample_size
  Jsii::Type.check_type(@sample_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sampleSize") unless @sample_size.nil?
end

Instance Attribute Details

#connection_name ⇒ String? (readonly)

The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC).

Returns:

  • (String, nil)

See Also:



1258
1259
1260
 
# File 'glue/cfn_crawler.rb', line 1258

def connection_name
  @connection_name
end

#dlq_event_queue_arn ⇒ String? (readonly)

A valid Amazon dead-letter SQS ARN.

For example, arn:aws:sqs:region:account:deadLetterQueue .

Returns:

  • (String, nil)

See Also:



1265
1266
1267
 
# File 'glue/cfn_crawler.rb', line 1265

def dlq_event_queue_arn
  @dlq_event_queue_arn
end

#event_queue_arn ⇒ String? (readonly)

A valid Amazon SQS ARN.

For example, arn:aws:sqs:region:account:sqs .

Returns:

  • (String, nil)

See Also:



1272
1273
1274
 
# File 'glue/cfn_crawler.rb', line 1272

def event_queue_arn
  @event_queue_arn
end

#exclusions ⇒ Array<String>? (readonly)

A list of glob patterns used to exclude from the crawl.

For more information, see Catalog Tables with a Crawler .

Returns:

  • (Array<String>, nil)

See Also:



1279
1280
1281
 
# File 'glue/cfn_crawler.rb', line 1279

def exclusions
  @exclusions
end

#path ⇒ String? (readonly)

The path to the Amazon S3 target.

Returns:

  • (String, nil)

See Also:



1284
1285
1286
 
# File 'glue/cfn_crawler.rb', line 1284

def path
  @path
end

#sample_size ⇒ Numeric? (readonly)

Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.

If not set, all the files are crawled. A valid value is an integer between 1 and 249.

Returns:

  • (Numeric, nil)

See Also:



1291
1292
1293
 
# File 'glue/cfn_crawler.rb', line 1291

def sample_size
  @sample_size
end

Class Method Details

.jsii_properties ⇒ Object 



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'glue/cfn_crawler.rb', line 1293

def self.jsii_properties
  {
    :connection_name => "connectionName",
    :dlq_event_queue_arn => "dlqEventQueueArn",
    :event_queue_arn => "eventQueueArn",
    :exclusions => "exclusions",
    :path => "path",
    :sample_size => "sampleSize",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'glue/cfn_crawler.rb', line 1304

def to_jsii
  result = {}
  result.merge!({
    "connectionName" => @connection_name,
    "dlqEventQueueArn" => @dlq_event_queue_arn,
    "eventQueueArn" => @event_queue_arn,
    "exclusions" => @exclusions,
    "path" => @path,
    "sampleSize" => @sample_size,
  })
  result.compact
end