Package software.amazon.awscdk.cfnpropertymixins.services.iotanalytics

Interface CfnDatasetPropsMixin.S3DestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDatasetPropsMixin.S3DestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDatasetPropsMixin

@Stability(Stable)
public static interface CfnDatasetPropsMixin.S3DestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration information for delivery of dataset contents to 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.cfnpropertymixins.services.iotanalytics.*;
 S3DestinationConfigurationProperty s3DestinationConfigurationProperty = S3DestinationConfigurationProperty.builder()
         .bucket("bucket")
         .glueConfiguration(GlueConfigurationProperty.builder()
                 .databaseName("databaseName")
                 .tableName("tableName")
                 .build())
         .key("key")
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDatasetPropsMixin.S3DestinationConfigurationProperty.Builder	builder()
default Object	getBucket()	The name of the S3 bucket to which dataset contents are delivered.
default Object	getGlueConfiguration()	Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
default String	getKey()	The key of the dataset contents object in an S3 bucket.
default Object	getRoleArn()	The ARN of the role that grants ITA permission to interact with your Amazon S3 and AWS Glue resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

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

The name of the S3 bucket to which dataset contents are delivered.

Returns union: either String or IBucketRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket

getGlueConfiguration

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

Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.

Returns union: either IResolvable or CfnDatasetPropsMixin.GlueConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration

getKey

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

The key of the dataset contents object in an S3 bucket.

Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

• Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.
• Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.
• Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionId s. This means that one dataset content overwrites the other.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key

getRoleArn

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

The ARN of the role that grants ITA permission to interact with your Amazon S3 and AWS Glue resources.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn

builder

@Stability(Stable)
static CfnDatasetPropsMixin.S3DestinationConfigurationProperty.Builder builder()

Returns:

a CfnDatasetPropsMixin.S3DestinationConfigurationProperty.Builder of CfnDatasetPropsMixin.S3DestinationConfigurationProperty