Package software.amazon.awssdk.services.iot.model

Class S3Action

java.lang.Object

software.amazon.awssdk.services.iot.model.S3Action

All Implemented Interfaces:

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

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

Describes an action to write data to an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3Action.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketName()	The Amazon S3 bucket.
static S3Action.Builder	builder()
CannedAccessControlList	cannedAcl()	The Amazon S3 canned ACL that controls access to the object identified by the object key.
String	cannedAclAsString()	The Amazon S3 canned ACL that controls access to the object identified by the object key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The object key.
String	roleArn()	The ARN of the IAM role that grants access.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends S3Action.Builder>	serializableBuilderClass()
S3Action.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

roleArn

public final String roleArn()

The ARN of the IAM role that grants access.

Returns:

The ARN of the IAM role that grants access.

bucketName

public final String bucketName()

The Amazon S3 bucket.

Returns:

The Amazon S3 bucket.

key

public final String key()

The object key. For more information, see Actions, resources, and condition keys for Amazon S3.

Returns:

The object key. For more information, see Actions, resources, and condition keys for Amazon S3.

cannedAcl

public final CannedAccessControlList cannedAcl()

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

If the service returns an enum value that is not available in the current SDK version, cannedAcl will return CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAclAsString().

Returns:

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

See Also:

CannedAccessControlList

cannedAclAsString

public final String cannedAclAsString()

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

If the service returns an enum value that is not available in the current SDK version, cannedAcl will return CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAclAsString().

Returns:

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

See Also:

CannedAccessControlList

toBuilder

public S3Action.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3Action.Builder,S3Action>

builder

public static S3Action.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo