Package software.amazon.awssdk.services.iotanalytics.model

Class S3DestinationConfiguration

java.lang.Object

software.amazon.awssdk.services.iotanalytics.model.S3DestinationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class S3DestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3DestinationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the S3 bucket to which dataset contents are delivered.
static S3DestinationConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GlueConfiguration	glueConfiguration()	Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.
int	hashCode()
String	key()	The key of the dataset contents object in an S3 bucket.
String	roleArn()	The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.
List<SdkField<?>>	sdkFields()
static Class<? extends S3DestinationConfiguration.Builder>	serializableBuilderClass()
S3DestinationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

bucket

public final String bucket()

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

Returns:

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

key

public final 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.

Returns:

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.

glueConfiguration

public final GlueConfiguration glueConfiguration()

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

Returns:

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

roleArn

public final String roleArn()

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

Returns:

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

toBuilder

public S3DestinationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3DestinationConfiguration.Builder,S3DestinationConfiguration>

builder

public static S3DestinationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends S3DestinationConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo