Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppFlow.Types.GlueDataCatalogConfig

Description

Documentation

data GlueDataCatalogConfig Source #

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: newGlueDataCatalogConfig smart constructor.

Constructors

GlueDataCatalogConfig'

Fields

roleArn :: Text
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 :: Text
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 :: Text
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.

Instances

Instances details

FromJSON GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods parseJSON :: Value -> Parser GlueDataCatalogConfig # parseJSONList :: Value -> Parser [GlueDataCatalogConfig] #
ToJSON GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods toJSON :: GlueDataCatalogConfig -> Value # toEncoding :: GlueDataCatalogConfig -> Encoding # toJSONList :: [GlueDataCatalogConfig] -> Value # toEncodingList :: [GlueDataCatalogConfig] -> Encoding #
Generic GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Associated Types type Rep GlueDataCatalogConfig :: Type -> Type # Methods from :: GlueDataCatalogConfig -> Rep GlueDataCatalogConfig x # to :: Rep GlueDataCatalogConfig x -> GlueDataCatalogConfig #
Read GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods readsPrec :: Int -> ReadS GlueDataCatalogConfig # readList :: ReadS [GlueDataCatalogConfig] # readPrec :: ReadPrec GlueDataCatalogConfig # readListPrec :: ReadPrec [GlueDataCatalogConfig] #
Show GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods showsPrec :: Int -> GlueDataCatalogConfig -> ShowS # show :: GlueDataCatalogConfig -> String # showList :: [GlueDataCatalogConfig] -> ShowS #
NFData GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods rnf :: GlueDataCatalogConfig -> () #
Eq GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods (==) :: GlueDataCatalogConfig -> GlueDataCatalogConfig -> Bool # (/=) :: GlueDataCatalogConfig -> GlueDataCatalogConfig -> Bool #
Hashable GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig Methods hashWithSalt :: Int -> GlueDataCatalogConfig -> Int # hash :: GlueDataCatalogConfig -> Int #
type Rep GlueDataCatalogConfig Source #
Instance details Defined in Amazonka.AppFlow.Types.GlueDataCatalogConfig type Rep GlueDataCatalogConfig = D1 ('MetaData "GlueDataCatalogConfig" "Amazonka.AppFlow.Types.GlueDataCatalogConfig" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "GlueDataCatalogConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "tablePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGlueDataCatalogConfig Source #

Arguments

:: Text	`$sel:roleArn:GlueDataCatalogConfig'`
-> Text	`$sel:databaseName:GlueDataCatalogConfig'`
-> Text	`$sel:tablePrefix:GlueDataCatalogConfig'`
-> GlueDataCatalogConfig

Create a value of GlueDataCatalogConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:roleArn:GlueDataCatalogConfig', glueDataCatalogConfig_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.

$sel:databaseName:GlueDataCatalogConfig', glueDataCatalogConfig_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.

$sel:tablePrefix:GlueDataCatalogConfig', glueDataCatalogConfig_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.

glueDataCatalogConfig_roleArn :: Lens' GlueDataCatalogConfig Text Source #

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.

glueDataCatalogConfig_databaseName :: Lens' GlueDataCatalogConfig Text Source #

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.

glueDataCatalogConfig_tablePrefix :: Lens' GlueDataCatalogConfig Text Source #

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.