AWS::LakeFormation::DataLakeSettings - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::LakeFormation::DataLakeSettings

The AWS::LakeFormation::DataLakeSettings resource is an Amazon Lake Formation resource type that manages the data lake settings for your account.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::LakeFormation::DataLakeSettings",
  "Properties" : {
      "Admins" : [ DataLakePrincipal, ... ],
      "AllowExternalDataFiltering" : Boolean,
      "AllowFullTableExternalDataAccess" : Boolean,
      "AuthorizedSessionTagValueList" : [ String, ... ],
      "CreateDatabaseDefaultPermissions" : [ PrincipalPermissions, ... ],
      "CreateTableDefaultPermissions" : [ PrincipalPermissions, ... ],
      "ExternalDataFilteringAllowList" : [ DataLakePrincipal, ... ],
      "MutationType" : String,
      "Parameters" : Json,
      "TrustedResourceOwners" : [ String, ... ]
    }
}

Properties

Admins

A list of Amazon Lake Formation principals.

Required: No

Type: Array of DataLakePrincipal

Update requires: No interruption

AllowExternalDataFiltering

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.

Required: No

Type: Boolean

Update requires: No interruption

AllowFullTableExternalDataAccess

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.amazonaws.cn/lake-formation/latest/dg/using-cred-vending.html

Required: No

Type: Boolean

Update requires: No interruption

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 API operations.

Required: No

Type: Array of String

Update requires: No interruption

CreateDatabaseDefaultPermissions

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

Required: No

Type: Array of PrincipalPermissions

Update requires: No interruption

CreateTableDefaultPermissions

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

Required: No

Type: Array of PrincipalPermissions

Update requires: No interruption

ExternalDataFilteringAllowList

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

Required: No

Type: Array of DataLakePrincipal

Minimum: 0

Maximum: 30

Update requires: No interruption

MutationType

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

Note

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

Required: No

Type: String

Update requires: No interruption

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, 3, and 4.

Required: No

Type: Json

Update requires: No interruption

TrustedResourceOwners

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.

Required: No

Type: Array of String

Update requires: No interruption

Return values

Fn::GetAtt

Examples

Input format for DataLakeSettings with AllowExternalDataFiltering set to false

In this example the value of AllowExternalDataFiltering is set to false. When AllowExternalDataFiltering is set to false, the value for ExternalDataFilteringAllowList property is not applicable. This example does not include CreateDatabaseDefaultPermissions and CreateTableDefaultPermissions properties. Null values for these properties indicate that the permissions are controlled by Lake Formation permissions. When these values are provided, you need to assign ALL permissions to IAM_ALLOWED_PRINCIPALS parameter.

JSON

{
  "Description": "DataLakeSettings_Example1",
  "Resources": {
    "DataLakeSettings": {
      "Type": "AWS::LakeFormation::DataLakeSettings",
      "Properties": {
        "Admins": [
          {
            "DataLakePrincipalIdentifier": "arn:aws:iam::012345678910:role/sample-role1"
          },
          {
            "DataLakePrincipalIdentifier": "arn:aws:iam::012345678910:role/sample-role2"
          }
        ],
        "AllowFullTableExternalDataAccess": false,
        "AllowExternalDataFiltering": false,
        "AuthorizedSessionTagValueList": [
          "sample_val1",
          "sample_val2"
        ],
        "MutationType": "REPLACE",
        "Parameters": {
          "CROSS_ACCOUNT_VERSION": "2"
        },
        "TrustedResourceOwners": [
          "012345678910",
          "109876543210"
        ]
      }
    }
  }
}

YAML

Description: "DataLakeSettings_Example1"
Resources:
  DataLakeSettings:
    Type: "AWS::LakeFormation::DataLakeSettings"
    Properties:
      Admins:
        - DataLakePrincipalIdentifier: "arn:aws:iam::012345678910:role/sample-role1"
        - DataLakePrincipalIdentifier: "arn:aws:iam::012345678910:role/sample-role2"
      AllowFullTableExternalDataAccess: false
      AllowExternalDataFiltering: false
      AuthorizedSessionTagValueList:
        - "sample_val1"
        - "sample_val2"
      MutationType: "REPLACE"
      Parameters:
        "CROSS_ACCOUNT_VERSION": "2"
      TrustedResourceOwners:
        - "012345678910"
        - "109876543210"

Input format for DataLakeSettings with AllowExternalDataFiltering set to true

In this example, the AllowExternalDataFiltering property is set to true, and includes a value for the ExternalDataFilteringAllowList property. Also, in this example, ALL permissions is granted to IAM_ALLOWED_PRINCIPALS. If AllowExternalDataFiltering is set to true, the ExternalDataFilteringAllowList property must include at least one account id.

JSON

{
  "Description": "DataLakeSettings_Example2",
  "Resources": {
    "DataLakeSettings": {
      "Type": "AWS::LakeFormation::DataLakeSettings",
      "Properties": {
        "Admins": [
          {
            "DataLakePrincipalIdentifier": "arn:aws:iam::012345678910:role/sample-role1"
          },
          {
            "DataLakePrincipalIdentifier": "arn:aws:iam::012345678910:role/sample-role2"
          }
        ],
        "AllowFullTableExternalDataAccess": true,
        "AllowExternalDataFiltering": true,
        "AuthorizedSessionTagValueList": [
          "sample_val1",
          "sample_val2"
        ],
        "CreateDatabaseDefaultPermissions": [
          {
            "Principal": {
              "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
            },
            "Permissions": [
              "ALL"
            ]
          }
        ],
        "CreateTableDefaultPermissions": [
          {
            "Principal": {
              "DataLakePrincipalIdentifier": "IAM_ALLOWED_PRINCIPALS"
            },
            "Permissions": [
              "ALL"
            ]
          }
        ],
        "ExternalDataFilteringAllowList": [
          {
            "DataLakePrincipalIdentifier": "333333333333"
          }
        ],
        "MutationType": "APPEND",
        "Parameters": {
          "CROSS_ACCOUNT_VERSION": "3"
        },
        "TrustedResourceOwners": [
          "012345678910",
          "109876543210"
        ]
      }
    }
  }
}

YAML

Description: "DataLakeSettings_Example2"
Resources:
  DataLakeSettings:
    Type: AWS::LakeFormation::DataLakeSettings
    Properties:
      Admins:
        - DataLakePrincipalIdentifier: "arn:aws:iam::012345678910:role/sample-role1"
        - DataLakePrincipalIdentifier: "arn:aws:iam::012345678910:role/sample-role2"

      AllowFullTableExternalDataAccess: true
      AllowExternalDataFiltering: true
      AuthorizedSessionTagValueList:
        - "sample_val1"
        - "sample_val2"
      CreateDatabaseDefaultPermissions:
        - Principal:
            DataLakePrincipalIdentifier: "IAM_ALLOWED_PRINCIPALS"
          Permissions:
            - "ALL"
      CreateTableDefaultPermissions:
        - Principal:
            DataLakePrincipalIdentifier: "IAM_ALLOWED_PRINCIPALS"
          Permissions:
            - "ALL"
      ExternalDataFilteringAllowList:
        - DataLakePrincipalIdentifier: "333333333333"
      MutationType: "APPEND"
      Parameters:
        "CROSS_ACCOUNT_VERSION": "3"
      TrustedResourceOwners:
        - "012345678910"
        - "109876543210"