Class: AWSCDK::CleanRooms::CfnConfiguredTable::AthenaTableReferenceProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CleanRooms::CfnConfiguredTable::AthenaTableReferenceProperty

Defined in:

clean_rooms/cfn_configured_table.rb

Overview

A reference to a table within Athena.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html

Instance Attribute Summary

• #catalog_name ⇒ String^? readonly
• #database_name ⇒ String readonly

  The database name.

• #output_location ⇒ String^? readonly

  The output location for the Athena table.

• #region ⇒ String^? readonly

  The AWS Region where the Athena table is located.

• #table_name ⇒ String readonly

  The table reference.

• #work_group ⇒ String readonly

  The workgroup of the Athena table reference.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(database_name:, table_name:, work_group:, catalog_name: nil, output_location: nil, region: nil) ⇒ AthenaTableReferenceProperty constructor

  A new instance of AthenaTableReferenceProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(database_name:, table_name:, work_group:, catalog_name: nil, output_location: nil, region: nil) ⇒ AthenaTableReferenceProperty

Returns a new instance of AthenaTableReferenceProperty.

Parameters:

• database_name (String) —

  The database name.

• table_name (String) —

  The table reference.

• work_group (String) —

  The workgroup of the Athena table reference.

• catalog_name (String, nil) (defaults to: nil)
• output_location (String, nil) (defaults to: nil) —

  The output location for the Athena table.

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

  The AWS Region where the Athena table is located.

# File 'clean_rooms/cfn_configured_table.rb', line 1020

def initialize(database_name:, table_name:, work_group:, catalog_name: nil, output_location: nil, region: nil)
  @database_name = database_name
  Jsii::Type.check_type(@database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName")
  @table_name = table_name
  Jsii::Type.check_type(@table_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tableName")
  @work_group = work_group
  Jsii::Type.check_type(@work_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workGroup")
  @catalog_name = catalog_name
  Jsii::Type.check_type(@catalog_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalogName") unless @catalog_name.nil?
  @output_location = output_location
  Jsii::Type.check_type(@output_location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputLocation") unless @output_location.nil?
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
end

Instance Attribute Details

#catalog_name ⇒ String^? (readonly)

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-catalogname

# File 'clean_rooms/cfn_configured_table.rb', line 1052

def catalog_name
  @catalog_name
end

#database_name ⇒ String (readonly)

The database name.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-databasename

# File 'clean_rooms/cfn_configured_table.rb', line 1039

def database_name
  @database_name
end

#output_location ⇒ String^? (readonly)

The output location for the Athena table.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-outputlocation

# File 'clean_rooms/cfn_configured_table.rb', line 1057

def output_location
  @output_location
end

#region ⇒ String^? (readonly)

The AWS Region where the Athena table is located.

This parameter is required to uniquely identify and access tables across different Regions.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-region

# File 'clean_rooms/cfn_configured_table.rb', line 1064

def region
  @region
end

#table_name ⇒ String (readonly)

The table reference.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-tablename

# File 'clean_rooms/cfn_configured_table.rb', line 1044

def table_name
  @table_name
end

#work_group ⇒ String (readonly)

The workgroup of the Athena table reference.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-athenatablereference.html#cfn-cleanrooms-configuredtable-athenatablereference-workgroup

# File 'clean_rooms/cfn_configured_table.rb', line 1049

def work_group
  @work_group
end

Class Method Details

.jsii_properties ⇒ Object

# File 'clean_rooms/cfn_configured_table.rb', line 1066

def self.jsii_properties
  {
    :database_name => "databaseName",
    :table_name => "tableName",
    :work_group => "workGroup",
    :catalog_name => "catalogName",
    :output_location => "outputLocation",
    :region => "region",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'clean_rooms/cfn_configured_table.rb', line 1077

def to_jsii
  result = {}
  result.merge!({
    "databaseName" => @database_name,
    "tableName" => @table_name,
    "workGroup" => @work_group,
    "catalogName" => @catalog_name,
    "outputLocation" => @output_location,
    "region" => @region,
  })
  result.compact
end