aws-cdk-lib.aws_quicksight.CfnDataSource.RedshiftParametersProperty

RedshiftParametersProperty Struct

The parameters for Amazon Redshift.

The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

Source

Generated code

Type last changed

v2.143.0 · 24 May 2024

Example

// 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 redshiftParametersProperty: quicksight.CfnDataSource.RedshiftParametersProperty = {
  database: 'database',

  // the properties below are optional
  clusterId: 'clusterId',
  host: 'host',
  iamParameters: {
    roleArn: 'roleArn',

    // the properties below are optional
    autoCreateDatabaseUser: false,
    databaseGroups: ['databaseGroups'],
    databaseUser: 'databaseUser',
  },
  identityCenterConfiguration: {
    enableIdentityPropagation: false,
  },
  port: 123,
};

# 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_parameters_property = quicksight.CfnDataSource.RedshiftParametersProperty(
    database="database",

    # the properties below are optional
    cluster_id="clusterId",
    host="host",
    iam_parameters=quicksight.CfnDataSource.RedshiftIAMParametersProperty(
        role_arn="roleArn",

        # the properties below are optional
        auto_create_database_user=False,
        database_groups=["databaseGroups"],
        database_user="databaseUser"
    ),
    identity_center_configuration=quicksight.CfnDataSource.IdentityCenterConfigurationProperty(
        enable_identity_propagation=False
    ),
    port=123
)

// 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.*;

RedshiftParametersProperty redshiftParametersProperty = RedshiftParametersProperty.builder()
        .database("database")

        // the properties below are optional
        .clusterId("clusterId")
        .host("host")
        .iamParameters(RedshiftIAMParametersProperty.builder()
                .roleArn("roleArn")

                // the properties below are optional
                .autoCreateDatabaseUser(false)
                .databaseGroups(List.of("databaseGroups"))
                .databaseUser("databaseUser")
                .build())
        .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                .enableIdentityPropagation(false)
                .build())
        .port(123)
        .build();

// 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 redshiftParametersProperty = new RedshiftParametersProperty {
    Database = "database",

    // the properties below are optional
    ClusterId = "clusterId",
    Host = "host",
    IamParameters = new RedshiftIAMParametersProperty {
        RoleArn = "roleArn",

        // the properties below are optional
        AutoCreateDatabaseUser = false,
        DatabaseGroups = new [] { "databaseGroups" },
        DatabaseUser = "databaseUser"
    },
    IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
        EnableIdentityPropagation = false
    },
    Port = 123
};

// 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"

redshiftParametersProperty := &RedshiftParametersProperty{
	Database: jsii.String("database"),

	// the properties below are optional
	ClusterId: jsii.String("clusterId"),
	Host: jsii.String("host"),
	IamParameters: &RedshiftIAMParametersProperty{
		RoleArn: jsii.String("roleArn"),

		// the properties below are optional
		AutoCreateDatabaseUser: jsii.Boolean(false),
		DatabaseGroups: []*string{
			jsii.String("databaseGroups"),
		},
		DatabaseUser: jsii.String("databaseUser"),
	},
	IdentityCenterConfiguration: &IdentityCenterConfigurationProperty{
		EnableIdentityPropagation: jsii.Boolean(false),
	},
	Port: jsii.Number(123),
}

Properties

clusterId?optionalstringcluster_id?optionalstrclusterId?optionalStringClusterId?optionalstringClusterId?optional*string#

Cluster ID.

This field can be blank if the Host and Port are provided.

databasestringdatabasestrdatabaseStringDatabasestringDatabase*stringrequired#

Database.

host?optionalstringhost?optionalstrhost?optionalStringHost?optionalstringHost?optional*string#

Host.

This field can be blank if ClusterId is provided.

iamParameters?optionalIResolvable | CfnDataSource.RedshiftIAMParametersPropertyiam_parameters?optionaltyping.Union[IResolvable, RedshiftIAMParametersProperty]iamParameters?optionalIResolvableIamParameters?optionalIResolvableIamParameters?optionalinterface{}#

An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.

This parameter can be used instead of DataSourceCredentials .

identityCenterConfiguration?optionalIResolvable | CfnDataSource.IdentityCenterConfigurationPropertyidentity_center_configuration?optionaltyping.Union[IResolvable, IdentityCenterConfigurationProperty]identityCenterConfiguration?optionalIResolvableIdentityCenterConfiguration?optionalIResolvableIdentityCenterConfiguration?optionalinterface{}#

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

port?optionalnumberport?optionalint | floatport?optionalNumberPort?optionaldoublePort?optional*float64= 0#

Port.

This field can be blank if the ClusterId is provided.