Class CfnDataCellsFilter
A structure that represents a data cell filter with column-level, row-level, and/or cell-level security.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.LakeFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataCellsFilter : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDataCellsFilter
Inherits CfnResource
Implements IInspectable
Remarks
Data cell filters belong to a specific table in a Data Catalog . During a stack operation, AWS CloudFormation calls the AWS Lake Formation CreateDataCellsFilter
API operation to create a DataCellsFilter
resource, and calls the DeleteDataCellsFilter
API operation to delete it.
CloudformationResource: AWS::LakeFormation::DataCellsFilter
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 allRowsWildcard;
var cfnDataCellsFilter = new CfnDataCellsFilter(this, "MyCfnDataCellsFilter", new CfnDataCellsFilterProps {
DatabaseName = "databaseName",
Name = "name",
TableCatalogId = "tableCatalogId",
TableName = "tableName",
// the properties below are optional
ColumnNames = new [] { "columnNames" },
ColumnWildcard = new ColumnWildcardProperty {
ExcludedColumnNames = new [] { "excludedColumnNames" }
},
RowFilter = new RowFilterProperty {
AllRowsWildcard = allRowsWildcard,
FilterExpression = "filterExpression"
}
});
Synopsis
Constructors
CfnDataCellsFilter(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataCellsFilter(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDataCellsFilter(Construct, String, ICfnDataCellsFilterProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ColumnNames | An array of UTF-8 strings. |
ColumnWildcard | A wildcard with exclusions. |
DatabaseName | UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern . |
Name | UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern . |
RowFilter | A PartiQL predicate. |
TableCatalogId | Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern . |
TableName | UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern . |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataCellsFilter(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataCellsFilter(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataCellsFilter(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataCellsFilter(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDataCellsFilter(Construct, String, ICfnDataCellsFilterProps)
public CfnDataCellsFilter(Construct scope, string id, ICfnDataCellsFilterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDataCellsFilterProps
Resource properties.
Properties
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
ColumnNames
An array of UTF-8 strings.
public virtual string[] ColumnNames { get; set; }
Property Value
System.String[]
ColumnWildcard
A wildcard with exclusions.
public virtual object ColumnWildcard { get; set; }
Property Value
System.Object
DatabaseName
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
public virtual string DatabaseName { get; set; }
Property Value
System.String
Name
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
public virtual string Name { get; set; }
Property Value
System.String
RowFilter
A PartiQL predicate.
public virtual object RowFilter { get; set; }
Property Value
System.Object
TableCatalogId
Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
public virtual string TableCatalogId { get; set; }
Property Value
System.String
TableName
UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .
public virtual string TableName { 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>