2.273.0

interface CfnRedshiftIdcApplicationProps

LanguageType name
.NETAmazon.CDK.AWS.Redshift.CfnRedshiftIdcApplicationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsredshift#CfnRedshiftIdcApplicationProps
Javasoftware.amazon.awscdk.services.redshift.CfnRedshiftIdcApplicationProps
Pythonaws_cdk.aws_redshift.CfnRedshiftIdcApplicationProps
TypeScript aws-cdk-lib » aws_redshift » CfnRedshiftIdcApplicationProps

Properties for defining a CfnRedshiftIdcApplication.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshift as redshift } from 'aws-cdk-lib';
const cfnRedshiftIdcApplicationProps: redshift.CfnRedshiftIdcApplicationProps = {
  iamRoleArn: 'iamRoleArn',
  idcDisplayName: 'idcDisplayName',
  idcInstanceArn: 'idcInstanceArn',
  redshiftIdcApplicationName: 'redshiftIdcApplicationName',

  // the properties below are optional
  applicationType: 'applicationType',
  authorizedTokenIssuerList: [{
    authorizedAudiencesList: ['authorizedAudiencesList'],
    trustedTokenIssuerArn: 'trustedTokenIssuerArn',
  }],
  identityNamespace: 'identityNamespace',
  serviceIntegrations: [{
    lakeFormation: [{
      lakeFormationQuery: {
        authorization: 'authorization',
      },
    }],
    redshift: [{
      connect: {
        authorization: 'authorization',
      },
    }],
    s3AccessGrants: [{
      readWriteAccess: {
        authorization: 'authorization',
      },
    }],
  }],
  ssoTagKeys: ['ssoTagKeys'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
iamRoleArnstringThe IAM role ARN for the Amazon Redshift IAM Identity Center application instance.
idcDisplayNamestringThe display name for the Amazon Redshift IAM Identity Center application instance.
idcInstanceArnstringThe Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.
redshiftIdcApplicationNamestringThe name of the Redshift application in IAM Identity Center.
applicationType?stringThe type of application being created.
authorizedTokenIssuerList?IResolvable | (IResolvable | AuthorizedTokenIssuerProperty)[]The token issuer list for the Amazon Redshift IAM Identity Center application instance.
identityNamespace?stringThe namespace for the Amazon Redshift IAM Identity Center application instance.
serviceIntegrations?IResolvable | (IResolvable | ServiceIntegrationsUnionProperty)[]A collection of service integrations for the Redshift IAM Identity Center application.
ssoTagKeys?string[]A list of tag keys that Redshift Identity Center applications copy to IAM Identity Center.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

iamRoleArn

Type: string

The IAM role ARN for the Amazon Redshift IAM Identity Center application instance.

It has the required permissions to be assumed and invoke the IDC Identity Center API.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-iamrolearn

idcDisplayName

Type: string

The display name for the Amazon Redshift IAM Identity Center application instance.

It appears in the console.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-idcdisplayname

idcInstanceArn

Type: string

The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-idcinstancearn

redshiftIdcApplicationName

Type: string

The name of the Redshift application in IAM Identity Center.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-redshiftidcapplicationname

applicationType?

Type: string (optional)

The type of application being created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-applicationtype

authorizedTokenIssuerList?

Type: IResolvable | (IResolvable | AuthorizedTokenIssuerProperty)[] (optional)

The token issuer list for the Amazon Redshift IAM Identity Center application instance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-authorizedtokenissuerlist

identityNamespace?

Type: string (optional)

The namespace for the Amazon Redshift IAM Identity Center application instance.

It determines which managed application verifies the connection token.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-identitynamespace

serviceIntegrations?

Type: IResolvable | (IResolvable | ServiceIntegrationsUnionProperty)[] (optional)

A collection of service integrations for the Redshift IAM Identity Center application.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-serviceintegrations

ssoTagKeys?

Type: string[] (optional)

A list of tag keys that Redshift Identity Center applications copy to IAM Identity Center.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-ssotagkeys

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-redshiftidcapplication.html#cfn-redshift-redshiftidcapplication-tags

← PreviousNext →