Class: AWSCDK::LakeFormation::CfnResourceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lake_formation/cfn_resource_props.rb

Overview

Properties for defining a CfnResource.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource_arn:, use_service_linked_role:, hybrid_access_enabled: nil, role_arn: nil, with_federation: nil) ⇒ CfnResourceProps

Returns a new instance of CfnResourceProps.

Parameters:

  • resource_arn (String) —

    The Amazon Resource Name (ARN) of the resource.

  • use_service_linked_role (Boolean, AWSCDK::IResolvable) —

    Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .

  • hybrid_access_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    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.

  • role_arn (String, nil) (defaults to: nil) —

    The IAM role that registered a resource.

  • with_federation (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Allows Lake Formation to assume a role to access tables in a federated database.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lake_formation/cfn_resource_props.rb', line 14

def initialize(resource_arn:, use_service_linked_role:, hybrid_access_enabled: nil, role_arn: nil, with_federation: nil)
  @resource_arn = resource_arn
  Jsii::Type.check_type(@resource_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceArn")
  @use_service_linked_role = use_service_linked_role
  Jsii::Type.check_type(@use_service_linked_role, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useServiceLinkedRole")
  @hybrid_access_enabled = hybrid_access_enabled
  Jsii::Type.check_type(@hybrid_access_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "hybridAccessEnabled") unless @hybrid_access_enabled.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @with_federation = with_federation
  Jsii::Type.check_type(@with_federation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "withFederation") unless @with_federation.nil?
end

Instance Attribute Details

#hybrid_access_enabled ⇒ Boolean, ... (readonly)

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:

See Also:



41
42
43
 
# File 'lake_formation/cfn_resource_props.rb', line 41

def hybrid_access_enabled
  @hybrid_access_enabled
end

#resource_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the resource.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'lake_formation/cfn_resource_props.rb', line 31

def resource_arn
  @resource_arn
end

#role_arn ⇒ String? (readonly)

The IAM role that registered a resource.

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'lake_formation/cfn_resource_props.rb', line 46

def role_arn
  @role_arn
end

#use_service_linked_role ⇒ Boolean, AWSCDK::IResolvable (readonly)

Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog .

Returns:

See Also:



36
37
38
 
# File 'lake_formation/cfn_resource_props.rb', line 36

def use_service_linked_role
  @use_service_linked_role
end

#with_federation ⇒ Boolean, ... (readonly)

Allows Lake Formation to assume a role to access tables in a federated database.

Returns:

See Also:



51
52
53
 
# File 'lake_formation/cfn_resource_props.rb', line 51

def with_federation
  @with_federation
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'lake_formation/cfn_resource_props.rb', line 53

def self.jsii_properties
  {
    :resource_arn => "resourceArn",
    :use_service_linked_role => "useServiceLinkedRole",
    :hybrid_access_enabled => "hybridAccessEnabled",
    :role_arn => "roleArn",
    :with_federation => "withFederation",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lake_formation/cfn_resource_props.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "resourceArn" => @resource_arn,
    "useServiceLinkedRole" => @use_service_linked_role,
    "hybridAccessEnabled" => @hybrid_access_enabled,
    "roleArn" => @role_arn,
    "withFederation" => @with_federation,
  })
  result.compact
end