Package software.amazon.awscdk.services.quicksight

Interface CfnDataSource.RedshiftIAMParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.RedshiftIAMParametersProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.RedshiftIAMParametersProperty
extends software.amazon.jsii.JsiiSerializable

A structure that grants Quick Sight access to your cluster and make a call to the redshift:GetClusterCredentials API.

For more information on the redshift:GetClusterCredentials API, see GetClusterCredentials .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 RedshiftIAMParametersProperty redshiftIAMParametersProperty = RedshiftIAMParametersProperty.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .autoCreateDatabaseUser(false)
         .databaseGroups(List.of("databaseGroups"))
         .databaseUser("databaseUser")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.RedshiftIAMParametersProperty.Builder	A builder for CfnDataSource.RedshiftIAMParametersProperty
static final class	CfnDataSource.RedshiftIAMParametersProperty.Jsii$Proxy	An implementation for CfnDataSource.RedshiftIAMParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.RedshiftIAMParametersProperty.Builder	builder()
default Object	getAutoCreateDatabaseUser()	Automatically creates a database user.
default List<String>	getDatabaseGroups()	A list of groups whose permissions will be granted to Quick Sight to access the cluster.
default String	getDatabaseUser()	The user whose permissions and group memberships will be used by Quick Sight to access the cluster.
String	getRoleArn()	Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster.

The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-rolearn

getAutoCreateDatabaseUser

@Stability(Stable)
@Nullable
default Object getAutoCreateDatabaseUser()

Automatically creates a database user.

If your database doesn't have a DatabaseUser , set this parameter to True . If there is no DatabaseUser , Quick Sight 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 union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-autocreatedatabaseuser

getDatabaseGroups

@Stability(Stable)
@Nullable
default List<String> getDatabaseGroups()

A list of groups whose permissions will be granted to Quick Sight to access the cluster.

These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser . If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databasegroups

getDatabaseUser

@Stability(Stable)
@Nullable
default String getDatabaseUser()

The user whose permissions and group memberships will be used by Quick Sight to access the cluster.

If this user already exists in your database, Amazon Quick Sight 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databaseuser

builder

@Stability(Stable)
static CfnDataSource.RedshiftIAMParametersProperty.Builder builder()

Returns:

a CfnDataSource.RedshiftIAMParametersProperty.Builder of CfnDataSource.RedshiftIAMParametersProperty