Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTAnalytics.Types.S3DestinationConfiguration

Description

Documentation

data S3DestinationConfiguration Source #

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

See: newS3DestinationConfiguration smart constructor.

Constructors

S3DestinationConfiguration'

Fields

glueConfiguration :: Maybe GlueConfiguration
Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
bucket :: Text
The name of the S3 bucket to which dataset contents are delivered.
key :: Text
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 versionIds. This means that one dataset content overwrites the other.
roleArn :: Text
The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.

Instances

Instances details

Eq S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods (==) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool # (/=) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool #
Read S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods readsPrec :: Int -> ReadS S3DestinationConfiguration # readList :: ReadS [S3DestinationConfiguration] # readPrec :: ReadPrec S3DestinationConfiguration # readListPrec :: ReadPrec [S3DestinationConfiguration] #
Show S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods showsPrec :: Int -> S3DestinationConfiguration -> ShowS # show :: S3DestinationConfiguration -> String # showList :: [S3DestinationConfiguration] -> ShowS #
Generic S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Associated Types type Rep S3DestinationConfiguration :: Type -> Type # Methods from :: S3DestinationConfiguration -> Rep S3DestinationConfiguration x # to :: Rep S3DestinationConfiguration x -> S3DestinationConfiguration #
NFData S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods rnf :: S3DestinationConfiguration -> () #
Hashable S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods hashWithSalt :: Int -> S3DestinationConfiguration -> Int # hash :: S3DestinationConfiguration -> Int #
ToJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods toJSON :: S3DestinationConfiguration -> Value # toEncoding :: S3DestinationConfiguration -> Encoding # toJSONList :: [S3DestinationConfiguration] -> Value # toEncodingList :: [S3DestinationConfiguration] -> Encoding #
FromJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration Methods parseJSON :: Value -> Parser S3DestinationConfiguration # parseJSONList :: Value -> Parser [S3DestinationConfiguration] #
type Rep S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.S3DestinationConfiguration type Rep S3DestinationConfiguration = D1 ('MetaData "S3DestinationConfiguration" "Amazonka.IoTAnalytics.Types.S3DestinationConfiguration" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "S3DestinationConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "glueConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlueConfiguration)) :: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newS3DestinationConfiguration Source #

Arguments

:: Text	`$sel:bucket:S3DestinationConfiguration'`
-> Text	`$sel:key:S3DestinationConfiguration'`
-> Text	`$sel:roleArn:S3DestinationConfiguration'`
-> S3DestinationConfiguration

Create a value of S3DestinationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:glueConfiguration:S3DestinationConfiguration', s3DestinationConfiguration_glueConfiguration - Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.

$sel:bucket:S3DestinationConfiguration', s3DestinationConfiguration_bucket - The name of the S3 bucket to which dataset contents are delivered.

$sel:key:S3DestinationConfiguration', s3DestinationConfiguration_key - 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 versionIds. This means that one dataset content overwrites the other.

$sel:roleArn:S3DestinationConfiguration', s3DestinationConfiguration_roleArn - The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.

s3DestinationConfiguration_glueConfiguration :: Lens' S3DestinationConfiguration (Maybe GlueConfiguration) Source #

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

s3DestinationConfiguration_bucket :: Lens' S3DestinationConfiguration Text Source #

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

s3DestinationConfiguration_key :: Lens' S3DestinationConfiguration Text Source #

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 versionIds. This means that one dataset content overwrites the other.

s3DestinationConfiguration_roleArn :: Lens' S3DestinationConfiguration Text Source #

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