Package software.amazon.awssdk.services.quicksight.model

Class S3BucketConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.S3BucketConfiguration

All Implemented Interfaces:

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

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

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3BucketConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketName()	The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
String	bucketPrefix()	The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
String	bucketRegion()	The region that the Amazon S3 bucket is located in.
static S3BucketConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends S3BucketConfiguration.Builder>	serializableBuilderClass()
S3BucketConfiguration.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

bucketName

public final String bucketName()

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

Returns:

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

bucketPrefix

public final String bucketPrefix()

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

Returns:

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

bucketRegion

public final String bucketRegion()

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

Returns:

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

toBuilder

public S3BucketConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3BucketConfiguration.Builder,S3BucketConfiguration>

builder

public static S3BucketConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends S3BucketConfiguration.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