Skip to content

DataLakeSettings

Source code in docs_src/capo_lakeformation/types/data_lake_settings.py
class DataLakeSettings(TypedDict, closed=True):
    data_lake_admins: NotRequired[
        "capo_lakeformation.types.data_lake_principal_list.DataLakePrincipalList"
    ]
    """<p>A list of Lake Formation principals. Supported principals are IAM users or IAM roles.</p>"""
    read_only_admins: NotRequired[
        "capo_lakeformation.types.data_lake_principal_list.DataLakePrincipalList"
    ]
    """<p>A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.</p>"""
    create_database_default_permissions: NotRequired[
        "capo_lakeformation.types.principal_permissions_list.PrincipalPermissionsList"
    ]
    """<p>Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.</p> <p>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</p> <p>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html">Changing the Default Security Settings for Your Data Lake</a>.</p>"""
    create_table_default_permissions: NotRequired[
        "capo_lakeformation.types.principal_permissions_list.PrincipalPermissionsList"
    ]
    """<p>Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.</p> <p>A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions.</p> <p>The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html">Changing the Default Security Settings for Your Data Lake</a>.</p>"""
    parameters: NotRequired["capo_lakeformation.types.parameters_map.ParametersMap"]
    """<p>A key-value map that provides an additional configuration on your data lake. The following key-value pairs are supported:</p> <ul> <li> <p> <code>CROSS_ACCOUNT_VERSION</code> - Accepted values are 1, 2, 3, 4, and 5.</p> </li> <li> <p> <code>SET_SOURCE_IDENTITY</code> - Accepted values are <code>TRUE</code> and <code>FALSE</code>. When set to <code>TRUE</code>, Lake Formation includes the IAM role identifier that was used to query in the S3 data event CloudTrail logs for <code>s3:GetObject</code> calls. For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/cloudtrail-logging.html#source-identity-cloudtrail">Tracking query engine IAM roles in S3 data events</a>.</p> </li> </ul>"""
    trusted_resource_owners: NotRequired[
        "capo_lakeformation.types.trusted_resource_owners.TrustedResourceOwners"
    ]
    """<p>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.</p> <p>You may want to specify this property when you are in a high-trust boundary, such as the same team or company. </p>"""
    allow_external_data_filtering: NotRequired[
        "capo_lakeformation.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Whether to allow Amazon EMR clusters to access data managed by Lake Formation. </p> <p>If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.</p> <p>If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/initial-LF-setup.html#external-data-filter">(Optional) Allow external data filtering</a>.</p>"""
    allow_full_table_external_data_access: NotRequired[
        "capo_lakeformation.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.</p>"""
    external_data_filtering_allow_list: NotRequired[
        "capo_lakeformation.types.data_lake_principal_list.DataLakePrincipalList"
    ]
    """<p>A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.></p>"""
    authorized_session_tag_value_list: NotRequired[
        "capo_lakeformation.types.authorized_session_tag_value_list.AuthorizedSessionTagValueList"
    ]
    """<p>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 APIs.</p>"""

allow_external_data_filtering instance-attribute

allow_external_data_filtering: NotRequired[NullableBoolean]

Whether to allow Amazon EMR clusters to access data managed by Lake Formation.

If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.

If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.

For more information, see (Optional) Allow external data filtering.

allow_full_table_external_data_access instance-attribute

allow_full_table_external_data_access: NotRequired[NullableBoolean]

Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.

authorized_session_tag_value_list instance-attribute

authorized_session_tag_value_list: NotRequired[AuthorizedSessionTagValueList]

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 APIs.

create_database_default_permissions instance-attribute

create_database_default_permissions: NotRequired[PrincipalPermissionsList]

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

A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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 instance-attribute

create_table_default_permissions: NotRequired[PrincipalPermissionsList]

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

A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the 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.

data_lake_admins instance-attribute

data_lake_admins: NotRequired[DataLakePrincipalList]

A list of Lake Formation principals. Supported principals are IAM users or IAM roles.

external_data_filtering_allow_list instance-attribute

external_data_filtering_allow_list: NotRequired[DataLakePrincipalList]

A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>

parameters instance-attribute

parameters: NotRequired[ParametersMap]

A key-value map that provides an additional configuration on your data lake. The following key-value pairs are supported:

  • CROSS_ACCOUNT_VERSION - Accepted values are 1, 2, 3, 4, and 5.

  • SET_SOURCE_IDENTITY - Accepted values are TRUE and FALSE. When set to TRUE, Lake Formation includes the IAM role identifier that was used to query in the S3 data event CloudTrail logs for s3:GetObject calls. For more information, see Tracking query engine IAM roles in S3 data events.

read_only_admins instance-attribute

read_only_admins: NotRequired[DataLakePrincipalList]

A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles.

trusted_resource_owners instance-attribute

trusted_resource_owners: NotRequired[TrustedResourceOwners]

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.