CfnDataLakeSettingsProps

class aws_cdk.aws_lakeformation.CfnDataLakeSettingsProps(*, admins=None, allow_external_data_filtering=None, allow_full_table_external_data_access=None, authorized_session_tag_value_list=None, create_database_default_permissions=None, create_table_default_permissions=None, external_data_filtering_allow_list=None, mutation_type=None, parameters=None, trusted_resource_owners=None)

Bases: object

Properties for defining a CfnDataLakeSettings.

Parameters:

admins (Union[IResolvable, Sequence[Union[IResolvable, DataLakePrincipalProperty, Dict[str, Any]]], None]) – A list of AWS Lake Formation principals.
allow_external_data_filtering (Union[bool, IResolvable, None]) – Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation . If set to true, you allow Amazon EMR clusters or other third-party engines to access data in Amazon S3 locations that are registered with Lake Formation . If false or null, no third-party query engines will be able to access data in Amazon S3 locations that are registered with Lake Formation. For more information, see External data filtering setting .
allow_full_table_external_data_access (Union[bool, IResolvable, None]) – Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access. It provides query engines and applications performance benefits as well as simplifies data access. Amazon EMR on Amazon EC2 is able to leverage this setting. For more information, see ` <https://docs.aws.amazon.com/lake-formation/latest/dg/using-cred-vending.html>`_
authorized_session_tag_value_list (Optional[Sequence[str]]) – Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user’s role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = “LakeFormationTrustedCaller” and value = “TRUE” and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation ‘s administrative API operations.
create_database_default_permissions (Union[IResolvable, Sequence[Union[IResolvable, PrincipalPermissionsProperty, Dict[str, Any]]], None]) – Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates that the access is controlled by Lake Formation permissions. ALL permissions assigned to IAM_ALLOWED_PRINCIPALS group indicates that the user’s IAM permissions determine the access to the database. This is referred to as the setting “Use only IAM access control,” and is to support backward compatibility with the AWS Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS . For more information, see Changing the default security settings for your data lake .
create_table_default_permissions (Union[IResolvable, Sequence[Union[IResolvable, PrincipalPermissionsProperty, Dict[str, Any]]], None]) –
Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates that the access is controlled by Lake Formation permissions. ALL permissions assigned to IAM_ALLOWED_PRINCIPALS group indicate that the user’s IAM permissions determine the access to the table. This is referred to as the setting “Use only IAM access control,” and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL permissions to IAM_ALLOWED_PRINCIPALS . For more information, see Changing the default security settings for your data lake .
external_data_filtering_allow_list (Union[IResolvable, Sequence[Union[IResolvable, DataLakePrincipalProperty, Dict[str, Any]]], None]) – A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
mutation_type (Optional[str]) – Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ). .. epigraph:: If you choose REPLACE , your current data lake settings will be replaced with the new values in your template.
parameters (Optional[Any]) – A key-value map that provides an additional configuration on your data lake. CrossAccountVersion is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, and 3.
trusted_resource_owners (Optional[Sequence[str]]) – An array of UTF-8 strings. A list of the resource-owning account IDs that the caller’s account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner’s CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html

ExampleMetadata:

infused

Example:

import aws_cdk as cdk
from aws_cdk.aws_glue_alpha import S3Table, Database, DataFormat, Schema
from aws_cdk.aws_lakeformation import CfnDataLakeSettings, CfnTag, CfnTagAssociation

# stack: cdk.Stack
# account_id: str


tag_key = "aws"
tag_values = ["dev"]

database = Database(self, "Database")

table = S3Table(self, "Table",
    database=database,
    columns=[Column(
        name="col1",
        type=Schema.STRING
    ), Column(
        name="col2",
        type=Schema.STRING
    )
    ],
    data_format=DataFormat.CSV
)

synthesizer = stack.synthesizer
CfnDataLakeSettings(self, "DataLakeSettings",
    admins=[CfnDataLakeSettings.DataLakePrincipalProperty(
        data_lake_principal_identifier=stack.format_arn(
            service="iam",
            resource="role",
            region="",
            account=account_id,
            resource_name="Admin"
        )
    ), CfnDataLakeSettings.DataLakePrincipalProperty(
        # The CDK cloudformation execution role.
        data_lake_principal_identifier=synthesizer.cloud_formation_execution_role_arn.replace("${AWS::Partition}", "aws")
    )
    ]
)

tag = CfnTag(self, "Tag",
    catalog_id=account_id,
    tag_key=tag_key,
    tag_values=tag_values
)

lf_tag_pair_property = CfnTagAssociation.LFTagPairProperty(
    catalog_id=account_id,
    tag_key=tag_key,
    tag_values=tag_values
)

tag_association = CfnTagAssociation(self, "TagAssociation",
    lf_tags=[lf_tag_pair_property],
    resource=CfnTagAssociation.ResourceProperty(
        table_with_columns=CfnTagAssociation.TableWithColumnsResourceProperty(
            database_name=database.database_name,
            column_names=["col1", "col2"],
            catalog_id=account_id,
            name=table.table_name
        )
    )
)

tag_association.node.add_dependency(tag)
tag_association.node.add_dependency(table)

Attributes

admins

A list of AWS Lake Formation principals.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-admins

allow_external_data_filtering

Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .

If set to true, you allow Amazon EMR clusters or other third-party engines to access data in Amazon S3 locations that are registered with Lake Formation .

If false or null, no third-party query engines will be able to access data in Amazon S3 locations that are registered with Lake Formation.

For more information, see External data filtering setting .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowexternaldatafiltering

allow_full_table_external_data_access

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.

It provides query engines and applications performance benefits as well as simplifies data access. Amazon EMR on Amazon EC2 is able to leverage this setting.

For more information, see ` <https://docs.aws.amazon.com/lake-formation/latest/dg/using-cred-vending.html>`_

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-allowfulltableexternaldataaccess

authorized_session_tag_value_list

Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user’s role while assuming it.

Lake Formation will publish the acceptable key-value pair, for example key = “LakeFormationTrustedCaller” and value = “TRUE” and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation ‘s administrative API operations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-authorizedsessiontagvaluelist

create_database_default_permissions

Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

A null value indicates that the access is controlled by Lake Formation permissions. ALL permissions assigned to IAM_ALLOWED_PRINCIPALS group indicates that the user’s IAM permissions determine the access to the database. This is referred to as the setting “Use only IAM access control,” and is to support backward compatibility with the AWS Glue permission model implemented by IAM permissions.

The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createdatabasedefaultpermissions

create_table_default_permissions

Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

A null value indicates that the access is controlled by Lake Formation permissions. ALL permissions assigned to IAM_ALLOWED_PRINCIPALS group indicate that the user’s IAM permissions determine the access to the table. This is referred to as the setting “Use only IAM access control,” and is to support the backward compatibility with the AWS Glue permission model implemented by IAM permissions.

The only permitted values are an empty array or an array that contains a single JSON object that grants ALL permissions to IAM_ALLOWED_PRINCIPALS .

For more information, see Changing the default security settings for your data lake .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-createtabledefaultpermissions

external_data_filtering_allow_list

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-externaldatafilteringallowlist

mutation_type

Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).

If you choose REPLACE , your current data lake settings will be replaced with the new values in your template.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-mutationtype

parameters

A key-value map that provides an additional configuration on your data lake.

CrossAccountVersion is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, and 3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-parameters

trusted_resource_owners

An array of UTF-8 strings.

A list of the resource-owning account IDs that the caller’s account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner’s CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-datalakesettings.html#cfn-lakeformation-datalakesettings-trustedresourceowners