Package software.amazon.awscdk.services.iotanalytics

Interface CfnDataset.S3DestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.S3DestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.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.services.iotanalytics.*;
 S3DestinationConfigurationProperty s3DestinationConfigurationProperty = S3DestinationConfigurationProperty.builder()
         .bucket("bucket")
         .key("key")
         .roleArn("roleArn")
         // the properties below are optional
         .glueConfiguration(GlueConfigurationProperty.builder()
                 .databaseName("databaseName")
                 .tableName("tableName")
                 .build())
         .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	CfnDataset.S3DestinationConfigurationProperty.Builder	A builder for CfnDataset.S3DestinationConfigurationProperty
static final class	CfnDataset.S3DestinationConfigurationProperty.Jsii$Proxy	An implementation for CfnDataset.S3DestinationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataset.S3DestinationConfigurationProperty.Builder	builder()
String	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.
String	getKey()	The key of the dataset contents object in an S3 bucket.
String	getRoleArn()	The ARN of the role that grants AWS IoT Analytics 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)
@NotNull
String getBucket()

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

See Also:

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

getKey

@Stability(Stable)
@NotNull
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)
@NotNull
String getRoleArn()

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

See Also:

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

getGlueConfiguration

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

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

See Also:

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

builder

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

Returns:

a CfnDataset.S3DestinationConfigurationProperty.Builder of CfnDataset.S3DestinationConfigurationProperty