2.233.0

interface S3DestinationConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.IoTAnalytics.Mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotanalytics/mixins#CfnDatasetPropsMixin_S3DestinationConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.iotanalytics.mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_iotanalytics.mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_iotanalytics » mixins » CfnDatasetPropsMixin » S3DestinationConfigurationProperty

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iotanalytics_mixins } from '@aws-cdk/mixins-preview/aws-iotanalytics';
const s3DestinationConfigurationProperty: iotanalytics_mixins.CfnDatasetPropsMixin.S3DestinationConfigurationProperty = {
  bucket: 'bucket',
  glueConfiguration: {
    databaseName: 'databaseName',
    tableName: 'tableName',
  },
  key: 'key',
  roleArn: 'roleArn',
};

Properties

NameTypeDescription
bucket?stringThe name of the S3 bucket to which dataset contents are delivered.
glueConfiguration?IResolvable | GlueConfigurationPropertyConfiguration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
key?stringThe key of the dataset contents object in an S3 bucket.
roleArn?stringThe ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

bucket?

Type: string (optional)

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

glueConfiguration?

Type: IResolvable | GlueConfigurationProperty (optional)

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

key?

Type: string (optional)

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

roleArn?

Type: string (optional)

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

← PreviousNext →