Class: AWSCDK::Glue::CfnCatalog

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSGlue::ICatalogRef
Defined in:
glue/cfn_catalog.rb

Overview

Creates a catalog in the Glue Data Catalog.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCatalog

Create a new AWS::Glue::Catalog.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Glue::CfnCatalogProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'glue/cfn_catalog.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Glue::CfnCatalogProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2x1ZS5DZm5DYXRhbG9nUHJvcHMifQ==")), "props")
  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) 


189
190
191
 
# File 'glue/cfn_catalog.rb', line 189

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

.is_cfn_catalog(x) ⇒ Boolean

Checks whether the given object is a CfnCatalog.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'glue/cfn_catalog.rb', line 91

def self.is_cfn_catalog(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_glue.CfnCatalog", "isCfnCatalog", [x])
end

.jsii_overridable_methods ⇒ Object 



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
77
78
79
80
81
82
83
84
85
 
# File 'glue/cfn_catalog.rb', line 26

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_catalog_id => { kind: :property, name: "attrCatalogId", is_optional: false },
    :attr_catalog_properties_custom_properties => { kind: :property, name: "attrCatalogPropertiesCustomProperties", is_optional: false },
    :attr_catalog_properties_data_lake_access_properties_managed_workgroup_name => { kind: :property, name: "attrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupName", is_optional: false },
    :attr_catalog_properties_data_lake_access_properties_managed_workgroup_status => { kind: :property, name: "attrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupStatus", is_optional: false },
    :attr_catalog_properties_data_lake_access_properties_redshift_database_name => { kind: :property, name: "attrCatalogPropertiesDataLakeAccessPropertiesRedshiftDatabaseName", is_optional: false },
    :attr_create_time => { kind: :property, name: "attrCreateTime", is_optional: false },
    :attr_resource_arn => { kind: :property, name: "attrResourceArn", is_optional: false },
    :attr_update_time => { kind: :property, name: "attrUpdateTime", is_optional: false },
    :catalog_ref => { kind: :property, name: "catalogRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :allow_full_table_external_data_access => { kind: :property, name: "allowFullTableExternalDataAccess", is_optional: true },
    :catalog_properties => { kind: :property, name: "catalogProperties", 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 },
    :description => { kind: :property, name: "description", is_optional: true },
    :federated_catalog => { kind: :property, name: "federatedCatalog", is_optional: true },
    :overwrite_child_resource_permissions_with_default => { kind: :property, name: "overwriteChildResourcePermissionsWithDefault", is_optional: true },
    :parameters => { kind: :property, name: "parameters", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :target_redshift_catalog => { kind: :property, name: "targetRedshiftCatalog", 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.



435
436
437
438
 
# File 'glue/cfn_catalog.rb', line 435

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:



447
448
449
450
 
# File 'glue/cfn_catalog.rb', line 447

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:



457
458
459
460
 
# File 'glue/cfn_catalog.rb', line 457

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:



468
469
470
471
472
 
# File 'glue/cfn_catalog.rb', line 468

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.


525
526
527
528
529
 
# File 'glue/cfn_catalog.rb', line 525

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.



535
536
537
538
 
# File 'glue/cfn_catalog.rb', line 535

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.



547
548
549
550
551
 
# File 'glue/cfn_catalog.rb', line 547

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

#allow_full_table_external_data_access ⇒ String?

Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

Returns:

  • (String, nil) 


278
279
280
 
# File 'glue/cfn_catalog.rb', line 278

def allow_full_table_external_data_access()
  jsii_get_property("allowFullTableExternalDataAccess")
end

#allow_full_table_external_data_access=(value) ⇒ Object 



282
283
284
285
 
# File 'glue/cfn_catalog.rb', line 282

def allow_full_table_external_data_access=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "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:



560
561
562
563
 
# File 'glue/cfn_catalog.rb', line 560

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:



582
583
584
585
586
587
 
# File 'glue/cfn_catalog.rb', line 582

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_catalog_id ⇒ String

The ID of the catalog.

Returns:

  • (String) 


196
197
198
 
# File 'glue/cfn_catalog.rb', line 196

def attr_catalog_id()
  jsii_get_property("attrCatalogId")
end

#attr_catalog_properties_custom_properties ⇒ AWSCDK::IResolvable

Additional key-value properties for the catalog.

Returns:



203
204
205
 
# File 'glue/cfn_catalog.rb', line 203

def attr_catalog_properties_custom_properties()
  jsii_get_property("attrCatalogPropertiesCustomProperties")
end

#attr_catalog_properties_data_lake_access_properties_managed_workgroup_name ⇒ String

The name of the managed workgroup associated with the catalog.

Returns:

  • (String) 


210
211
212
 
# File 'glue/cfn_catalog.rb', line 210

def attr_catalog_properties_data_lake_access_properties_managed_workgroup_name()
  jsii_get_property("attrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupName")
end

#attr_catalog_properties_data_lake_access_properties_managed_workgroup_status ⇒ String

The status of the managed workgroup.

Returns:

  • (String) 


217
218
219
 
# File 'glue/cfn_catalog.rb', line 217

def attr_catalog_properties_data_lake_access_properties_managed_workgroup_status()
  jsii_get_property("attrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupStatus")
end

#attr_catalog_properties_data_lake_access_properties_redshift_database_name ⇒ String

The name of the Redshift database.

Returns:

  • (String) 


224
225
226
 
# File 'glue/cfn_catalog.rb', line 224

def attr_catalog_properties_data_lake_access_properties_redshift_database_name()
  jsii_get_property("attrCatalogPropertiesDataLakeAccessPropertiesRedshiftDatabaseName")
end

#attr_create_time ⇒ Numeric

The time at which the catalog was created.

Returns:

  • (Numeric) 


231
232
233
 
# File 'glue/cfn_catalog.rb', line 231

def attr_create_time()
  jsii_get_property("attrCreateTime")
end

#attr_resource_arn ⇒ String

The Amazon Resource Name (ARN) of the catalog.

Returns:

  • (String) 


238
239
240
 
# File 'glue/cfn_catalog.rb', line 238

def attr_resource_arn()
  jsii_get_property("attrResourceArn")
end

#attr_update_time ⇒ Numeric

The time at which the catalog was last updated.

Returns:

  • (Numeric) 


245
246
247
 
# File 'glue/cfn_catalog.rb', line 245

def attr_update_time()
  jsii_get_property("attrUpdateTime")
end

#catalog_properties ⇒ AWSCDK::IResolvable, ...

A structure that specifies data lake access properties and other custom properties.

Returns:



290
291
292
 
# File 'glue/cfn_catalog.rb', line 290

def catalog_properties()
  jsii_get_property("catalogProperties")
end

#catalog_properties=(value) ⇒ Object 



294
295
296
297
298
 
# File 'glue/cfn_catalog.rb', line 294

def catalog_properties=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCatalog::CatalogPropertiesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNhdGFsb2cuQ2F0YWxvZ1Byb3BlcnRpZXNQcm9wZXJ0eSJ9XX19")), "catalogProperties") unless value.nil?
  jsii_set_property("catalogProperties", value)
end

#catalog_ref ⇒ AWSCDK::Interfaces::AWSGlue::CatalogReference

A reference to a Catalog resource.

Returns:



252
253
254
 
# File 'glue/cfn_catalog.rb', line 252

def catalog_ref()
  jsii_get_property("catalogRef")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



259
260
261
 
# File 'glue/cfn_catalog.rb', line 259

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'glue/cfn_catalog.rb', line 142

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


147
148
149
 
# File 'glue/cfn_catalog.rb', line 147

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


591
592
593
594
 
# File 'glue/cfn_catalog.rb', line 591

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}) 


152
153
154
 
# File 'glue/cfn_catalog.rb', line 152

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


159
160
161
 
# File 'glue/cfn_catalog.rb', line 159

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#create_database_default_permissions ⇒ AWSCDK::IResolvable, ...

An array of PrincipalPermissions objects for default database permissions.

Returns:



303
304
305
 
# File 'glue/cfn_catalog.rb', line 303

def create_database_default_permissions()
  jsii_get_property("createDatabaseDefaultPermissions")
end

#create_database_default_permissions=(value) ⇒ Object 



307
308
309
310
 
# File 'glue/cfn_catalog.rb', line 307

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

#create_table_default_permissions ⇒ AWSCDK::IResolvable, ...

An array of PrincipalPermissions objects for default table permissions.

Returns:



315
316
317
 
# File 'glue/cfn_catalog.rb', line 315

def create_table_default_permissions()
  jsii_get_property("createTableDefaultPermissions")
end

#create_table_default_permissions=(value) ⇒ Object 



319
320
321
322
 
# File 'glue/cfn_catalog.rb', line 319

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


104
105
106
 
# File 'glue/cfn_catalog.rb', line 104

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description of the catalog.

Returns:

  • (String, nil) 


327
328
329
 
# File 'glue/cfn_catalog.rb', line 327

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



331
332
333
334
 
# File 'glue/cfn_catalog.rb', line 331

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



164
165
166
 
# File 'glue/cfn_catalog.rb', line 164

def env()
  jsii_get_property("env")
end

#federated_catalog ⇒ AWSCDK::IResolvable, ...

A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

Returns:



339
340
341
 
# File 'glue/cfn_catalog.rb', line 339

def federated_catalog()
  jsii_get_property("federatedCatalog")
end

#federated_catalog=(value) ⇒ Object 



343
344
345
346
347
 
# File 'glue/cfn_catalog.rb', line 343

def federated_catalog=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCatalog::FederatedCatalogProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNhdGFsb2cuRmVkZXJhdGVkQ2F0YWxvZ1Byb3BlcnR5In1dfX0=")), "federatedCatalog") unless value.nil?
  jsii_set_property("federatedCatalog", 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:



604
605
606
607
608
 
# File 'glue/cfn_catalog.rb', line 604

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:



615
616
617
618
 
# File 'glue/cfn_catalog.rb', line 615

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:



685
686
687
688
 
# File 'glue/cfn_catalog.rb', line 685

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) 


116
117
118
 
# File 'glue/cfn_catalog.rb', line 116

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the catalog to create.

Returns:

  • (String) 


266
267
268
 
# File 'glue/cfn_catalog.rb', line 266

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



270
271
272
273
 
# File 'glue/cfn_catalog.rb', line 270

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'glue/cfn_catalog.rb', line 99

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:



626
627
628
 
# File 'glue/cfn_catalog.rb', line 626

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:



633
634
635
 
# File 'glue/cfn_catalog.rb', line 633

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.



426
427
428
429
 
# File 'glue/cfn_catalog.rb', line 426

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

#overwrite_child_resource_permissions_with_default ⇒ String?

Specifies whether to overwrite child resource permissions with the default permissions.

Returns:

  • (String, nil) 


352
353
354
 
# File 'glue/cfn_catalog.rb', line 352

def overwrite_child_resource_permissions_with_default()
  jsii_get_property("overwriteChildResourcePermissionsWithDefault")
end

#overwrite_child_resource_permissions_with_default=(value) ⇒ Object 



356
357
358
359
 
# File 'glue/cfn_catalog.rb', line 356

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

#parameters ⇒ AWSCDK::IResolvable, ...

A map of key-value pairs that define parameters and properties of the catalog.

Returns:



364
365
366
 
# File 'glue/cfn_catalog.rb', line 364

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



368
369
370
371
 
# File 'glue/cfn_catalog.rb', line 368

def parameters=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "parameters") unless value.nil?
  jsii_set_property("parameters", 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) 


135
136
137
 
# File 'glue/cfn_catalog.rb', line 135

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:



644
645
646
647
 
# File 'glue/cfn_catalog.rb', line 644

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}) 


