interface S3DestinationConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTAnalytics.CfnDataset.S3DestinationConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnDataset_S3DestinationConfigurationProperty |
![]() | software.amazon.awscdk.services.iotanalytics.CfnDataset.S3DestinationConfigurationProperty |
![]() | aws_cdk.aws_iotanalytics.CfnDataset.S3DestinationConfigurationProperty |
![]() | aws-cdk-lib » aws_iotanalytics » CfnDataset » S3DestinationConfigurationProperty |
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 { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';
const s3DestinationConfigurationProperty: iotanalytics.CfnDataset.S3DestinationConfigurationProperty = {
bucket: 'bucket',
key: 'key',
roleArn: 'roleArn',
// the properties below are optional
glueConfiguration: {
databaseName: 'databaseName',
tableName: 'tableName',
},
};
Properties
Name | Type | Description |
---|---|---|
bucket | string | The name of the S3 bucket to which dataset contents are delivered. |
key | string | The key of the dataset contents object in an S3 bucket. |
role | string | The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources. |
glue | IResolvable | Glue | Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service. |
bucket
Type:
string
The name of the S3 bucket to which dataset contents are delivered.
key
Type:
string
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 samescheduleTime
but differentversionId
s. This means that one dataset content overwrites the other.
roleArn
Type:
string
The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
glueConfiguration?
Type:
IResolvable
|
Glue
(optional)
Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.