CfnTagAssociationPropsMixin

class aws_cdk.cfn_property_mixins.aws_lakeformation.CfnTagAssociationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::LakeFormation::TagAssociation resource represents an assignment of an LF-tag to a Data Catalog resource (database, table, or column).

During a stack operation, CloudFormation calls AWS Lake Formation AddLFTagsToResource API to create a TagAssociation resource and calls the RemoveLFTagsToResource API to delete it.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html
CloudformationResource:: AWS::LakeFormation::TagAssociation
Mixin:: true
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.cfn_property_mixins import aws_lakeformation as lakeformation
import aws_cdk as cdk

# catalog: Any
# merge_strategy: cdk.IMergeStrategy
# table_wildcard: Any

cfn_tag_association_props_mixin = lakeformation.CfnTagAssociationPropsMixin(lakeformation.CfnTagAssociationMixinProps(
    lf_tags=[lakeformation.CfnTagAssociationPropsMixin.LFTagPairProperty(
        catalog_id="catalogId",
        tag_key="tagKey",
        tag_values=["tagValues"]
    )],
    resource=lakeformation.CfnTagAssociationPropsMixin.ResourceProperty(
        catalog=catalog,
        database=lakeformation.CfnTagAssociationPropsMixin.DatabaseResourceProperty(
            catalog_id="catalogId",
            name="name"
        ),
        table=lakeformation.CfnTagAssociationPropsMixin.TableResourceProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            name="name",
            table_wildcard=table_wildcard
        ),
        table_with_columns=lakeformation.CfnTagAssociationPropsMixin.TableWithColumnsResourceProperty(
            catalog_id="catalogId",
            column_names=["columnNames"],
            database_name="databaseName",
            name="name"
        )
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::LakeFormation::TagAssociation.

Parameters:

props (Union[CfnTagAssociationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['lfTags', 'resource']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

DatabaseResourceProperty

class CfnTagAssociationPropsMixin.DatabaseResourceProperty(*, catalog_id=None, name=None)

Bases: object

A structure for the database object.

Parameters:

catalog_id (Optional[str]) – The identifier for the Data Catalog . By default, it should be the account ID of the caller.
name (Optional[str]) – The name of the database resource. Unique to the Data Catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-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.cfn_property_mixins import aws_lakeformation as lakeformation

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

Attributes

catalog_id

The identifier for the Data Catalog .

By default, it should be the account ID of the caller.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-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-tagassociation-databaseresource.html#cfn-lakeformation-tagassociation-databaseresource-name

LFTagPairProperty

class CfnTagAssociationPropsMixin.LFTagPairProperty(*, catalog_id=None, tag_key=None, tag_values=None)

Bases: object

A structure containing the catalog ID, tag key, and tag values of an LF-tag key-value pair.

Parameters:

catalog_id (Optional[str]) – The identifier for the Data Catalog . By default, it is the account ID of the caller.
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-tagassociation-lftagpair.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.cfn_property_mixins import aws_lakeformation as lakeformation

l_fTag_pair_property = lakeformation.CfnTagAssociationPropsMixin.LFTagPairProperty(
    catalog_id="catalogId",
    tag_key="tagKey",
    tag_values=["tagValues"]
)

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-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-catalogid

tag_key

The key-name for the LF-tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-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-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagvalues

ResourceProperty

class CfnTagAssociationPropsMixin.ResourceProperty(*, catalog=None, database=None, table=None, table_with_columns=None)

Bases: object

A structure for the resource.

Parameters:

catalog (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.
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-tagassociation-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.cfn_property_mixins import aws_lakeformation as lakeformation

# catalog: Any
# table_wildcard: Any

resource_property = lakeformation.CfnTagAssociationPropsMixin.ResourceProperty(
    catalog=catalog,
    database=lakeformation.CfnTagAssociationPropsMixin.DatabaseResourceProperty(
        catalog_id="catalogId",
        name="name"
    ),
    table=lakeformation.CfnTagAssociationPropsMixin.TableResourceProperty(
        catalog_id="catalogId",
        database_name="databaseName",
        name="name",
        table_wildcard=table_wildcard
    ),
    table_with_columns=lakeformation.CfnTagAssociationPropsMixin.TableWithColumnsResourceProperty(
        catalog_id="catalogId",
        column_names=["columnNames"],
        database_name="databaseName",
        name="name"
    )
)

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-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-catalog

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-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-database

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-tagassociation-resource.html#cfn-lakeformation-tagassociation-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-tagassociation-resource.html#cfn-lakeformation-tagassociation-resource-tablewithcolumns

TableResourceProperty

class CfnTagAssociationPropsMixin.TableResourceProperty(*, catalog_id=None, database_name=None, 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 (Optional[str]) – The identifier for the Data Catalog . By default, it is the account ID of the caller.
database_name (Optional[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 (Any) – A wildcard object representing every table under a database.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter. The valid inputs for a property with this type in either yaml or json is null or {}. At least one of TableResource$Name or TableResource$TableWildcard is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-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.cfn_property_mixins import aws_lakeformation as lakeformation

# table_wildcard: Any

table_resource_property = lakeformation.CfnTagAssociationPropsMixin.TableResourceProperty(
    catalog_id="catalogId",
    database_name="databaseName",
    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-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-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-tagassociation-tableresource.html#cfn-lakeformation-tagassociation-tableresource-databasename

name

The name of the table.

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

table_wildcard

A wildcard object representing every table under a database.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter. The valid inputs for a property with this type in either yaml or json is null or {}.

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

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

TableWithColumnsResourceProperty

class CfnTagAssociationPropsMixin.TableWithColumnsResourceProperty(*, catalog_id=None, column_names=None, database_name=None, name=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 (Optional[str]) – A wildcard object representing every table under a database. At least one of TableResource$Name or TableResource$TableWildcard is required.
column_names (Optional[Sequence[str]]) – The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
database_name (Optional[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 (Optional[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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-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.cfn_property_mixins import aws_lakeformation as lakeformation

table_with_columns_resource_property = lakeformation.CfnTagAssociationPropsMixin.TableWithColumnsResourceProperty(
    catalog_id="catalogId",
    column_names=["columnNames"],
    database_name="databaseName",
    name="name"
)

Attributes

catalog_id

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-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-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-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-columnnames

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-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-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-tagassociation-tablewithcolumnsresource.html#cfn-lakeformation-tagassociation-tablewithcolumnsresource-name