Class S3ReferenceDataSource

java.lang.Object
software.amazon.awssdk.services.kinesisanalytics.model.S3ReferenceDataSource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3ReferenceDataSource.Builder,S3ReferenceDataSource>
@Generated("software.amazon.awssdk:codegen") public final class S3ReferenceDataSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3ReferenceDataSource.Builder,S3ReferenceDataSource>

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

See Also:

  • Method Details

    • bucketARN

      public final String bucketARN()

      Amazon Resource Name (ARN) of the S3 bucket.

      Returns:
      Amazon Resource Name (ARN) of the S3 bucket.

    • fileKey

      public final String fileKey()

      Object key name containing reference data.

      Returns:
      Object key name containing reference data.

    • referenceRoleARN

      public final String referenceRoleARN()

      ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

      Returns:
      ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

    • toBuilder

      public S3ReferenceDataSource.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<S3ReferenceDataSource.Builder,S3ReferenceDataSource>
      Returns:
      a builder for type T

    • builder

      public static S3ReferenceDataSource.Builder builder()

    • serializableBuilderClass

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