Class: Aws::QuickSight::Types::RedshiftIAMParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

A structure that grants QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_create_database_user ⇒ Boolean

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

Returns:

  • (Boolean) 


27424
27425
27426
27427
27428
27429
27430
27431
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 27424

class RedshiftIAMParameters < Struct.new(
  :role_arn,
  :database_user,
  :database_groups,
  :auto_create_database_user)
  SENSITIVE = []
  include Aws::Structure
end

#database_groups ⇒ Array<String>

A list of groups whose permissions will be granted to QuickSight to access the cluster. These permissions are combined with the permissions granted to QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

Returns:

  • (Array<String>) 


27424
27425
27426
27427
27428
27429
27430
27431
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 27424

class RedshiftIAMParameters < Struct.new(
  :role_arn,
  :database_user,
  :database_groups,
  :auto_create_database_user)
  SENSITIVE = []
  include Aws::Structure
end

#database_user ⇒ String

The user whose permissions and group memberships will be used by QuickSight to access the cluster. If this user already exists in your database, QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

Returns:

  • (String) 


27424
27425
27426
27427
27428
27429
27430
27431
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 27424

class RedshiftIAMParameters < Struct.new(
  :role_arn,
  :database_user,
  :database_groups,
  :auto_create_database_user)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

Use the RoleArn structure to allow QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to QuickSight. The role's trust policy must allow the QuickSight service principal to assume the role.

Returns:

  • (String) 


27424
27425
27426
27427
27428
27429
27430
27431
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 27424

class RedshiftIAMParameters < Struct.new(
  :role_arn,
  :database_user,
  :database_groups,
  :auto_create_database_user)
  SENSITIVE = []
  include Aws::Structure
end