Class S3Action

    • Method Detail

      • 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:
        ActionFailurePolicy
      • 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:
        ActionFailurePolicy
      • 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)