Package software.amazon.awscdk.services.lakeformation

Interface CfnDataLakeSettingsProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataLakeSettingsProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.393Z") @Stability(Stable) public interface CfnDataLakeSettingsProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnDataLakeSettings.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lakeformation.*;
 Object parameters;
 CfnDataLakeSettingsProps cfnDataLakeSettingsProps = CfnDataLakeSettingsProps.builder()
         .admins(List.of(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                 .build()))
         .allowExternalDataFiltering(false)
         .authorizedSessionTagValueList(List.of("authorizedSessionTagValueList"))
         .createDatabaseDefaultPermissions(List.of(PrincipalPermissionsProperty.builder()
                 .permissions(List.of("permissions"))
                 .principal(DataLakePrincipalProperty.builder()
                         .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                         .build())
                 .build()))
         .createTableDefaultPermissions(List.of(PrincipalPermissionsProperty.builder()
                 .permissions(List.of("permissions"))
                 .principal(DataLakePrincipalProperty.builder()
                         .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                         .build())
                 .build()))
         .externalDataFilteringAllowList(List.of(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                 .build()))
         .parameters(parameters)
         .trustedResourceOwners(List.of("trustedResourceOwners"))
         .build();

  • Method Details

    • getAdmins

      @Stability(Stable) @Nullable default Object getAdmins()
      A list of AWS Lake Formation principals.

    • getAllowExternalDataFiltering

      @Stability(Stable) @Nullable default Object getAllowExternalDataFiltering()
      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 .

    • getAuthorizedSessionTagValueList

      @Stability(Stable) @Nullable default List<String> getAuthorizedSessionTagValueList()
      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.

    • getCreateDatabaseDefaultPermissions

      @Stability(Stable) @Nullable default Object getCreateDatabaseDefaultPermissions()
      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 .

    • getCreateTableDefaultPermissions

      @Stability(Stable) @Nullable default Object getCreateTableDefaultPermissions()
      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 .

    • getExternalDataFilteringAllowList

      @Stability(Stable) @Nullable default Object getExternalDataFilteringAllowList()
      A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

    • getParameters

      @Stability(Stable) @Nullable default Object getParameters()
      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.

    • getTrustedResourceOwners

      @Stability(Stable) @Nullable default List<String> getTrustedResourceOwners()
      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.

    • builder

      @Stability(Stable) static CfnDataLakeSettingsProps.Builder builder()
      Returns:
      a CfnDataLakeSettingsProps.Builder of CfnDataLakeSettingsProps