Package software.amazon.awssdk.services.appflow.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GlueDataCatalogConfig.Builder

Method Summary

Modifier and Type	Method	Description
static GlueDataCatalogConfig.Builder	builder()
String	databaseName()	The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GlueDataCatalogConfig.Builder>	serializableBuilderClass()
String	tablePrefix()	A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting.
GlueDataCatalogConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<GlueDataCatalogConfig.Builder,GlueDataCatalogConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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