AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
aws.lakeformation.getDataLakeSettings
Explore with Pulumi AI
Get Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.lakeformation.getDataLakeSettings({
catalogId: "14916253649",
});
import pulumi
import pulumi_aws as aws
example = aws.lakeformation.get_data_lake_settings(catalog_id="14916253649")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/lakeformation"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := lakeformation.LookupDataLakeSettings(ctx, &lakeformation.LookupDataLakeSettingsArgs{
CatalogId: pulumi.StringRef("14916253649"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.LakeFormation.GetDataLakeSettings.Invoke(new()
{
CatalogId = "14916253649",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.LakeformationFunctions;
import com.pulumi.aws.lakeformation.inputs.GetDataLakeSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = LakeformationFunctions.getDataLakeSettings(GetDataLakeSettingsArgs.builder()
.catalogId("14916253649")
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:lakeformation:getDataLakeSettings
Arguments:
catalogId: '14916253649'
Using getDataLakeSettings
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDataLakeSettings(args: GetDataLakeSettingsArgs, opts?: InvokeOptions): Promise<GetDataLakeSettingsResult>
function getDataLakeSettingsOutput(args: GetDataLakeSettingsOutputArgs, opts?: InvokeOptions): Output<GetDataLakeSettingsResult>
def get_data_lake_settings(catalog_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDataLakeSettingsResult
def get_data_lake_settings_output(catalog_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDataLakeSettingsResult]
func LookupDataLakeSettings(ctx *Context, args *LookupDataLakeSettingsArgs, opts ...InvokeOption) (*LookupDataLakeSettingsResult, error)
func LookupDataLakeSettingsOutput(ctx *Context, args *LookupDataLakeSettingsOutputArgs, opts ...InvokeOption) LookupDataLakeSettingsResultOutput
> Note: This function is named LookupDataLakeSettings
in the Go SDK.
public static class GetDataLakeSettings
{
public static Task<GetDataLakeSettingsResult> InvokeAsync(GetDataLakeSettingsArgs args, InvokeOptions? opts = null)
public static Output<GetDataLakeSettingsResult> Invoke(GetDataLakeSettingsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataLakeSettingsResult> getDataLakeSettings(GetDataLakeSettingsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:lakeformation/getDataLakeSettings:getDataLakeSettings
arguments:
# arguments dictionary
The following arguments are supported:
- Catalog
Id string - Identifier for the Data Catalog. By default, the account ID.
- Catalog
Id string - Identifier for the Data Catalog. By default, the account ID.
- catalog
Id String - Identifier for the Data Catalog. By default, the account ID.
- catalog
Id string - Identifier for the Data Catalog. By default, the account ID.
- catalog_
id str - Identifier for the Data Catalog. By default, the account ID.
- catalog
Id String - Identifier for the Data Catalog. By default, the account ID.
getDataLakeSettings Result
The following output properties are available:
- Admins List<string>
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- Allow
External boolData Filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- Allow
Full boolTable External Data Access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- List<string>
- 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.
- Create
Database List<GetDefault Permissions Data Lake Settings Create Database Default Permission> - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- Create
Table List<GetDefault Permissions Data Lake Settings Create Table Default Permission> - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- External
Data List<string>Filtering Allow Lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters Dictionary<string, string>
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - Read
Only List<string>Admins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- Trusted
Resource List<string>Owners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- Catalog
Id string
- Admins []string
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- Allow
External boolData Filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- Allow
Full boolTable External Data Access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- []string
- 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.
- Create
Database []GetDefault Permissions Data Lake Settings Create Database Default Permission - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- Create
Table []GetDefault Permissions Data Lake Settings Create Table Default Permission - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- External
Data []stringFiltering Allow Lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters map[string]string
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - Read
Only []stringAdmins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- Trusted
Resource []stringOwners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- Catalog
Id string
- admins List<String>
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- allow
External BooleanData Filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- allow
Full BooleanTable External Data Access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- List<String>
- 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.
- create
Database List<GetDefault Permissions Data Lake Settings Create Database Default Permission> - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- create
Table List<GetDefault Permissions Data Lake Settings Create Table Default Permission> - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- external
Data List<String>Filtering Allow Lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters Map<String,String>
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - read
Only List<String>Admins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- trusted
Resource List<String>Owners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- catalog
Id String
- admins string[]
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- allow
External booleanData Filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- allow
Full booleanTable External Data Access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- string[]
- 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.
- create
Database GetDefault Permissions Data Lake Settings Create Database Default Permission[] - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- create
Table GetDefault Permissions Data Lake Settings Create Table Default Permission[] - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- external
Data string[]Filtering Allow Lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- id string
- The provider-assigned unique ID for this managed resource.
- parameters {[key: string]: string}
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - read
Only string[]Admins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- trusted
Resource string[]Owners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- catalog
Id string
- admins Sequence[str]
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- allow_
external_ booldata_ filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- allow_
full_ booltable_ external_ data_ access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- 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.
- create_
database_ Sequence[Getdefault_ permissions Data Lake Settings Create Database Default Permission] - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- create_
table_ Sequence[Getdefault_ permissions Data Lake Settings Create Table Default Permission] - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- external_
data_ Sequence[str]filtering_ allow_ lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- id str
- The provider-assigned unique ID for this managed resource.
- parameters Mapping[str, str]
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - read_
only_ Sequence[str]admins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- trusted_
resource_ Sequence[str]owners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- catalog_
id str
- admins List<String>
- List of ARNs of AWS Lake Formation principals (IAM users or roles).
- allow
External BooleanData Filtering - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
- allow
Full BooleanTable External Data Access - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
- List<String>
- 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.
- create
Database List<Property Map>Default Permissions - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
- create
Table List<Property Map>Default Permissions - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
- external
Data List<String>Filtering Allow Lists - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters Map<String>
- Key-value map of additional configuration.
CROSS_ACCOUNT_VERSION
will be set to values"1"
,"2"
,"3"
, or"4"
.SET_CONTEXT
will also be returned with a value ofTRUE
. In a fresh account, prior to configuring,CROSS_ACCOUNT_VERSION
is"1"
. - read
Only List<String>Admins - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
- trusted
Resource List<String>Owners - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
- catalog
Id String
Supporting Types
GetDataLakeSettingsCreateDatabaseDefaultPermission
- Permissions List<string>
- List of permissions granted to the principal.
- Principal string
- Principal who is granted permissions.
- Permissions []string
- List of permissions granted to the principal.
- Principal string
- Principal who is granted permissions.
- permissions List<String>
- List of permissions granted to the principal.
- principal String
- Principal who is granted permissions.
- permissions string[]
- List of permissions granted to the principal.
- principal string
- Principal who is granted permissions.
- permissions Sequence[str]
- List of permissions granted to the principal.
- principal str
- Principal who is granted permissions.
- permissions List<String>
- List of permissions granted to the principal.
- principal String
- Principal who is granted permissions.
GetDataLakeSettingsCreateTableDefaultPermission
- Permissions List<string>
- List of permissions granted to the principal.
- Principal string
- Principal who is granted permissions.
- Permissions []string
- List of permissions granted to the principal.
- Principal string
- Principal who is granted permissions.
- permissions List<String>
- List of permissions granted to the principal.
- principal String
- Principal who is granted permissions.
- permissions string[]
- List of permissions granted to the principal.
- principal string
- Principal who is granted permissions.
- permissions Sequence[str]
- List of permissions granted to the principal.
- principal str
- Principal who is granted permissions.
- permissions List<String>
- List of permissions granted to the principal.
- principal String
- Principal who is granted permissions.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.