CfnPrincipalPermissions

class aws_cdk.aws_lakeformation.CfnPrincipalPermissions(scope, id, *, permissions, permissions_with_grant_option, principal, resource, catalog=None)

Bases: CfnResource

The AWS::LakeFormation::PrincipalPermissions resource represents the permissions that a principal has on a Data Catalog resource (such as AWS Glue databases or AWS Glue tables).

When you create a PrincipalPermissions resource, the permissions are granted via the AWS Lake Formation GrantPermissions API operation. When you delete a PrincipalPermissions resource, the permissions on principal-resource pair are revoked via the AWS Lake Formation RevokePermissions API operation.

See:

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

CloudformationResource:

AWS::LakeFormation::PrincipalPermissions

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

# catalog: Any
# table_wildcard: Any

cfn_principal_permissions = lakeformation.CfnPrincipalPermissions(self, "MyCfnPrincipalPermissions",
    permissions=["permissions"],
    permissions_with_grant_option=["permissionsWithGrantOption"],
    principal=lakeformation.CfnPrincipalPermissions.DataLakePrincipalProperty(
        data_lake_principal_identifier="dataLakePrincipalIdentifier"
    ),
    resource=lakeformation.CfnPrincipalPermissions.ResourceProperty(
        catalog=catalog,
        database=lakeformation.CfnPrincipalPermissions.DatabaseResourceProperty(
            catalog_id="catalogId",
            name="name"
        ),
        data_cells_filter=lakeformation.CfnPrincipalPermissions.DataCellsFilterResourceProperty(
            database_name="databaseName",
            name="name",
            table_catalog_id="tableCatalogId",
            table_name="tableName"
        ),
        data_location=lakeformation.CfnPrincipalPermissions.DataLocationResourceProperty(
            catalog_id="catalogId",
            resource_arn="resourceArn"
        ),
        lf_tag=lakeformation.CfnPrincipalPermissions.LFTagKeyResourceProperty(
            catalog_id="catalogId",
            tag_key="tagKey",
            tag_values=["tagValues"]
        ),
        lf_tag_policy=lakeformation.CfnPrincipalPermissions.LFTagPolicyResourceProperty(
            catalog_id="catalogId",
            expression=[lakeformation.CfnPrincipalPermissions.LFTagProperty(
                tag_key="tagKey",
                tag_values=["tagValues"]
            )],
            resource_type="resourceType"
        ),
        table=lakeformation.CfnPrincipalPermissions.TableResourceProperty(
            catalog_id="catalogId",
            database_name="databaseName",

            # the properties below are optional
            name="name",
            table_wildcard=table_wildcard
        ),
        table_with_columns=lakeformation.CfnPrincipalPermissions.TableWithColumnsResourceProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            name="name",

            # the properties below are optional
            column_names=["columnNames"],
            column_wildcard=lakeformation.CfnPrincipalPermissions.ColumnWildcardProperty(
                excluded_column_names=["excludedColumnNames"]
            )
        )
    ),

    # the properties below are optional
    catalog="catalog"
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • permissions (Sequence[str]) – The permissions granted or revoked.

  • permissions_with_grant_option (Sequence[str]) – Indicates the ability to grant permissions (as a subset of permissions granted).

  • principal (Union[IResolvable, DataLakePrincipalProperty, Dict[str, Any]]) – The principal to be granted a permission.

  • resource (Union[IResolvable, ResourceProperty, Dict[str, Any]]) – The resource to be granted or revoked permissions.

  • catalog (Optional[str]) – The identifier for the Data Catalog . By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::LakeFormation::PrincipalPermissions'
attr_principal_identifier

Json encoding of the input principal.

For example: {"DataLakePrincipalIdentifier":"arn:aws:iam::123456789012:role/ExampleRole"}

CloudformationAttribute:

PrincipalIdentifier

attr_resource_identifier

Json encoding of the input resource.

For example: {"Catalog":null,"Database":null,"Table":null,"TableWithColumns":null,"DataLocation":null,"DataCellsFilter":{"TableCatalogId":"123456789012","DatabaseName":"ExampleDatabase","TableName":"ExampleTable","Name":"ExampleFilter"},"LFTag":null,"LFTagPolicy":null}

CloudformationAttribute:

ResourceIdentifier

catalog

The identifier for the Data Catalog .

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

permissions

The permissions granted or revoked.

permissions_with_grant_option

Indicates the ability to grant permissions (as a subset of permissions granted).

