software.amazon.awssdk.services.iotanalytics.model

Interface S3DestinationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>, SdkBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>, SdkPojo

Enclosing class:

S3DestinationConfiguration

public static interface S3DestinationConfiguration.Builder
extends SdkPojo, CopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

Method Summary

Modifier and Type	Method and Description
S3DestinationConfiguration.Builder	bucket(String bucket) The name of the S3 bucket to which dataset contents are delivered.
default S3DestinationConfiguration.Builder	glueConfiguration(Consumer<GlueConfiguration.Builder> glueConfiguration) Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
S3DestinationConfiguration.Builder	glueConfiguration(GlueConfiguration glueConfiguration) Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
S3DestinationConfiguration.Builder	key(String key) The key of the dataset contents object in an S3 bucket.
S3DestinationConfiguration.Builder	roleArn(String roleArn) The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bucket

S3DestinationConfiguration.Builder bucket(String bucket)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

key

S3DestinationConfiguration.Builder key(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

glueConfiguration

S3DestinationConfiguration.Builder glueConfiguration(GlueConfiguration glueConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

glueConfiguration

default S3DestinationConfiguration.Builder glueConfiguration(Consumer<GlueConfiguration.Builder> glueConfiguration)

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

This is a convenience method that creates an instance of the GlueConfiguration.Builder avoiding the need to create one manually via GlueConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to glueConfiguration(GlueConfiguration).

Parameters:

glueConfiguration - a consumer that will call methods on GlueConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

glueConfiguration(GlueConfiguration)

roleArn

S3DestinationConfiguration.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.