Class CfnTagAssociation
A CloudFormation AWS::LakeFormation::TagAssociation
.
Inherited Members
Namespace: Amazon.CDK.AWS.LakeFormation
Assembly: Amazon.CDK.AWS.LakeFormation.dll
Syntax (csharp)
public class CfnTagAssociation : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTagAssociation
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.LakeFormation;
var catalog;
var tableWildcard;
var cfnTagAssociation = new CfnTagAssociation(this, "MyCfnTagAssociation", new CfnTagAssociationProps {
LfTags = new [] { new LFTagPairProperty {
CatalogId = "catalogId",
TagKey = "tagKey",
TagValues = new [] { "tagValues" }
} },
Resource = new ResourceProperty {
Catalog = catalog,
Database = new DatabaseResourceProperty {
CatalogId = "catalogId",
Name = "name"
},
Table = new TableResourceProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
// the properties below are optional
Name = "name",
TableWildcard = tableWildcard
},
TableWithColumns = new TableWithColumnsResourceProperty {
CatalogId = "catalogId",
ColumnNames = new [] { "columnNames" },
DatabaseName = "databaseName",
Name = "name"
}
}
});
Synopsis
Constructors
CfnTagAssociation(Construct, String, ICfnTagAssociationProps) | Create a new |
CfnTagAssociation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTagAssociation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrResourceIdentifier | Json encoding of the input resource. |
AttrTagsIdentifier | Json encoding of the input LFTags list. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
LfTags | A structure containing an LF-tag key-value pair. |
Resource | UTF-8 string (valid values: |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTagAssociation(Construct, String, ICfnTagAssociationProps)
Create a new AWS::LakeFormation::TagAssociation
.
public CfnTagAssociation(Construct scope, string id, ICfnTagAssociationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnTagAssociationProps
- resource properties.
CfnTagAssociation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTagAssociation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTagAssociation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTagAssociation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrResourceIdentifier
Json encoding of the input resource.
public virtual string AttrResourceIdentifier { get; }
Property Value
System.String
Remarks
Examples - Database: {"Catalog":null,"Database":{"CatalogId":"123456789012","Name":"ExampleDbName"},"Table":null,"TableWithColumns":null}
CloudformationAttribute: ResourceIdentifier
AttrTagsIdentifier
Json encoding of the input LFTags list.
public virtual string AttrTagsIdentifier { get; }
Property Value
System.String
Remarks
For example: [{"CatalogId":null,"TagKey":"tagKey1","TagValues":null},{"CatalogId":null,"TagKey":"tagKey2","TagValues":null}]
CloudformationAttribute: TagsIdentifier
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
LfTags
A structure containing an LF-tag key-value pair.
public virtual object LfTags { get; set; }
Property Value
System.Object
Remarks
Resource
UTF-8 string (valid values: DATABASE | TABLE
).
public virtual object Resource { get; set; }
Property Value
System.Object
Remarks
The resource for which the LF-tag policy applies.
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>