Class S3Action

java.lang.Object
software.amazon.awssdk.services.mailmanager.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>

Writes the MIME content of the email to an S3 bucket.

See Also:

  • Method Details

    • actionFailurePolicy

      public final ActionFailurePolicy actionFailurePolicy()

      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

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

      Returns:
      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
      See Also:

    • actionFailurePolicyAsString

      public final String actionFailurePolicyAsString()

      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

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

      Returns:
      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

      Returns:
      The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

    • s3Bucket

      public final String s3Bucket()

      The bucket name of the S3 bucket to write to.

      Returns:
      The bucket name of the S3 bucket to write to.

    • s3Prefix

      public final String s3Prefix()

      The S3 prefix to use for the write to the s3 bucket.

      Returns:
      The S3 prefix to use for the write to the s3 bucket.

    • s3SseKmsKeyId

      public final String s3SseKmsKeyId()

      The KMS Key ID to use to encrypt the message in S3.

      Returns:
      The KMS Key ID to use to encrypt the message in S3.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.