Enable Federation

cloudtrail_enable_federation

R Documentation

Enables Lake query federation on the specified event data store¶

Description¶

Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query.

When you enable Lake query federation, CloudTrail creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in Lake Formation, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog.

For more information about Lake query federation, see Federate an event data store.

Usage¶

cloudtrail_enable_federation(EventDataStore, FederationRoleArn)

Arguments¶

EventDataStore: [required] The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.
FederationRoleArn: [required] The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the required minimum permissions.

Value¶

A list with the following syntax:

list(
  EventDataStoreArn = "string",
  FederationStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED",
  FederationRoleArn = "string"
)

Request syntax¶

svc$enable_federation(
  EventDataStore = "string",
  FederationRoleArn = "string"
)