software.amazon.awscdk.services.lakeformation

Class CfnPermissions

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.lakeformation.CfnPermissions

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.355Z")
 @Stability(value=Stable)
public class CfnPermissions
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LakeFormation::Permissions`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lakeformation.*;
 CfnPermissions cfnPermissions = CfnPermissions.Builder.create(this, "MyCfnPermissions")
         .dataLakePrincipal(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                 .build())
         .resource(ResourceProperty.builder()
                 .databaseResource(DatabaseResourceProperty.builder()
                         .catalogId("catalogId")
                         .name("name")
                         .build())
                 .dataLocationResource(DataLocationResourceProperty.builder()
                         .catalogId("catalogId")
                         .s3Resource("s3Resource")
                         .build())
                 .tableResource(TableResourceProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .name("name")
                         .tableWildcard(TableWildcardProperty.builder().build())
                         .build())
                 .tableWithColumnsResource(TableWithColumnsResourceProperty.builder()
                         .catalogId("catalogId")
                         .columnNames(List.of("columnNames"))
                         .columnWildcard(ColumnWildcardProperty.builder()
                                 .excludedColumnNames(List.of("excludedColumnNames"))
                                 .build())
                         .databaseName("databaseName")
                         .name("name")
                         .build())
                 .build())
         // the properties below are optional
         .permissions(List.of("permissions"))
         .permissionsWithGrantOption(List.of("permissionsWithGrantOption"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPermissions.Builder A fluent builder for CfnPermissions.
static interface	CfnPermissions.ColumnWildcardProperty A wildcard object, consisting of an optional list of excluded column names or indexes.
static interface	CfnPermissions.DatabaseResourceProperty A structure for the database object.
static interface	CfnPermissions.DataLakePrincipalProperty The Lake Formation principal.
static interface	CfnPermissions.DataLocationResourceProperty A structure for a data location object where permissions are granted or revoked.
static interface	CfnPermissions.ResourceProperty A structure for the resource.
static interface	CfnPermissions.TableResourceProperty A structure for the table object.
static interface	CfnPermissions.TableWildcardProperty A wildcard object representing every table under a database.
static interface	CfnPermissions.TableWithColumnsResourceProperty A structure for a table with columns object.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPermissions(software.constructs.Construct scope, String id, CfnPermissionsProps props) Create a new `AWS::LakeFormation::Permissions`.
protected	CfnPermissions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPermissions(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDataLakePrincipal() The AWS Lake Formation principal.
List<String>	getPermissions() The permissions granted or revoked.
List<String>	getPermissionsWithGrantOption() Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).
Object	getResource() A structure for the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataLakePrincipal(CfnPermissions.DataLakePrincipalProperty value) The AWS Lake Formation principal.
void	setDataLakePrincipal(IResolvable value) The AWS Lake Formation principal.
void	setPermissions(List<String> value) The permissions granted or revoked.
void	setPermissionsWithGrantOption(List<String> value) Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).
void	setResource(CfnPermissions.ResourceProperty value) A structure for the resource.
void	setResource(IResolvable value) A structure for the resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPermissions

protected CfnPermissions(software.amazon.jsii.JsiiObjectRef objRef)

CfnPermissions

protected CfnPermissions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPermissions

@Stability(value=Stable)
public CfnPermissions(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnPermissionsProps props)

Create a new `AWS::LakeFormation::Permissions`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDataLakePrincipal

@Stability(value=Stable)
 @NotNull
public Object getDataLakePrincipal()

The AWS Lake Formation principal.

setDataLakePrincipal

@Stability(value=Stable)
public void setDataLakePrincipal(@NotNull
                                                          CfnPermissions.DataLakePrincipalProperty value)

The AWS Lake Formation principal.

setDataLakePrincipal

@Stability(value=Stable)
public void setDataLakePrincipal(@NotNull
                                                          IResolvable value)

The AWS Lake Formation principal.

getResource

@Stability(value=Stable)
 @NotNull
public Object getResource()

A structure for the resource.

setResource

@Stability(value=Stable)
public void setResource(@NotNull
                                                 CfnPermissions.ResourceProperty value)

A structure for the resource.

setResource

@Stability(value=Stable)
public void setResource(@NotNull
                                                 IResolvable value)

A structure for the resource.

getPermissions

@Stability(value=Stable)
 @Nullable
public List<String> getPermissions()

The permissions granted or revoked.

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    List<String> value)

The permissions granted or revoked.

getPermissionsWithGrantOption

@Stability(value=Stable)
 @Nullable
public List<String> getPermissionsWithGrantOption()

Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

setPermissionsWithGrantOption

@Stability(value=Stable)
public void setPermissionsWithGrantOption(@Nullable
                                                                   List<String> value)

Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).