Package software.amazon.awscdk.services.lakeformation

Class CfnResource

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.CfnResource
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IResourceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:12.579Z") @Stability(Stable) public class CfnResource extends CfnResource implements IInspectable, IResourceRef
The AWS::LakeFormation::Resource represents the data ( buckets and folders) that is being registered with AWS Lake Formation .

During a stack operation, AWS CloudFormation calls the AWS Lake Formation RegisterResource API operation to register the resource. To remove a Resource type, AWS CloudFormation calls the AWS Lake Formation DeregisterResource API operation.

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.*;
 CfnResource cfnResource = CfnResource.Builder.create(this, "MyCfnResource")
         .resourceArn("resourceArn")
         .useServiceLinkedRole(false)
         // the properties below are optional
         .hybridAccessEnabled(false)
         .roleArn("roleArn")
         .withFederation(false)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnResource

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

    • CfnResource

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

    • CfnResource

      @Stability(Stable) public CfnResource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResourceProps props)
      Create a new AWS::LakeFormation::Resource.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnResource

      @Stability(Stable) @NotNull public static Boolean isCfnResource(@NotNull Object x)
      Checks whether the given object is a CfnResource.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      An identifier for the catalog resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getResourceRef

      @Stability(Stable) @NotNull public ResourceReference getResourceRef()
      A reference to a Resource resource.
      Specified by:
      getResourceRef in interface IResourceRef

    • getResourceArn

      @Stability(Stable) @NotNull public String getResourceArn()
      The Amazon Resource Name (ARN) of the resource.

    • setResourceArn

      @Stability(Stable) public void setResourceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the resource.

    • getUseServiceLinkedRole

      @Stability(Stable) @NotNull public Object getUseServiceLinkedRole()
      Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .

      Returns union: either Boolean or IResolvable

    • setUseServiceLinkedRole

      @Stability(Stable) public void setUseServiceLinkedRole(@NotNull Boolean value)
      Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .

    • setUseServiceLinkedRole

      @Stability(Stable) public void setUseServiceLinkedRole(@NotNull IResolvable value)
      Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .

    • getHybridAccessEnabled

      @Stability(Stable) @Nullable public Object getHybridAccessEnabled()
      Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

      Returns union: either Boolean or IResolvable

    • setHybridAccessEnabled

      @Stability(Stable) public void setHybridAccessEnabled(@Nullable Boolean value)
      Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

    • setHybridAccessEnabled

      @Stability(Stable) public void setHybridAccessEnabled(@Nullable IResolvable value)
      Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The IAM role that registered a resource.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The IAM role that registered a resource.

    • getWithFederation

      @Stability(Stable) @Nullable public Object getWithFederation()
      Allows Lake Formation to assume a role to access tables in a federated database.

      Returns union: either Boolean or IResolvable

    • setWithFederation

      @Stability(Stable) public void setWithFederation(@Nullable Boolean value)
      Allows Lake Formation to assume a role to access tables in a federated database.

    • setWithFederation

      @Stability(Stable) public void setWithFederation(@Nullable IResolvable value)
      Allows Lake Formation to assume a role to access tables in a federated database.