651
652
653
654
 
# File 'glue/cfn_catalog.rb', line 651

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:



661
662
663
664
665
 
# File 'glue/cfn_catalog.rb', line 661

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.



670
671
672
 
# File 'glue/cfn_catalog.rb', line 670

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:



125
126
127
 
# File 'glue/cfn_catalog.rb', line 125

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



376
377
378
 
# File 'glue/cfn_catalog.rb', line 376

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



380
381
382
383
384
 
# File 'glue/cfn_catalog.rb', line 380

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#target_redshift_catalog ⇒ AWSCDK::IResolvable, ...

A structure that describes a target catalog for resource linking.

Returns:



389
390
391
 
# File 'glue/cfn_catalog.rb', line 389

def target_redshift_catalog()
  jsii_get_property("targetRedshiftCatalog")
end

#target_redshift_catalog=(value) ⇒ Object 



393
394
395
396
397
 
# File 'glue/cfn_catalog.rb', line 393

def target_redshift_catalog=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Glue::CfnCatalog::TargetRedshiftCatalogProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nbHVlLkNmbkNhdGFsb2cuVGFyZ2V0UmVkc2hpZnRDYXRhbG9nUHJvcGVydHkifV19fQ==")), "targetRedshiftCatalog") unless value.nil?
  jsii_set_property("targetRedshiftCatalog", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



402
403
404
 
# File 'glue/cfn_catalog.rb', line 402

def to_string()
  jsii_call_method("toString", [])
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}) 


172
173
174
 
# File 'glue/cfn_catalog.rb', line 172

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}) 


182
183
184
 
# File 'glue/cfn_catalog.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


676
677
678
679
 
# File 'glue/cfn_catalog.rb', line 676

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) 


415
416
417
418
419
420
 
# File 'glue/cfn_catalog.rb', line 415

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