Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnDataSourcePropsMixin.RedshiftIAMParametersProperty

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

A builder for CfnDataSourcePropsMixin.RedshiftIAMParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder	autoCreateDatabaseUser(Boolean autoCreateDatabaseUser)	Sets the value of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder	autoCreateDatabaseUser(IResolvable autoCreateDatabaseUser)	Sets the value of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.getAutoCreateDatabaseUser()
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty	build()	Builds the configured instance.
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder	databaseGroups(List<String> databaseGroups)	Sets the value of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.getDatabaseGroups()
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder	databaseUser(String databaseUser)	Sets the value of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.getDatabaseUser()
CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder	roleArn(String roleArn)	Sets the value of CfnDataSourcePropsMixin.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

autoCreateDatabaseUser

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

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder autoCreateDatabaseUser(IResolvable autoCreateDatabaseUser)

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder databaseGroups(List<String> databaseGroups)

Sets the value of CfnDataSourcePropsMixin.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 CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.Builder databaseUser(String databaseUser)

Sets the value of CfnDataSourcePropsMixin.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

roleArn

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

Sets the value of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty.getRoleArn()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDataSourcePropsMixin.RedshiftIAMParametersProperty

Throws:

NullPointerException - if any required attribute was not provided