Class CfnPermissions
The AWS::LakeFormation::Permissions
resource represents the permissions that a principal has on an AWS Glue Data Catalog resource (such as AWS Glue database or AWS Glue tables).
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.LakeFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPermissions : CfnResource, IInspectable
Syntax (vb)
Public Class CfnPermissions
Inherits CfnResource
Implements IInspectable
Remarks
When you upload a permissions stack, the permissions are granted to the principal and when you remove the stack, the permissions are revoked from the principal. If you remove a stack, and the principal does not have the permissions referenced in the stack then AWS Lake Formation will throw an error because you can’t call revoke on non-existing permissions. To successfully remove the stack, you’ll need to regrant those permissions and then remove the stack.
New versions of AWS Lake Formation permission resources are now available. For more information, see: AWS:LakeFormation::PrincipalPermissions
CloudformationResource: AWS::LakeFormation::Permissions
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 cfnPermissions = new CfnPermissions(this, "MyCfnPermissions", new CfnPermissionsProps {
DataLakePrincipal = new DataLakePrincipalProperty {
DataLakePrincipalIdentifier = "dataLakePrincipalIdentifier"
},
Resource = new ResourceProperty {
DatabaseResource = new DatabaseResourceProperty {
CatalogId = "catalogId",
Name = "name"
},
DataLocationResource = new DataLocationResourceProperty {
CatalogId = "catalogId",
S3Resource = "s3Resource"
},
TableResource = new TableResourceProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
Name = "name",
TableWildcard = new TableWildcardProperty { }
},
TableWithColumnsResource = new TableWithColumnsResourceProperty {
CatalogId = "catalogId",
ColumnNames = new [] { "columnNames" },
ColumnWildcard = new ColumnWildcardProperty {
ExcludedColumnNames = new [] { "excludedColumnNames" }
},
DatabaseName = "databaseName",
Name = "name"
}
},
// the properties below are optional
Permissions = new [] { "permissions" },
PermissionsWithGrantOption = new [] { "permissionsWithGrantOption" }
});
Synopsis
Constructors
CfnPermissions(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPermissions(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPermissions(Construct, String, ICfnPermissionsProps) |
Properties
AttrId | A unique identifier for the batch permissions request entry. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataLakePrincipal | The AWS Lake Formation principal. |
Permissions | The permissions granted or revoked. |
PermissionsWithGrantOption | Indicates the ability to grant permissions (as a subset of permissions granted). |
Resource | A structure for the resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPermissions(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPermissions(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPermissions(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPermissions(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPermissions(Construct, String, ICfnPermissionsProps)
public CfnPermissions(Construct scope, string id, ICfnPermissionsProps 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 ICfnPermissionsProps
Resource properties.
Properties
AttrId
A unique identifier for the batch permissions request entry.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
DataLakePrincipal
The AWS Lake Formation principal.
public virtual object DataLakePrincipal { get; set; }
Property Value
System.Object
Permissions
The permissions granted or revoked.
public virtual string[] Permissions { get; set; }
Property Value
System.String[]
PermissionsWithGrantOption
Indicates the ability to grant permissions (as a subset of permissions granted).
public virtual string[] PermissionsWithGrantOption { get; set; }
Property Value
System.String[]
Resource
A structure for the resource.
public virtual object Resource { get; set; }
Property Value
System.Object
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>