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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:11.994Z")
@Stability(Stable)
public class CfnResource
extends CfnResource
implements IInspectable
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnResource
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnResource
(software.amazon.jsii.JsiiObjectRef objRef) CfnResource
(software.constructs.Construct scope, String id, CfnResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionIndicates 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.The Amazon Resource Name (ARN) of the resource.The IAM role that registered a resource.Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .Allows Lake Formation to assume a role to access tables in a federated database.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setHybridAccessEnabled
(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.void
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.void
setResourceArn
(String value) The Amazon Resource Name (ARN) of the resource.void
setRoleArn
(String value) The IAM role that registered a resource.void
setUseServiceLinkedRole
(Boolean value) Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .void
Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .void
setWithFederation
(Boolean value) Allows Lake Formation to assume a role to access tables in a federated database.void
setWithFederation
(IResolvable value) Allows Lake Formation to assume a role to access tables in a federated database.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getResourceArn
The Amazon Resource Name (ARN) of the resource. -
setResourceArn
The Amazon Resource Name (ARN) of the resource. -
getUseServiceLinkedRole
Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog . -
setUseServiceLinkedRole
Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog . -
setUseServiceLinkedRole
Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog . -
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. -
setHybridAccessEnabled
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
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
The IAM role that registered a resource. -
setRoleArn
The IAM role that registered a resource. -
getWithFederation
Allows Lake Formation to assume a role to access tables in a federated database. -
setWithFederation
Allows Lake Formation to assume a role to access tables in a federated database. -
setWithFederation
Allows Lake Formation to assume a role to access tables in a federated database.
-