principal

The principal to be granted a permission.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

resource

The resource to be granted or revoked permissions.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ColumnWildcardProperty

class CfnPrincipalPermissions.ColumnWildcardProperty(*, excluded_column_names=None)

Bases: object

A wildcard object, consisting of an optional list of excluded column names or indexes.

Parameters:

excluded_column_names (Optional[Sequence[str]]) – Excludes column names. Any column with this name will be excluded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

column_wildcard_property = lakeformation.CfnPrincipalPermissions.ColumnWildcardProperty(
    excluded_column_names=["excludedColumnNames"]
)

Attributes

excluded_column_names

Excludes column names.

Any column with this name will be excluded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html#cfn-lakeformation-principalpermissions-columnwildcard-excludedcolumnnames

DataCellsFilterResourceProperty

class CfnPrincipalPermissions.DataCellsFilterResourceProperty(*, database_name, name, table_catalog_id, table_name)

Bases: object

A structure that describes certain columns on certain rows.

Parameters:
  • database_name (str) – A database in the Data Catalog .

  • name (str) – The name given by the user to the data filter cell.

  • table_catalog_id (str) – The ID of the catalog to which the table belongs.

  • table_name (str) – The name of the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

data_cells_filter_resource_property = lakeformation.CfnPrincipalPermissions.DataCellsFilterResourceProperty(
    database_name="databaseName",
    name="name",
    table_catalog_id="tableCatalogId",
    table_name="tableName"
)

Attributes

database_name

A database in the Data Catalog .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-databasename

name

The name given by the user to the data filter cell.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-name

table_catalog_id

The ID of the catalog to which the table belongs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablecatalogid

table_name

The name of the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html#cfn-lakeformation-principalpermissions-datacellsfilterresource-tablename

DataLakePrincipalProperty

class CfnPrincipalPermissions.DataLakePrincipalProperty(*, data_lake_principal_identifier=None)

Bases: object

The AWS Lake Formation principal.

Parameters:

data_lake_principal_identifier (Optional[str]) – An identifier for the AWS Lake Formation principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

data_lake_principal_property = lakeformation.CfnPrincipalPermissions.DataLakePrincipalProperty(
    data_lake_principal_identifier="dataLakePrincipalIdentifier"
)

Attributes

data_lake_principal_identifier

An identifier for the AWS Lake Formation principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html#cfn-lakeformation-principalpermissions-datalakeprincipal-datalakeprincipalidentifier

DataLocationResourceProperty

class CfnPrincipalPermissions.DataLocationResourceProperty(*, catalog_id, resource_arn)

Bases: object

A structure for a data location object where permissions are granted or revoked.

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog where the location is registered with AWS Lake Formation .

  • resource_arn (str) – The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

data_location_resource_property = lakeformation.CfnPrincipalPermissions.DataLocationResourceProperty(
    catalog_id="catalogId",
    resource_arn="resourceArn"
)

Attributes

catalog_id

The identifier for the Data Catalog where the location is registered with AWS Lake Formation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-catalogid

resource_arn

The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html#cfn-lakeformation-principalpermissions-datalocationresource-resourcearn

DatabaseResourceProperty

class CfnPrincipalPermissions.DatabaseResourceProperty(*, catalog_id, name)

Bases: object

A structure for the database object.

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog. By default, it is the account ID of the caller.

  • name (str) – The name of the database resource. Unique to the Data Catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

database_resource_property = lakeformation.CfnPrincipalPermissions.DatabaseResourceProperty(
    catalog_id="catalogId",
    name="name"
)

Attributes

catalog_id

The identifier for the Data Catalog.

By default, it is the account ID of the caller.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-catalogid

name

The name of the database resource.

Unique to the Data Catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html#cfn-lakeformation-principalpermissions-databaseresource-name

LFTagKeyResourceProperty

class CfnPrincipalPermissions.LFTagKeyResourceProperty(*, catalog_id, tag_key, tag_values)

Bases: object

A structure containing an LF-tag key and values for a resource.

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog where the location is registered with Data Catalog .

  • tag_key (str) – The key-name for the LF-tag.

  • tag_values (Sequence[str]) – A list of possible values for the corresponding TagKey of an LF-tag key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

l_fTag_key_resource_property = lakeformation.CfnPrincipalPermissions.LFTagKeyResourceProperty(
    catalog_id="catalogId",
    tag_key="tagKey",
    tag_values=["tagValues"]
)

Attributes

