Class: AWSCDK::LakeFormation::CfnDataLakeSettings

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSLakeformation::IDataLakeSettingsRef
Defined in:
lake_formation/cfn_data_lake_settings.rb

Overview

The AWS::LakeFormation::DataLakeSettings resource is an AWS Lake Formation resource type that manages the data lake settings for your account.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnDataLakeSettings

Create a new AWS::LakeFormation::DataLakeSettings.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::LakeFormation::CfnDataLakeSettingsProps, nil) (defaults to: nil) —

    Resource properties.



17
18
19
20
21
22
23
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 17

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::LakeFormation::CfnDataLakeSettingsProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


180
181
182
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 180

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_lakeformation.CfnDataLakeSettings", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_data_lake_settings(x) ⇒ Boolean

Checks whether the given object is a CfnDataLakeSettings.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


82
83
84
85
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 82

def self.is_cfn_data_lake_settings(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_lakeformation.CfnDataLakeSettings", "isCfnDataLakeSettings", [x])
end

.jsii_overridable_methods ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 25

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :data_lake_settings_ref => { kind: :property, name: "dataLakeSettingsRef", is_optional: false },
    :parameters => { kind: :property, name: "parameters", is_optional: false },
    :admins => { kind: :property, name: "admins", is_optional: true },
    :allow_external_data_filtering => { kind: :property, name: "allowExternalDataFiltering", is_optional: true },
    :allow_full_table_external_data_access => { kind: :property, name: "allowFullTableExternalDataAccess", is_optional: true },
    :authorized_session_tag_value_list => { kind: :property, name: "authorizedSessionTagValueList", is_optional: true },
    :create_database_default_permissions => { kind: :property, name: "createDatabaseDefaultPermissions", is_optional: true },
    :create_table_default_permissions => { kind: :property, name: "createTableDefaultPermissions", is_optional: true },
    :external_data_filtering_allow_list => { kind: :property, name: "externalDataFilteringAllowList", is_optional: true },
    :mutation_type => { kind: :property, name: "mutationType", is_optional: true },
    :read_only_admins => { kind: :property, name: "readOnlyAdmins", is_optional: true },
    :trusted_resource_owners => { kind: :property, name: "trustedResourceOwners", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



362
363
364
365
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 362

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



374
375
376
377
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 374

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



384
385
386
387
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 384

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



395
396
397
398
399
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 395

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


452
453
454
455
456
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 452

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



462
463
464
465
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 462

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



474
475
476
477
478
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 474

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#admins ⇒ AWSCDK::IResolvable, ...

A list of AWS Lake Formation principals.

Returns:



211
212
213
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 211

def admins()
  jsii_get_property("admins")
end

#admins=(value) ⇒ Object 



215
216
217
218
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 215

def admins=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzLkRhdGFMYWtlUHJpbmNpcGFsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "admins") unless value.nil?
  jsii_set_property("admins", value)
end

#allow_external_data_filtering ⇒ Boolean, ...

Whether to allow Amazon EMR clusters or other third-party query engines to access data managed by Lake Formation .

Returns:



223
224
225
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 223

def allow_external_data_filtering()
  jsii_get_property("allowExternalDataFiltering")
end

#allow_external_data_filtering=(value) ⇒ Object 



227
228
229
230
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 227

def allow_external_data_filtering=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowExternalDataFiltering") unless value.nil?
  jsii_set_property("allowExternalDataFiltering", value)
end

#allow_full_table_external_data_access ⇒ Boolean, ...

Specifies whether query engines and applications can get credentials without IAM session tags if the user has full table access.

Returns:



235
236
237
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 235

def allow_full_table_external_data_access()
  jsii_get_property("allowFullTableExternalDataAccess")
end

#allow_full_table_external_data_access=(value) ⇒ Object 



239
240
241
242
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 239

def allow_full_table_external_data_access=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowFullTableExternalDataAccess") unless value.nil?
  jsii_set_property("allowFullTableExternalDataAccess", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



487
488
489
490
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 487

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



509
510
511
512
513
514
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 509

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

Returns:

  • (String) 


185
186
187
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 185

def attr_id()
  jsii_get_property("attrId")
end

#authorized_session_tag_value_list ⇒ Array<String>?

Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.

Returns:

  • (Array<String>, nil) 


247
248
249
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 247

def authorized_session_tag_value_list()
  jsii_get_property("authorizedSessionTagValueList")
end

#authorized_session_tag_value_list=(value) ⇒ Object 



251
252
253
254
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 251

def authorized_session_tag_value_list=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "authorizedSessionTagValueList") unless value.nil?
  jsii_set_property("authorizedSessionTagValueList", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



133
134
135
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 133

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


138
139
140
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 138

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


518
519
520
521
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 518

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


143
144
145
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 143

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


150
151
152
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 150

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#create_database_default_permissions ⇒ AWSCDK::IResolvable, ...

Specifies whether access control on a newly created database is managed by Lake Formation permissions or exclusively by IAM permissions.

Returns:



259
260
261
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 259

def create_database_default_permissions()
  jsii_get_property("createDatabaseDefaultPermissions")
end

#create_database_default_permissions=(value) ⇒ Object 



263
264
265
266
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 263

def create_database_default_permissions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzLlByaW5jaXBhbFBlcm1pc3Npb25zUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "createDatabaseDefaultPermissions") unless value.nil?
  jsii_set_property("createDatabaseDefaultPermissions", value)
end

#create_table_default_permissions ⇒ AWSCDK::IResolvable, ...

Specifies whether access control on a newly created table is managed by Lake Formation permissions or exclusively by IAM permissions.

Returns:



271
272
273
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 271

def create_table_default_permissions()
  jsii_get_property("createTableDefaultPermissions")
end

#create_table_default_permissions=(value) ⇒ Object 



275
276
277
278
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 275

def create_table_default_permissions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzLlByaW5jaXBhbFBlcm1pc3Npb25zUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "createTableDefaultPermissions") unless value.nil?
  jsii_set_property("createTableDefaultPermissions", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


95
96
97
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 95

def creation_stack()
  jsii_get_property("creationStack")
end

#data_lake_settings_ref ⇒ AWSCDK::Interfaces::AWSLakeformation::DataLakeSettingsReference

A reference to a DataLakeSettings resource.

Returns:



192
193
194
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 192

def data_lake_settings_ref()
  jsii_get_property("dataLakeSettingsRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



155
156
157
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 155

def env()
  jsii_get_property("env")
end

#external_data_filtering_allow_list ⇒ AWSCDK::IResolvable, ...

A list of the account IDs of AWS accounts with Amazon EMR clusters or third-party engines that are allwed to perform data filtering.

Returns:



283
284
285
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 283

def external_data_filtering_allow_list()
  jsii_get_property("externalDataFilteringAllowList")
end

#external_data_filtering_allow_list=(value) ⇒ Object 



287
288
289
290
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 287

def external_data_filtering_allow_list=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzLkRhdGFMYWtlUHJpbmNpcGFsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "externalDataFilteringAllowList") unless value.nil?
  jsii_set_property("externalDataFilteringAllowList", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



531
532
533
534
535
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 531

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



542
543
544
545
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 542

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



612
613
614
615
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 612

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


107
108
109
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 107

def logical_id()
  jsii_get_property("logicalId")
end

#mutation_type ⇒ String?

Specifies whether the data lake settings are updated by adding new values to the current settings ( APPEND ) or by replacing the current settings with new settings ( REPLACE ).

Returns:

  • (String, nil) 


295
296
297
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 295

def mutation_type()
  jsii_get_property("mutationType")
end

#mutation_type=(value) ⇒ Object 



299
300
301
302
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 299

def mutation_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mutationType") unless value.nil?
  jsii_set_property("mutationType", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


90
91
92
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 90

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



553
554
555
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 553

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



560
561
562
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 560

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



353
354
355
356
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 353

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#parameters ⇒ Object

A key-value map that provides an additional configuration on your data lake.

Returns:

  • (Object) 


199
200
201
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 199

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



203
204
205
206
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 203

def parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "parameters")
  jsii_set_property("parameters", value)
end

#read_only_admins ⇒ AWSCDK::IResolvable, ...

Returns:



305
306
307
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 305

def read_only_admins()
  jsii_get_property("readOnlyAdmins")
end

#read_only_admins=(value) ⇒ Object 



309
310
311
312
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 309

def read_only_admins=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFrZWZvcm1hdGlvbi5DZm5EYXRhTGFrZVNldHRpbmdzLkRhdGFMYWtlUHJpbmNpcGFsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "readOnlyAdmins") unless value.nil?
  jsii_set_property("readOnlyAdmins", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


126
127
128
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 126

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



571
572
573
574
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 571

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


578
579
580
581
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 578

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



588
589
590
591
592
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 588

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



597
598
599
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 597

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



116
117
118
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 116

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



329
330
331
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 329

def to_string()
  jsii_call_method("toString", [])
end

#trusted_resource_owners ⇒ Array<String>?

An array of UTF-8 strings.

Returns:

  • (Array<String>, nil) 


317
318
319
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 317

def trusted_resource_owners()
  jsii_get_property("trustedResourceOwners")
end

#trusted_resource_owners=(value) ⇒ Object 



321
322
323
324
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 321

def trusted_resource_owners=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "trustedResourceOwners") unless value.nil?
  jsii_set_property("trustedResourceOwners", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 163

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 173

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


603
604
605
606
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 603

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


342
343
344
345
346
347
 
# File 'lake_formation/cfn_data_lake_settings.rb', line 342

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end