Class CfnDataSourcePropsMixin.RedshiftIAMParametersProperty

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

Inheritance

object

CfnDataSourcePropsMixin.RedshiftIAMParametersProperty

Implements

CfnDataSourcePropsMixin.IRedshiftIAMParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDataSourcePropsMixin.RedshiftIAMParametersProperty : CfnDataSourcePropsMixin.IRedshiftIAMParametersProperty

Syntax (vb)

Public Class CfnDataSourcePropsMixin.RedshiftIAMParametersProperty Implements CfnDataSourcePropsMixin.IRedshiftIAMParametersProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var redshiftIAMParametersProperty = new RedshiftIAMParametersProperty {
                 AutoCreateDatabaseUser = false,
                 DatabaseGroups = new [] { "databaseGroups" },
                 DatabaseUser = "databaseUser",
                 RoleArn = "roleArn"
             };

Synopsis

Constructors

RedshiftIAMParametersProperty()

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

Properties

AutoCreateDatabaseUser	Automatically creates a database user.
DatabaseGroups	A list of groups whose permissions will be granted to Quick Sight to access the cluster.
DatabaseUser	The user whose permissions and group memberships will be used by Quick Sight to access the cluster.
RoleArn	Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster.

Constructors

RedshiftIAMParametersProperty()

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

public RedshiftIAMParametersProperty()

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins;

             var redshiftIAMParametersProperty = new RedshiftIAMParametersProperty {
                 AutoCreateDatabaseUser = false,
                 DatabaseGroups = new [] { "databaseGroups" },
                 DatabaseUser = "databaseUser",
                 RoleArn = "roleArn"
             };

Properties

AutoCreateDatabaseUser

Automatically creates a database user.

public object? AutoCreateDatabaseUser { get; set; }

Property Value

object

Remarks

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.

Default: - false

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

Type union: either bool or IResolvable

DatabaseGroups

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

public string[]? DatabaseGroups { get; set; }

Property Value

string[]

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databasegroups

DatabaseUser

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

public string? DatabaseUser { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databaseuser

RoleArn

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

public string? RoleArn { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-rolearn

Implements

CfnDataSourcePropsMixin.IRedshiftIAMParametersProperty