CfnTagAssociation

class aws_cdk.aws_lakeformation.CfnTagAssociation(scope, id, *, lf_tags, resource)

Bases: CfnResource

A CloudFormation AWS::LakeFormation::TagAssociation.

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.

CloudformationResource:

AWS::LakeFormation::TagAssociation

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

# catalog: Any
# table_wildcard: Any

cfn_tag_association = lakeformation.CfnTagAssociation(self, "MyCfnTagAssociation",
    lf_tags=[lakeformation.CfnTagAssociation.LFTagPairProperty(
        catalog_id="catalogId",
        tag_key="tagKey",
        tag_values=["tagValues"]
    )],
    resource=lakeformation.CfnTagAssociation.ResourceProperty(
        catalog=catalog,
        database=lakeformation.CfnTagAssociation.DatabaseResourceProperty(
            catalog_id="catalogId",
            name="name"
        ),
        table=lakeformation.CfnTagAssociation.TableResourceProperty(
            catalog_id="catalogId",
            database_name="databaseName",

            # the properties below are optional
            name="name",
            table_wildcard=table_wildcard
        ),
        table_with_columns=lakeformation.CfnTagAssociation.TableWithColumnsResourceProperty(
            catalog_id="catalogId",
            column_names=["columnNames"],
            database_name="databaseName",
            name="name"
        )
    )
)

Create a new AWS::LakeFormation::TagAssociation.

Parameters:
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • lf_tags (Union[IResolvable, Sequence[Union[IResolvable, LFTagPairProperty, Dict[str, Any]]]]) – A structure containing an LF-tag key-value pair.

  • resource (Union[IResolvable, ResourceProperty, Dict[str, Any]]) – UTF-8 string (valid values: DATABASE | TABLE ). The resource for which the LF-tag policy applies.

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_depends_on(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_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 intermdediate 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).

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 resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

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.

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

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

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::TagAssociation'
attr_resource_identifier

Json encoding of the input resource.

Examples - Database: {"Catalog":null,"Database":{"CatalogId":"123456789012","Name":"ExampleDbName"},"Table":null,"TableWithColumns":null}

  • Table: {"Catalog":null,"Database":null,"Table":{"CatalogId":"123456789012","DatabaseName":"ExampleDbName","Name":"ExampleTableName","TableWildcard":null},"TableWithColumns":null}

  • Columns: {"Catalog":null,"Database":null,"Table":null,"TableWithColumns":{"CatalogId":"123456789012","DatabaseName":"ExampleDbName","Name":"ExampleTableName","ColumnNames":["ExampleColName1","ExampleColName2"]}}

CloudformationAttribute:

ResourceIdentifier

attr_tags_identifier

Json encoding of the input LFTags list.

For example: [{"CatalogId":null,"TagKey":"tagKey1","TagValues":null},{"CatalogId":null,"TagKey":"tagKey2","TagValues":null}]

CloudformationAttribute:

TagsIdentifier

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.

lf_tags

A structure containing an LF-tag key-value pair.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lakeformation-tagassociation.html#cfn-lakeformation-tagassociation-lftags

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 construct tree node associated with this construct.

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

DATABASE | TABLE ).

The resource for which the LF-tag policy applies.

Link:

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

Type:

UTF-8 string (valid values

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(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

DatabaseResourceProperty

class CfnTagAssociation.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 should be the account ID of the caller.

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

Link:

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.
import aws_cdk.aws_lakeformation as lakeformation

database_resource_property = lakeformation.CfnTagAssociation.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.

Link:

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.

Link:

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

LFTagPairProperty

class CfnTagAssociation.LFTagPairProperty(*, catalog_id, tag_key, tag_values)

Bases: object

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

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

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

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

Link:

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.
import aws_cdk.aws_lakeformation as lakeformation

l_fTag_pair_property = lakeformation.CfnTagAssociation.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.

Link:

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.

Link:

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.

Link:

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

ResourceProperty

class CfnTagAssociation.ResourceProperty(*, catalog=None, database=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.

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

Link:

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.
import aws_cdk.aws_lakeformation as lakeformation

# catalog: Any
# table_wildcard: Any

resource_property = lakeformation.CfnTagAssociation.ResourceProperty(
    catalog=catalog,
    database=lakeformation.CfnTagAssociation.DatabaseResourceProperty(
        catalog_id="catalogId",
        name="name"
    ),
    table=lakeformation.CfnTagAssociation.TableResourceProperty(
        catalog_id="catalogId",
        database_name="databaseName",

        # the properties below are optional
        name="name",
        table_wildcard=table_wildcard
    ),
    table_with_columns=lakeformation.CfnTagAssociation.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.

Link:

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.

Link:

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.

Link:

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.

Link:

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

TableResourceProperty

class CfnTagAssociation.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.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.

Link:

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.
import aws_cdk.aws_lakeformation as lakeformation

# table_wildcard: Any

table_resource_property = lakeformation.CfnTagAssociation.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.

Link:

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.

Link:

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.

Link:

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.

Link:

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

TableWithColumnsResourceProperty

class CfnTagAssociation.TableWithColumnsResourceProperty(*, catalog_id, column_names, database_name, name)

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) – A wildcard object representing every table under a database. At least one of TableResource$Name or TableResource$TableWildcard is required.

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

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

Link:

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.
import aws_cdk.aws_lakeformation as lakeformation

table_with_columns_resource_property = lakeformation.CfnTagAssociation.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.

Link:

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.

Link:

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.

Link:

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.

Link:

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