catalog_id

The identifier for the Data Catalog where the location is registered with Data Catalog .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-catalogid

tag_key

The key-name for the LF-tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagkey

tag_values

A list of possible values for the corresponding TagKey of an LF-tag key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html#cfn-lakeformation-principalpermissions-lftagkeyresource-tagvalues

LFTagPolicyResourceProperty

class CfnPrincipalPermissions.LFTagPolicyResourceProperty(*, catalog_id, expression, resource_type)

Bases: object

A list of LF-tag conditions that define a resource’s LF-tag policy.

A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag ‘PII’ in tables that have the LF-tag ‘Prod’.

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog . The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

  • expression (Union[IResolvable, Sequence[Union[IResolvable, LFTagProperty, Dict[str, Any]]]]) – A list of LF-tag conditions that apply to the resource’s LF-tag policy.

  • resource_type (str) – The resource type for which the LF-tag policy applies.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

l_fTag_policy_resource_property = lakeformation.CfnPrincipalPermissions.LFTagPolicyResourceProperty(
    catalog_id="catalogId",
    expression=[lakeformation.CfnPrincipalPermissions.LFTagProperty(
        tag_key="tagKey",
        tag_values=["tagValues"]
    )],
    resource_type="resourceType"
)

Attributes

catalog_id

The identifier for the Data Catalog .

The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-catalogid

expression

A list of LF-tag conditions that apply to the resource’s LF-tag policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-expression

resource_type

The resource type for which the LF-tag policy applies.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html#cfn-lakeformation-principalpermissions-lftagpolicyresource-resourcetype

LFTagProperty

class CfnPrincipalPermissions.LFTagProperty(*, tag_key=None, tag_values=None)

Bases: object

The LF-tag key and values attached to a resource.

Parameters:
  • tag_key (Optional[str]) – The key-name for the LF-tag.

  • tag_values (Optional[Sequence[str]]) – A list of possible values of the corresponding TagKey of an LF-tag key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

l_fTag_property = lakeformation.CfnPrincipalPermissions.LFTagProperty(
    tag_key="tagKey",
    tag_values=["tagValues"]
)

Attributes

tag_key

The key-name for the LF-tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagkey

tag_values

A list of possible values of the corresponding TagKey of an LF-tag key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html#cfn-lakeformation-principalpermissions-lftag-tagvalues

ResourceProperty

class CfnPrincipalPermissions.ResourceProperty(*, catalog=None, database=None, data_cells_filter=None, data_location=None, lf_tag=None, lf_tag_policy=None, table=None, table_with_columns=None)

Bases: object

A structure for the resource.

Parameters:
  • catalog (Optional[Any]) – The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

  • database (Union[IResolvable, DatabaseResourceProperty, Dict[str, Any], None]) – The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.

  • data_cells_filter (Union[IResolvable, DataCellsFilterResourceProperty, Dict[str, Any], None]) – A data cell filter.

  • data_location (Union[IResolvable, DataLocationResourceProperty, Dict[str, Any], None]) – The location of an Amazon S3 path where permissions are granted or revoked.

  • lf_tag (Union[IResolvable, LFTagKeyResourceProperty, Dict[str, Any], None]) – The LF-tag key and values attached to a resource.

  • lf_tag_policy (Union[IResolvable, LFTagPolicyResourceProperty, Dict[str, Any], None]) – A list of LF-tag conditions that define a resource’s LF-tag policy.

  • table (Union[IResolvable, TableResourceProperty, Dict[str, Any], None]) – The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

  • table_with_columns (Union[IResolvable, TableWithColumnsResourceProperty, Dict[str, Any], None]) – The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

# catalog: Any
# table_wildcard: Any

