Class: AWSCDK::Glue::CfnCatalog::DataLakeAccessPropertiesProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
glue/cfn_catalog.rb

Overview

Data lake access properties for the catalog.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_full_table_external_data_access: nil, catalog_type: nil, data_lake_access: nil, data_transfer_role: nil, kms_key: nil, managed_workgroup_name: nil, managed_workgroup_status: nil, redshift_database_name: nil) ⇒ DataLakeAccessPropertiesProperty

Returns a new instance of DataLakeAccessPropertiesProperty.

Parameters:

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

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

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

    Specifies a federated catalog type for the native catalog resource.

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

    Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.

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

    A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.

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

    An encryption key that will be used for the staging bucket that will be created along with the catalog.

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

    The name of the managed workgroup associated with the catalog.

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

    The status of the managed workgroup.

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

    The name of the Redshift database.



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'glue/cfn_catalog.rb', line 749

def initialize(allow_full_table_external_data_access: nil, catalog_type: nil, data_lake_access: nil, data_transfer_role: nil, kms_key: nil, managed_workgroup_name: nil, managed_workgroup_status: nil, redshift_database_name: nil)
  @allow_full_table_external_data_access = allow_full_table_external_data_access
  Jsii::Type.check_type(@allow_full_table_external_data_access, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "allowFullTableExternalDataAccess") unless @allow_full_table_external_data_access.nil?
  @catalog_type = catalog_type
  Jsii::Type.check_type(@catalog_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalogType") unless @catalog_type.nil?
  @data_lake_access = data_lake_access
  Jsii::Type.check_type(@data_lake_access, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dataLakeAccess") unless @data_lake_access.nil?
  @data_transfer_role = data_transfer_role
  Jsii::Type.check_type(@data_transfer_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataTransferRole") unless @data_transfer_role.nil?
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKey") unless @kms_key.nil?
  @managed_workgroup_name = managed_workgroup_name
  Jsii::Type.check_type(@managed_workgroup_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "managedWorkgroupName") unless @managed_workgroup_name.nil?
  @managed_workgroup_status = managed_workgroup_status
  Jsii::Type.check_type(@managed_workgroup_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "managedWorkgroupStatus") unless @managed_workgroup_status.nil?
  @redshift_database_name = redshift_database_name
  Jsii::Type.check_type(@redshift_database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redshiftDatabaseName") unless @redshift_database_name.nil?
end

Instance Attribute Details

#allow_full_table_external_data_access ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



772
773
774
 
# File 'glue/cfn_catalog.rb', line 772

def allow_full_table_external_data_access
  @allow_full_table_external_data_access
end

#catalog_type ⇒ String? (readonly)

Specifies a federated catalog type for the native catalog resource.

Returns:

  • (String, nil)

See Also:



777
778
779
 
# File 'glue/cfn_catalog.rb', line 777

def catalog_type
  @catalog_type
end

#data_lake_access ⇒ Boolean, ... (readonly)

Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine.

Returns:

See Also:



782
783
784
 
# File 'glue/cfn_catalog.rb', line 782

def data_lake_access
  @data_lake_access
end

#data_transfer_role ⇒ String? (readonly)

A role that will be assumed by Glue for transferring data into/out of the staging bucket during a query.

Returns:

  • (String, nil)

See Also:



787
788
789
 
# File 'glue/cfn_catalog.rb', line 787

def data_transfer_role
  @data_transfer_role
end

#kms_key ⇒ String? (readonly)

An encryption key that will be used for the staging bucket that will be created along with the catalog.

Returns:

  • (String, nil)

See Also:



792
793
794
 
# File 'glue/cfn_catalog.rb', line 792

def kms_key
  @kms_key
end

#managed_workgroup_name ⇒ String? (readonly)

The name of the managed workgroup associated with the catalog.

Returns:

  • (String, nil)

See Also:



797
798
799
 
# File 'glue/cfn_catalog.rb', line 797

def managed_workgroup_name
  @managed_workgroup_name
end

#managed_workgroup_status ⇒ String? (readonly)

The status of the managed workgroup.

Returns:

  • (String, nil)

See Also:



802
803
804
 
# File 'glue/cfn_catalog.rb', line 802

def managed_workgroup_status
  @managed_workgroup_status
end

#redshift_database_name ⇒ String? (readonly)

The name of the Redshift database.

Returns:

  • (String, nil)

See Also:



807
808
809
 
# File 'glue/cfn_catalog.rb', line 807

def redshift_database_name
  @redshift_database_name
end

Class Method Details

.jsii_properties ⇒ Object 



809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'glue/cfn_catalog.rb', line 809

def self.jsii_properties
  {
    :allow_full_table_external_data_access => "allowFullTableExternalDataAccess",
    :catalog_type => "catalogType",
    :data_lake_access => "dataLakeAccess",
    :data_transfer_role => "dataTransferRole",
    :kms_key => "kmsKey",
    :managed_workgroup_name => "managedWorkgroupName",
    :managed_workgroup_status => "managedWorkgroupStatus",
    :redshift_database_name => "redshiftDatabaseName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'glue/cfn_catalog.rb', line 822

def to_jsii
  result = {}
  result.merge!({
    "allowFullTableExternalDataAccess" => @allow_full_table_external_data_access,
    "catalogType" => @catalog_type,
    "dataLakeAccess" => @data_lake_access,
    "dataTransferRole" => @data_transfer_role,
    "kmsKey" => @kms_key,
    "managedWorkgroupName" => @managed_workgroup_name,
    "managedWorkgroupStatus" => @managed_workgroup_status,
    "redshiftDatabaseName" => @redshift_database_name,
  })
  result.compact
end