Class CfnDataLakeSettings

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnDataLakeSettings
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.LakeFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataLakeSettings : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDataLakeSettings
    Inherits CfnResource
    Implements IInspectable
Remarks

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

CloudformationResource: AWS::LakeFormation::DataLakeSettings

ExampleMetadata: infused

Examples
using Amazon.CDK;
using Amazon.CDK.AWS.Glue.Alpha;
using Amazon.CDK.AWS.LakeFormation;

Stack stack;
string accountId;


var tagKey = "aws";
var tagValues = new [] { "dev" };

var database = new Database(this, "Database");

var table = new S3Table(this, "Table", new S3TableProps {
    Database = database,
    Columns = new [] { new Column {
        Name = "col1",
        Type = Schema.STRING
    }, new Column {
        Name = "col2",
        Type = Schema.STRING
    } },
    DataFormat = DataFormat.CSV
});

var synthesizer = (DefaultStackSynthesizer)stack.Synthesizer;
new CfnDataLakeSettings(this, "DataLakeSettings", new CfnDataLakeSettingsProps {
    Admins = new [] { new DataLakePrincipalProperty {
        DataLakePrincipalIdentifier = stack.FormatArn(new ArnComponents {
            Service = "iam",
            Resource = "role",
            Region = "",
            Account = accountId,
            ResourceName = "Admin"
        })
    }, new DataLakePrincipalProperty {
        // The CDK cloudformation execution role.
        DataLakePrincipalIdentifier = synthesizer.CloudFormationExecutionRoleArn.Replace("${AWS::Partition}", "aws")
    } }
});

var tag = new CfnTag(this, "Tag", new CfnTagProps {
    CatalogId = accountId,
    TagKey = tagKey,
    TagValues = tagValues
});

var lfTagPairProperty = new LFTagPairProperty {
    CatalogId = accountId,
    TagKey = tagKey,
    TagValues = tagValues
};

var tagAssociation = new CfnTagAssociation(this, "TagAssociation", new CfnTagAssociationProps {
    LfTags = new [] { lfTagPairProperty },
    Resource = new ResourceProperty {
        TableWithColumns = new TableWithColumnsResourceProperty {
            DatabaseName = database.DatabaseName,
            ColumnNames = new [] { "col1", "col2" },
            CatalogId = accountId,
            Name = table.TableName
        }
    }
});

tagAssociation.Node.AddDependency(tag);
tagAssociation.Node.AddDependency(table);

Synopsis

Constructors

CfnDataLakeSettings(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDataLakeSettings(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnDataLakeSettings(Construct, String, ICfnDataLakeSettingsProps)

Properties

Admins

A list of AWS Lake Formation principals.
AllowExternalDataFiltering

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

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.
AttrId
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.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
CreateDatabaseDefaultPermissions

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

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

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.
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 ).
Parameters

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

An array of UTF-8 strings.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDataLakeSettings(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDataLakeSettings(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnDataLakeSettings(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDataLakeSettings(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnDataLakeSettings(Construct, String, ICfnDataLakeSettingsProps)

public CfnDataLakeSettings(Construct scope, string id, ICfnDataLakeSettingsProps props = null)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnDataLakeSettingsProps

Resource properties.

Properties

Admins

A list of AWS Lake Formation principals.

public virtual object Admins { get; set; }
Property Value

System.Object

AllowExternalDataFiltering

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

public virtual object AllowExternalDataFiltering { get; set; }
Property Value

System.Object

AllowFullTableExternalDataAccess

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

public virtual object AllowFullTableExternalDataAccess { get; set; }
Property Value

System.Object

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

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.

public virtual string[] AuthorizedSessionTagValueList { get; set; }
Property Value

System.String[]

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CreateDatabaseDefaultPermissions

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

public virtual object CreateDatabaseDefaultPermissions { get; set; }
Property Value

System.Object

CreateTableDefaultPermissions

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

public virtual object CreateTableDefaultPermissions { get; set; }
Property Value

System.Object

ExternalDataFilteringAllowList

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

public virtual object ExternalDataFilteringAllowList { get; set; }
Property Value

System.Object

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

public virtual string MutationType { get; set; }
Property Value

System.String

Parameters

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

public virtual object Parameters { get; set; }
Property Value

System.Object

TrustedResourceOwners

An array of UTF-8 strings.

public virtual string[] TrustedResourceOwners { get; set; }
Property Value

System.String[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements