Class: Aws::QuickSight::Types::RedshiftParameters

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::RedshiftParameters

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster_id ⇒ String

  Cluster ID.

• #database ⇒ String

  Database.

• #host ⇒ String

  Host.

• #iam_parameters ⇒ Types::RedshiftIAMParameters

  An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster.

• #identity_center_configuration ⇒ Types::IdentityCenterConfiguration

  An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

• #port ⇒ Integer

  Port.

Instance Attribute Details

#cluster_id ⇒ String

Cluster ID. This field can be blank if the ‘Host` and `Port` are provided.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database ⇒ String

Database.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#host ⇒ String

Host. This field can be blank if ‘ClusterId` is provided.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iam_parameters ⇒ Types::RedshiftIAMParameters

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of [DataSourceCredentials].

[1]: docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html

Returns:

• (Types::RedshiftIAMParameters)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_configuration ⇒ Types::IdentityCenterConfiguration

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

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

Returns:

• (Types::IdentityCenterConfiguration)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

Port. This field can be blank if the ‘ClusterId` is provided.

Returns:

• (Integer)

# File 'lib/aws-sdk-quicksight/types.rb', line 26616

class RedshiftParameters < Struct.new(
  :host,
  :port,
  :database,
  :cluster_id,
  :iam_parameters,
  :identity_center_configuration)
  SENSITIVE = []
  include Aws::Structure
end