Skip to content
v2.278.0

RedshiftIAMParametersProperty Struct ​

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 ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const redshiftIAMParametersProperty: quicksight.CfnDataSource.RedshiftIAMParametersProperty = {
  roleArn: 'roleArn',

  // the properties below are optional
  autoCreateDatabaseUser: false,
  databaseGroups: ['databaseGroups'],
  databaseUser: 'databaseUser',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

redshift_iam_parameters_property = quicksight.CfnDataSource.RedshiftIAMParametersProperty(
    role_arn="roleArn",

    # the properties below are optional
    auto_create_database_user=False,
    database_groups=["databaseGroups"],
    database_user="databaseUser"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var redshiftIAMParametersProperty = new RedshiftIAMParametersProperty {
    RoleArn = "roleArn",

    // the properties below are optional
    AutoCreateDatabaseUser = false,
    DatabaseGroups = new [] { "databaseGroups" },
    DatabaseUser = "databaseUser"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

redshiftIAMParametersProperty := &RedshiftIAMParametersProperty{
	RoleArn: jsii.String("roleArn"),

	// the properties below are optional
	AutoCreateDatabaseUser: jsii.Boolean(false),
	DatabaseGroups: []*string{
		jsii.String("databaseGroups"),
	},
	DatabaseUser: jsii.String("databaseUser"),
}

Properties ​

autoCreateDatabaseUseroptionalboolean | IResolvableauto_create_database_useroptionaltyping.Union[bool, IResolvable]autoCreateDatabaseUseroptionalBooleanAutoCreateDatabaseUseroptionalboolAutoCreateDatabaseUseroptionalinterface{} = false #
Automatically creates a database user.
notes

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.

databaseGroupsoptionalstring[]database_groupsoptionaltyping.List[str]databaseGroupsoptionalList<String>DatabaseGroupsoptionalstring[]DatabaseGroupsoptional*[]*string #
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 .

databaseUseroptionalstringdatabase_useroptionalstrdatabaseUseroptionalStringDatabaseUseroptionalstringDatabaseUseroptional*string #
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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*string required #
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.