Class CfnPrincipalPermissions
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).
Inherited Members
Namespace: Amazon.CDK.AWS.LakeFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPrincipalPermissions : CfnResource, IInspectable, IPrincipalPermissionsRef, IConstruct, IDependable, IEnvironmentAwareSyntax (vb)
Public Class CfnPrincipalPermissions Inherits CfnResource Implements IInspectable, IPrincipalPermissionsRef, IConstruct, IDependable, IEnvironmentAwareRemarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
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 cfnPrincipalPermissions = new CfnPrincipalPermissions(this, "MyCfnPrincipalPermissions", new CfnPrincipalPermissionsProps {
Permissions = new [] { "permissions" },
PermissionsWithGrantOption = new [] { "permissionsWithGrantOption" },
Principal = new DataLakePrincipalProperty {
DataLakePrincipalIdentifier = "dataLakePrincipalIdentifier"
},
Resource = new ResourceProperty {
Catalog = catalog,
Database = new DatabaseResourceProperty {
CatalogId = "catalogId",
Name = "name"
},
DataCellsFilter = new DataCellsFilterResourceProperty {
DatabaseName = "databaseName",
Name = "name",
TableCatalogId = "tableCatalogId",
TableName = "tableName"
},
DataLocation = new DataLocationResourceProperty {
CatalogId = "catalogId",
ResourceArn = "resourceArn"
},
LfTag = new LFTagKeyResourceProperty {
CatalogId = "catalogId",
TagKey = "tagKey",
TagValues = new [] { "tagValues" }
},
LfTagPolicy = new LFTagPolicyResourceProperty {
CatalogId = "catalogId",
Expression = new [] { new LFTagProperty {
TagKey = "tagKey",
TagValues = new [] { "tagValues" }
} },
ResourceType = "resourceType"
},
Table = new TableResourceProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
// the properties below are optional
Name = "name",
TableWildcard = tableWildcard
},
TableWithColumns = new TableWithColumnsResourceProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
Name = "name",
// the properties below are optional
ColumnNames = new [] { "columnNames" },
ColumnWildcard = new ColumnWildcardProperty {
ExcludedColumnNames = new [] { "excludedColumnNames" }
}
}
},
// the properties below are optional
Catalog = "catalog"
});Synopsis
Constructors
| CfnPrincipalPermissions(Construct, string, ICfnPrincipalPermissionsProps) | Create a new |
Properties
| AttrPrincipalIdentifier | Json encoding of the input principal. |
| AttrResourceIdentifier | Json encoding of the input resource. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| Catalog | The identifier for the Data Catalog . |
| CfnProperties | The |
| CfnPropertyNames | The |
| Permissions | The permissions granted or revoked. |
| PermissionsWithGrantOption | Indicates the ability to grant permissions (as a subset of permissions granted). |
| Principal | The principal to be granted a permission. |
| PrincipalPermissionsRef | A reference to a PrincipalPermissions resource. |
| Resource | The resource to be granted or revoked permissions. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnPrincipalPermissions(object) | Checks whether the given object is a CfnPrincipalPermissions. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnPrincipalPermissions(Construct, string, ICfnPrincipalPermissionsProps)
Create a new AWS::LakeFormation::PrincipalPermissions.
public CfnPrincipalPermissions(Construct scope, string id, ICfnPrincipalPermissionsProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnPrincipalPermissionsProps
Resource properties.
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
Properties
AttrPrincipalIdentifier
Json encoding of the input principal.
public virtual string AttrPrincipalIdentifier { get; }Property Value
Remarks
For example: {"DataLakePrincipalIdentifier":"arn:aws:iam::123456789012:role/ExampleRole"}
CloudformationAttribute: PrincipalIdentifier
AttrResourceIdentifier
Json encoding of the input resource.
public virtual string AttrResourceIdentifier { get; }Property Value
Remarks
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
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
Catalog
The identifier for the Data Catalog .
public virtual string? Catalog { get; set; }Property Value
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
CfnProperties
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).
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
CfnPropertyNames
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).
protected override IDictionary<string, string> CfnPropertyNames { get; }Property Value
Overrides
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
Permissions
The permissions granted or revoked.
public virtual string[] Permissions { get; set; }Property Value
string[]
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
PermissionsWithGrantOption
Indicates the ability to grant permissions (as a subset of permissions granted).
public virtual string[] PermissionsWithGrantOption { get; set; }Property Value
string[]
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
Principal
The principal to be granted a permission.
public virtual object Principal { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnPrincipalPermissions.IDataLakePrincipalProperty
PrincipalPermissionsRef
A reference to a PrincipalPermissions resource.
public virtual IPrincipalPermissionsReference PrincipalPermissionsRef { get; }Property Value
IPrincipalPermissionsReference
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
Resource
The resource to be granted or revoked permissions.
public virtual object Resource { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnPrincipalPermissions.IResourceProperty
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.
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
IsCfnPrincipalPermissions(object)
Checks whether the given object is a CfnPrincipalPermissions.
public static bool IsCfnPrincipalPermissions(object x)Parameters
- x object
Returns
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
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).
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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.
CloudformationResource: AWS::LakeFormation::PrincipalPermissions
ExampleMetadata: fixture=_generated