resource_property = lakeformation.CfnPrincipalPermissions.ResourceProperty(
    catalog=catalog,
    database=lakeformation.CfnPrincipalPermissions.DatabaseResourceProperty(
        catalog_id="catalogId",
        name="name"
    ),
    data_cells_filter=lakeformation.CfnPrincipalPermissions.DataCellsFilterResourceProperty(
        database_name="databaseName",
        name="name",
        table_catalog_id="tableCatalogId",
        table_name="tableName"
    ),
    data_location=lakeformation.CfnPrincipalPermissions.DataLocationResourceProperty(
        catalog_id="catalogId",
        resource_arn="resourceArn"
    ),
    lf_tag=lakeformation.CfnPrincipalPermissions.LFTagKeyResourceProperty(
        catalog_id="catalogId",
        tag_key="tagKey",
        tag_values=["tagValues"]
    ),
    lf_tag_policy=lakeformation.CfnPrincipalPermissions.LFTagPolicyResourceProperty(
        catalog_id="catalogId",
        expression=[lakeformation.CfnPrincipalPermissions.LFTagProperty(
            tag_key="tagKey",
            tag_values=["tagValues"]
        )],
        resource_type="resourceType"
    ),
    table=lakeformation.CfnPrincipalPermissions.TableResourceProperty(
        catalog_id="catalogId",
        database_name="databaseName",

        # the properties below are optional
        name="name",
        table_wildcard=table_wildcard
    ),
    table_with_columns=lakeformation.CfnPrincipalPermissions.TableWithColumnsResourceProperty(
        catalog_id="catalogId",
        database_name="databaseName",
        name="name",

        # the properties below are optional
        column_names=["columnNames"],
        column_wildcard=lakeformation.CfnPrincipalPermissions.ColumnWildcardProperty(
            excluded_column_names=["excludedColumnNames"]
        )
    )
)

Attributes

catalog

The identifier for the Data Catalog.

By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-catalog

data_cells_filter

A data cell filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datacellsfilter

data_location

The location of an Amazon S3 path where permissions are granted or revoked.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-datalocation

database

The database for the resource.

Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-database

lf_tag

The LF-tag key and values attached to a resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftag

lf_tag_policy

A list of LF-tag conditions that define a resource’s LF-tag policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-lftagpolicy

table

The table for the resource.

A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-table

table_with_columns

The table with columns for the resource.

A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html#cfn-lakeformation-principalpermissions-resource-tablewithcolumns

TableResourceProperty

class CfnPrincipalPermissions.TableResourceProperty(*, catalog_id, database_name, name=None, table_wildcard=None)

Bases: object

A structure for the table object.

A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog. By default, it is the account ID of the caller.

  • database_name (str) – The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

  • name (Optional[str]) – The name of the table.

  • table_wildcard (Optional[Any]) – A wildcard object representing every table under a database. At least one of TableResource$Name or TableResource$TableWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

# table_wildcard: Any

table_resource_property = lakeformation.CfnPrincipalPermissions.TableResourceProperty(
    catalog_id="catalogId",
    database_name="databaseName",

    # the properties below are optional
    name="name",
    table_wildcard=table_wildcard
)

Attributes

catalog_id

The identifier for the Data Catalog.

By default, it is the account ID of the caller.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-catalogid

database_name

The name of the database for the table.

Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-databasename

name

The name of the table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-name

table_wildcard

A wildcard object representing every table under a database.

At least one of TableResource$Name or TableResource$TableWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html#cfn-lakeformation-principalpermissions-tableresource-tablewildcard

TableWithColumnsResourceProperty

class CfnPrincipalPermissions.TableWithColumnsResourceProperty(*, catalog_id, database_name, name, column_names=None, column_wildcard=None)

Bases: object

A structure for a table with columns object. This object is only used when granting a SELECT permission.

This object must take a value for at least one of ColumnsNames , ColumnsIndexes , or ColumnsWildcard .

Parameters:
  • catalog_id (str) – The identifier for the Data Catalog where the location is registered with AWS Lake Formation .

  • database_name (str) – The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

  • name (str) – The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

  • column_names (Optional[Sequence[str]]) – The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

  • column_wildcard (Union[IResolvable, ColumnWildcardProperty, Dict[str, Any], None]) – A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lakeformation as lakeformation

table_with_columns_resource_property = lakeformation.CfnPrincipalPermissions.TableWithColumnsResourceProperty(
    catalog_id="catalogId",
    database_name="databaseName",
    name="name",

    # the properties below are optional
    column_names=["columnNames"],
    column_wildcard=lakeformation.CfnPrincipalPermissions.ColumnWildcardProperty(
        excluded_column_names=["excludedColumnNames"]
    )
)

Attributes

catalog_id

The identifier for the Data Catalog where the location is registered with AWS Lake Formation .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-catalogid

column_names

The list of column names for the table.

At least one of ColumnNames or ColumnWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnnames

column_wildcard

A wildcard specified by a ColumnWildcard object.

At least one of ColumnNames or ColumnWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-columnwildcard

database_name

The name of the database for the table with columns resource.

Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-databasename

name

The name of the table resource.

A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html#cfn-lakeformation-principalpermissions-tablewithcolumnsresource-name