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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public S3Action.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<S3Action.Builder,S3Action>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.