Package software.amazon.awscdk.services.quicksight

Class CfnDataSource.RedshiftIAMParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnDataSource.RedshiftIAMParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.RedshiftIAMParametersProperty>

Enclosing interface:

CfnDataSource.RedshiftIAMParametersProperty

@Stability(Stable)
public static final class CfnDataSource.RedshiftIAMParametersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.RedshiftIAMParametersProperty>

A builder for CfnDataSource.RedshiftIAMParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.RedshiftIAMParametersProperty.Builder	autoCreateDatabaseUser(Boolean autoCreateDatabaseUser)	Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()
CfnDataSource.RedshiftIAMParametersProperty.Builder	autoCreateDatabaseUser(IResolvable autoCreateDatabaseUser)	Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()
CfnDataSource.RedshiftIAMParametersProperty	build()	Builds the configured instance.
CfnDataSource.RedshiftIAMParametersProperty.Builder	databaseGroups(List<String> databaseGroups)	Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getDatabaseGroups()
CfnDataSource.RedshiftIAMParametersProperty.Builder	databaseUser(String databaseUser)	Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getDatabaseUser()
CfnDataSource.RedshiftIAMParametersProperty.Builder	roleArn(String roleArn)	Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getRoleArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

roleArn

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty.Builder roleArn(String roleArn)

Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getRoleArn()

Parameters:

roleArn - Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. This parameter is required. 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.

Returns:

this

autoCreateDatabaseUser

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty.Builder autoCreateDatabaseUser(Boolean autoCreateDatabaseUser)

Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()

Parameters:

autoCreateDatabaseUser - 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:

this

autoCreateDatabaseUser

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty.Builder autoCreateDatabaseUser(IResolvable autoCreateDatabaseUser)

Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()

Parameters:

autoCreateDatabaseUser - 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:

this

databaseGroups

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty.Builder databaseGroups(List<String> databaseGroups)

Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getDatabaseGroups()

Parameters:

databaseGroups - 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 .

Returns:

this

databaseUser

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty.Builder databaseUser(String databaseUser)

Sets the value of CfnDataSource.RedshiftIAMParametersProperty.getDatabaseUser()

Parameters:

databaseUser - 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.

Returns:

this

build

@Stability(Stable)
public CfnDataSource.RedshiftIAMParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.RedshiftIAMParametersProperty>

Returns:

a new instance of CfnDataSource.RedshiftIAMParametersProperty

Throws:

NullPointerException - if any required attribute was not provided