Package software.amazon.awscdk.services.glue

Interface CfnCrawler.DynamoDBTargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCrawler.DynamoDBTargetProperty.Jsii$Proxy

Enclosing class:

CfnCrawler

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

Specifies an Amazon DynamoDB table to crawl.

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.*;
 DynamoDBTargetProperty dynamoDBTargetProperty = DynamoDBTargetProperty.builder()
         .path("path")
         .scanAll(false)
         .scanRate(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCrawler.DynamoDBTargetProperty.Builder	builder()
default String	getPath()	The name of the DynamoDB table to crawl.
default Object	getScanAll()	Indicates whether to scan all the records, or to sample rows from the table.
default Number	getScanRate()	The percentage of the configured read capacity units to use by the AWS Glue crawler.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPath

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

The name of the DynamoDB table to crawl.

See Also:

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

getScanAll

@Stability(Stable)
@Nullable
default Object getScanAll()

Indicates whether to scan all the records, or to sample rows from the table.

Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true .

Returns union: either Boolean or IResolvable

See Also:

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

getScanRate

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

The percentage of the configured read capacity units to use by the AWS Glue crawler.

Read capacity units is a term defined by DynamoDB, and is a numeric value that acts as rate limiter for the number of reads that can be performed on that table per second.

The valid values are null or a value between 0.1 to 1.5. A null value is used when user does not provide a value, and defaults to 0.5 of the configured Read Capacity Unit (for provisioned tables), or 0.25 of the max configured Read Capacity Unit (for tables using on-demand mode).

See Also:

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

builder

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

Returns:

a CfnCrawler.DynamoDBTargetProperty.Builder of CfnCrawler.DynamoDBTargetProperty