com.amazonaws.services.appflow.model

Class GlueDataCatalogConfig

java.lang.Object

com.amazonaws.services.appflow.model.GlueDataCatalogConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GlueDataCatalogConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlueDataCatalogConfig()

Method Summary

Modifier and Type	Method and Description
GlueDataCatalogConfig	clone()
boolean	equals(Object obj)
String	getDatabaseName() The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account.
String	getRoleArn() 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.
String	getTablePrefix() A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDatabaseName(String databaseName) The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account.
void	setRoleArn(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.
void	setTablePrefix(String tablePrefix) A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting.
String	toString() Returns a string representation of this object.
GlueDataCatalogConfig	withDatabaseName(String databaseName) The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account.
GlueDataCatalogConfig	withRoleArn(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.
GlueDataCatalogConfig	withTablePrefix(String tablePrefix) A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlueDataCatalogConfig

public GlueDataCatalogConfig()

Method Detail

setRoleArn

public void setRoleArn(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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public GlueDataCatalogConfig withRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDatabaseName

public void setDatabaseName(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.

Parameters:

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.

getDatabaseName

public String getDatabaseName()

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.

withDatabaseName

public GlueDataCatalogConfig withDatabaseName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTablePrefix

public void setTablePrefix(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.

Parameters:

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.

getTablePrefix

public String getTablePrefix()

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.

withTablePrefix

public GlueDataCatalogConfig withTablePrefix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GlueDataCatalogConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.