Package software.amazon.awscdk.services.glue

Interface CfnCrawler.S3TargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCrawler.S3TargetProperty.Jsii$Proxy

Enclosing class:

CfnCrawler

@Stability(Stable)
public static interface CfnCrawler.S3TargetProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 S3TargetProperty s3TargetProperty = S3TargetProperty.builder()
         .connectionName("connectionName")
         .dlqEventQueueArn("dlqEventQueueArn")
         .eventQueueArn("eventQueueArn")
         .exclusions(List.of("exclusions"))
         .path("path")
         .sampleSize(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCrawler.S3TargetProperty.Builder	A builder for CfnCrawler.S3TargetProperty
static final class	CfnCrawler.S3TargetProperty.Jsii$Proxy	An implementation for CfnCrawler.S3TargetProperty

Method Summary

Modifier and Type	Method	Description
static CfnCrawler.S3TargetProperty.Builder	builder()
default String	getConnectionName()	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).
default String	getDlqEventQueueArn()	A valid Amazon dead-letter SQS ARN.
default String	getEventQueueArn()	A valid Amazon SQS ARN.
default List<String>	getExclusions()	A list of glob patterns used to exclude from the crawl.
default String	getPath()	The path to the Amazon S3 target.
default Number	getSampleSize()	Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionName

@Stability(Stable)
@Nullable
default String getConnectionName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-connectionname

getDlqEventQueueArn

@Stability(Stable)
@Nullable
default String getDlqEventQueueArn()

A valid Amazon dead-letter SQS ARN.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-dlqeventqueuearn

getEventQueueArn

@Stability(Stable)
@Nullable
default String getEventQueueArn()

A valid Amazon SQS ARN.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-eventqueuearn

getExclusions

@Stability(Stable)
@Nullable
default List<String> getExclusions()

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

For more information, see Catalog Tables with a Crawler .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions

getPath

@Stability(Stable)
@Nullable
default String getPath()

The path to the Amazon S3 target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path

getSampleSize

@Stability(Stable)
@Nullable
default Number getSampleSize()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-samplesize

builder

@Stability(Stable)
static CfnCrawler.S3TargetProperty.Builder builder()

Returns:

a CfnCrawler.S3TargetProperty.Builder of CfnCrawler.S3TargetProperty