Class: AWSCDK::QuickSight::CfnDataSource::RedshiftParametersProperty

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

Overview

The parameters for Amazon Redshift.

The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(database:, cluster_id: nil, host: nil, iam_parameters: nil, identity_center_configuration: nil, port: nil) ⇒ RedshiftParametersProperty

Returns a new instance of RedshiftParametersProperty.

Parameters:



1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
 
# File 'quick_sight/cfn_data_source.rb', line 1988

def initialize(database:, cluster_id: nil, host: nil, iam_parameters: nil, identity_center_configuration: nil, port: nil)
  @database = database
  Jsii::Type.check_type(@database, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "database")
  @cluster_id = cluster_id
  Jsii::Type.check_type(@cluster_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterId") unless @cluster_id.nil?
  @host = host
  Jsii::Type.check_type(@host, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "host") unless @host.nil?
  @iam_parameters = iam_parameters.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::RedshiftIAMParametersProperty.new(**iam_parameters.transform_keys(&:to_sym)) : iam_parameters
  Jsii::Type.check_type(@iam_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuUmVkc2hpZnRJQU1QYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "iamParameters") unless @iam_parameters.nil?
  @identity_center_configuration = identity_center_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDataSource::IdentityCenterConfigurationProperty.new(**identity_center_configuration.transform_keys(&:to_sym)) : identity_center_configuration
  Jsii::Type.check_type(@identity_center_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhdGFTb3VyY2UuSWRlbnRpdHlDZW50ZXJDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "identityCenterConfiguration") unless @identity_center_configuration.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
end

Instance Attribute Details

#cluster_id ⇒ String? (readonly)

Cluster ID.

This field can be blank if the Host and Port are provided.

Returns:

  • (String, nil)

See Also:



2014
2015
2016
 
# File 'quick_sight/cfn_data_source.rb', line 2014

def cluster_id
  @cluster_id
end

#database ⇒ String (readonly)

Database.

Returns:

  • (String)

See Also:



2007
2008
2009
 
# File 'quick_sight/cfn_data_source.rb', line 2007

def database
  @database
end

#host ⇒ String? (readonly)

Host.

This field can be blank if ClusterId is provided.

Returns:

  • (String, nil)

See Also:



2021
2022
2023
 
# File 'quick_sight/cfn_data_source.rb', line 2021

def host
  @host
end

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

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.

This parameter can be used instead of DataSourceCredentials .

Returns:

See Also:



2028
2029
2030
 
# File 'quick_sight/cfn_data_source.rb', line 2028

def iam_parameters
  @iam_parameters
end

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

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

Returns:

See Also:



2035
2036
2037
 
# File 'quick_sight/cfn_data_source.rb', line 2035

def identity_center_configuration
  @identity_center_configuration
end

#port ⇒ Numeric? (readonly)

Note:

Default: - 0

Port.

This field can be blank if the ClusterId is provided.

Returns:

  • (Numeric, nil)

See Also:



2043
2044
2045
 
# File 'quick_sight/cfn_data_source.rb', line 2043

def port
  @port
end

Class Method Details

.jsii_properties ⇒ Object 



2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
 
# File 'quick_sight/cfn_data_source.rb', line 2045

def self.jsii_properties
  {
    :database => "database",
    :cluster_id => "clusterId",
    :host => "host",
    :iam_parameters => "iamParameters",
    :identity_center_configuration => "identityCenterConfiguration",
    :port => "port",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'quick_sight/cfn_data_source.rb', line 2056

def to_jsii
  result = {}
  result.merge!({
    "database" => @database,
    "clusterId" => @cluster_id,
    "host" => @host,
    "iamParameters" => @iam_parameters,
    "identityCenterConfiguration" => @identity_center_configuration,
    "port" => @port,
  })
  result.compact
end