Class GlueDataCatalogConfig

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

Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the flow that you configure with these settings.

You can configure a flow with these settings only when the flow destination is Amazon S3.

See Also:

  • Method Details

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.

      For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.

      For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.

    • databaseName

      public final String databaseName()

      The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.

      When you configure a new flow with this parameter, you must specify an existing database.

      Returns:
      The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow that you configure with this parameter.

      When you configure a new flow with this parameter, you must specify an existing database.

    • tablePrefix

      public final String tablePrefix()

      A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.

      Returns:
      A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.

    • toBuilder

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

    • builder

      public static GlueDataCatalogConfig.Builder builder()

    • serializableBuilderClass

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