Package software.amazon.awscdk.services.redshift

Interface CfnRedshiftIdcApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRedshiftIdcApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T17:00:02.459Z")
@Stability(Stable)
public interface CfnRedshiftIdcApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRedshiftIdcApplication.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnRedshiftIdcApplicationProps cfnRedshiftIdcApplicationProps = CfnRedshiftIdcApplicationProps.builder()
         .iamRoleArn("iamRoleArn")
         .idcDisplayName("idcDisplayName")
         .idcInstanceArn("idcInstanceArn")
         .redshiftIdcApplicationName("redshiftIdcApplicationName")
         // the properties below are optional
         .applicationType("applicationType")
         .authorizedTokenIssuerList(List.of(AuthorizedTokenIssuerProperty.builder()
                 .authorizedAudiencesList(List.of("authorizedAudiencesList"))
                 .trustedTokenIssuerArn("trustedTokenIssuerArn")
                 .build()))
         .identityNamespace("identityNamespace")
         .serviceIntegrations(List.of(ServiceIntegrationsUnionProperty.builder()
                 .lakeFormation(List.of(LakeFormationScopeUnionProperty.builder()
                         .lakeFormationQuery(LakeFormationQueryProperty.builder()
                                 .authorization("authorization")
                                 .build())
                         .build()))
                 .redshift(List.of(RedshiftScopeUnionProperty.builder()
                         .connect(ConnectProperty.builder()
                                 .authorization("authorization")
                                 .build())
                         .build()))
                 .s3AccessGrants(List.of(S3AccessGrantsScopeUnionProperty.builder()
                         .readWriteAccess(ReadWriteAccessProperty.builder()
                                 .authorization("authorization")
                                 .build())
                         .build()))
                 .build()))
         .ssoTagKeys(List.of("ssoTagKeys"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRedshiftIdcApplicationProps.Builder	A builder for CfnRedshiftIdcApplicationProps
static final class	CfnRedshiftIdcApplicationProps.Jsii$Proxy	An implementation for CfnRedshiftIdcApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnRedshiftIdcApplicationProps.Builder	builder()
default String	getApplicationType()	The type of application being created.
default Object	getAuthorizedTokenIssuerList()	The token issuer list for the Amazon Redshift IAM Identity Center application instance.
String	getIamRoleArn()	The IAM role ARN for the Amazon Redshift IAM Identity Center application instance.
String	getIdcDisplayName()	The display name for the Amazon Redshift IAM Identity Center application instance.
String	getIdcInstanceArn()	The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.
default String	getIdentityNamespace()	The namespace for the Amazon Redshift IAM Identity Center application instance.
String	getRedshiftIdcApplicationName()	The name of the Redshift application in IAM Identity Center.
default Object	getServiceIntegrations()	A collection of service integrations for the Redshift IAM Identity Center application.
default List<String>	getSsoTagKeys()	A list of tag keys that Redshift Identity Center applications copy to IAM Identity Center.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIamRoleArn

@Stability(Stable)
@NotNull
String getIamRoleArn()

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

getIdcDisplayName

@Stability(Stable)
@NotNull
String getIdcDisplayName()

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

getIdcInstanceArn

@Stability(Stable)
@NotNull
String getIdcInstanceArn()

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

getRedshiftIdcApplicationName

@Stability(Stable)
@NotNull
String getRedshiftIdcApplicationName()

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

getApplicationType

@Stability(Stable)
@Nullable
default String getApplicationType()

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

getAuthorizedTokenIssuerList

@Stability(Stable)
@Nullable
default Object getAuthorizedTokenIssuerList()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRedshiftIdcApplication.AuthorizedTokenIssuerProperty>

See Also:

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

getIdentityNamespace

@Stability(Stable)
@Nullable
default String getIdentityNamespace()

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

getServiceIntegrations

@Stability(Stable)
@Nullable
default Object getServiceIntegrations()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRedshiftIdcApplication.ServiceIntegrationsUnionProperty>

See Also:

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

getSsoTagKeys

@Stability(Stable)
@Nullable
default List<String> getSsoTagKeys()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnRedshiftIdcApplicationProps.Builder builder()

Returns:

a CfnRedshiftIdcApplicationProps.Builder of CfnRedshiftIdcApplicationProps