software.amazon.awscdk.services.lakeformation

Class CfnPrincipalPermissions

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

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.358Z")
 @Stability(value=Stable)
public class CfnPrincipalPermissions
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LakeFormation::PrincipalPermissions`.

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.*;
 Object catalog;
 Object tableWildcard;
 CfnPrincipalPermissions cfnPrincipalPermissions = CfnPrincipalPermissions.Builder.create(this, "MyCfnPrincipalPermissions")
         .permissions(List.of("permissions"))
         .permissionsWithGrantOption(List.of("permissionsWithGrantOption"))
         .principal(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                 .build())
         .resource(ResourceProperty.builder()
                 .catalog(catalog)
                 .database(DatabaseResourceProperty.builder()
                         .catalogId("catalogId")
                         .name("name")
                         .build())
                 .dataCellsFilter(DataCellsFilterResourceProperty.builder()
                         .databaseName("databaseName")
                         .name("name")
                         .tableCatalogId("tableCatalogId")
                         .tableName("tableName")
                         .build())
                 .dataLocation(DataLocationResourceProperty.builder()
                         .catalogId("catalogId")
                         .resourceArn("resourceArn")
                         .build())
                 .lfTag(LFTagKeyResourceProperty.builder()
                         .catalogId("catalogId")
                         .tagKey("tagKey")
                         .tagValues(List.of("tagValues"))
                         .build())
                 .lfTagPolicy(LFTagPolicyResourceProperty.builder()
                         .catalogId("catalogId")
                         .expression(List.of(LFTagProperty.builder()
                                 .tagKey("tagKey")
                                 .tagValues(List.of("tagValues"))
                                 .build()))
                         .resourceType("resourceType")
                         .build())
                 .table(TableResourceProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         // the properties below are optional
                         .name("name")
                         .tableWildcard(tableWildcard)
                         .build())
                 .tableWithColumns(TableWithColumnsResourceProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .name("name")
                         // the properties below are optional
                         .columnNames(List.of("columnNames"))
                         .columnWildcard(ColumnWildcardProperty.builder()
                                 .excludedColumnNames(List.of("excludedColumnNames"))
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .catalog("catalog")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPrincipalPermissions.Builder A fluent builder for CfnPrincipalPermissions.
static interface	CfnPrincipalPermissions.ColumnWildcardProperty Example:
static interface	CfnPrincipalPermissions.DatabaseResourceProperty Example:
static interface	CfnPrincipalPermissions.DataCellsFilterResourceProperty Example:
static interface	CfnPrincipalPermissions.DataLakePrincipalProperty Example:
static interface	CfnPrincipalPermissions.DataLocationResourceProperty Example:
static interface	CfnPrincipalPermissions.LFTagKeyResourceProperty Example:
static interface	CfnPrincipalPermissions.LFTagPolicyResourceProperty Example:
static interface	CfnPrincipalPermissions.LFTagProperty Example:
static interface	CfnPrincipalPermissions.ResourceProperty Example:
static interface	CfnPrincipalPermissions.TableResourceProperty Example:
static interface	CfnPrincipalPermissions.TableWithColumnsResourceProperty Example:

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
	CfnPrincipalPermissions(software.constructs.Construct scope, String id, CfnPrincipalPermissionsProps props) Create a new `AWS::LakeFormation::PrincipalPermissions`.
protected	CfnPrincipalPermissions(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrincipalPermissions(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrPrincipalIdentifier()
String	getAttrResourceIdentifier()
String	getCatalog() `AWS::LakeFormation::PrincipalPermissions.Catalog`.
protected Map<String,Object>	getCfnProperties()
List<String>	getPermissions() `AWS::LakeFormation::PrincipalPermissions.Permissions`.
List<String>	getPermissionsWithGrantOption() `AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`.
Object	getPrincipal() `AWS::LakeFormation::PrincipalPermissions.Principal`.
Object	getResource() `AWS::LakeFormation::PrincipalPermissions.Resource`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCatalog(String value) `AWS::LakeFormation::PrincipalPermissions.Catalog`.
void	setPermissions(List<String> value) `AWS::LakeFormation::PrincipalPermissions.Permissions`.
void	setPermissionsWithGrantOption(List<String> value) `AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`.
void	setPrincipal(CfnPrincipalPermissions.DataLakePrincipalProperty value) `AWS::LakeFormation::PrincipalPermissions.Principal`.
void	setPrincipal(IResolvable value) `AWS::LakeFormation::PrincipalPermissions.Principal`.
void	setResource(CfnPrincipalPermissions.ResourceProperty value) `AWS::LakeFormation::PrincipalPermissions.Resource`.
void	setResource(IResolvable value) `AWS::LakeFormation::PrincipalPermissions.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

CfnPrincipalPermissions

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

CfnPrincipalPermissions

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

CfnPrincipalPermissions

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

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

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.

getAttrPrincipalIdentifier

@Stability(value=Stable)
 @NotNull
public String getAttrPrincipalIdentifier()

getAttrResourceIdentifier

@Stability(value=Stable)
 @NotNull
public String getAttrResourceIdentifier()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getPermissions

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

`AWS::LakeFormation::PrincipalPermissions.Permissions`.

setPermissions

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

`AWS::LakeFormation::PrincipalPermissions.Permissions`.

getPermissionsWithGrantOption

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

`AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`.

setPermissionsWithGrantOption

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

`AWS::LakeFormation::PrincipalPermissions.PermissionsWithGrantOption`.

getPrincipal

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

`AWS::LakeFormation::PrincipalPermissions.Principal`.

setPrincipal

@Stability(value=Stable)
public void setPrincipal(@NotNull
                                                  CfnPrincipalPermissions.DataLakePrincipalProperty value)

`AWS::LakeFormation::PrincipalPermissions.Principal`.

setPrincipal

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

`AWS::LakeFormation::PrincipalPermissions.Principal`.

getResource

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

`AWS::LakeFormation::PrincipalPermissions.Resource`.

setResource

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

`AWS::LakeFormation::PrincipalPermissions.Resource`.

setResource

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

`AWS::LakeFormation::PrincipalPermissions.Resource`.

getCatalog

@Stability(value=Stable)
 @Nullable
public String getCatalog()

`AWS::LakeFormation::PrincipalPermissions.Catalog`.

setCatalog

@Stability(value=Stable)
public void setCatalog(@Nullable
                                                String value)

`AWS::LakeFormation::PrincipalPermissions.Catalog`.