Class: AWSCDK::QuickSight::CfnDataSource::StarburstParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_data_source.rb

Overview

The parameters that are required to connect to a Starburst data source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(catalog:, host:, port:, authentication_type: nil, database_access_control_role: nil, o_auth_parameters: nil, product_type: nil) ⇒ StarburstParametersProperty

Returns a new instance of StarburstParametersProperty.

Parameters:

  • catalog (String) —

    The catalog name for the Starburst data source.

  • host (String) —

    The host name of the Starburst data source.

  • port (Numeric) —

    The port for the Starburst data source.

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

    The authentication type that you want to use for your connection.

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

    The database access control role.

  • o_auth_parameters (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnDataSource::OAuthParametersProperty, nil) (defaults to: nil) —

    An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.

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

    The product type for the Starburst data source.



2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
 
# File 'quick_sight/cfn_data_source.rb', line 2431

def initialize(catalog:, host:, port:, authentication_type: nil, database_access_control_role: nil, o_auth_parameters: nil, product_type: nil)
  @catalog = catalog
  Jsii::Type.check_type(@catalog, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalog")
  @host = host
  Jsii::Type.check_type(@host, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "host")
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port")
  @authentication_type = authentication_type
  Jsii::Type.check_type(@authentication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationType") unless @authentication_type.nil?
  @database_access_control_role = database_access_control_role
  Jsii::Type.check_type(@database_access_control_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseAccessControlRole") unless @database_access_control_role.nil?
  @o_auth_parameters = o_auth_parameters.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::OAuthParametersProperty.new(**o_auth_parameters.transform_keys(&:to_sym)) : o_auth_parameters
  Jsii::Type.check_type(@o_auth_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuT0F1dGhQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "oAuthParameters") unless @o_auth_parameters.nil?
  @product_type = product_type
  Jsii::Type.check_type(@product_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productType") unless @product_type.nil?
end

Instance Attribute Details

#authentication_type ⇒ String? (readonly)

The authentication type that you want to use for your connection.

This parameter accepts OAuth and non-OAuth authentication types.

Returns:

  • (String, nil)

See Also:



2470
2471
2472
 
# File 'quick_sight/cfn_data_source.rb', line 2470

def authentication_type
  @authentication_type
end

#catalog ⇒ String (readonly)

The catalog name for the Starburst data source.

Returns:

  • (String)

See Also:



2452
2453
2454
 
# File 'quick_sight/cfn_data_source.rb', line 2452

def catalog
  @catalog
end

#database_access_control_role ⇒ String? (readonly)

The database access control role.

Returns:

  • (String, nil)

See Also:



2475
2476
2477
 
# File 'quick_sight/cfn_data_source.rb', line 2475

def database_access_control_role
  @database_access_control_role
end

#host ⇒ String (readonly)

The host name of the Starburst data source.

Returns:

  • (String)

See Also:



2457
2458
2459
 
# File 'quick_sight/cfn_data_source.rb', line 2457

def host
  @host
end

#o_auth_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.

Returns:

See Also:



2480
2481
2482
 
# File 'quick_sight/cfn_data_source.rb', line 2480

def o_auth_parameters
  @o_auth_parameters
end

#port ⇒ Numeric (readonly)

Note:

Default: - 0

The port for the Starburst data source.

Returns:

  • (Numeric)

See Also:



2463
2464
2465
 
# File 'quick_sight/cfn_data_source.rb', line 2463

def port
  @port
end

#product_type ⇒ String? (readonly)

The product type for the Starburst data source.

Returns:

  • (String, nil)

See Also:



2485
2486
2487
 
# File 'quick_sight/cfn_data_source.rb', line 2485

def product_type
  @product_type
end

Class Method Details

.jsii_properties ⇒ Object 



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'quick_sight/cfn_data_source.rb', line 2487

def self.jsii_properties
  {
    :catalog => "catalog",
    :host => "host",
    :port => "port",
    :authentication_type => "authenticationType",
    :database_access_control_role => "databaseAccessControlRole",
    :o_auth_parameters => "oAuthParameters",
    :product_type => "productType",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
 
# File 'quick_sight/cfn_data_source.rb', line 2499

def to_jsii
  result = {}
  result.merge!({
    "catalog" => @catalog,
    "host" => @host,
    "port" => @port,
    "authenticationType" => @authentication_type,
    "databaseAccessControlRole" => @database_access_control_role,
    "oAuthParameters" => @o_auth_parameters,
    "productType" => @product_type,
  })
  result.compact
end