Package software.amazon.awscdk.services.qbusiness

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:03.135Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

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.qbusiness.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .displayName("displayName")
         // the properties below are optional
         .attachmentsConfiguration(AttachmentsConfigurationProperty.builder()
                 .attachmentsControlMode("attachmentsControlMode")
                 .build())
         .autoSubscriptionConfiguration(AutoSubscriptionConfigurationProperty.builder()
                 .autoSubscribe("autoSubscribe")
                 // the properties below are optional
                 .defaultSubscriptionType("defaultSubscriptionType")
                 .build())
         .clientIdsForOidc(List.of("clientIdsForOidc"))
         .description("description")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .iamIdentityProviderArn("iamIdentityProviderArn")
         .identityCenterInstanceArn("identityCenterInstanceArn")
         .identityType("identityType")
         .personalizationConfiguration(PersonalizationConfigurationProperty.builder()
                 .personalizationControlMode("personalizationControlMode")
                 .build())
         .qAppsConfiguration(QAppsConfigurationProperty.builder()
                 .qAppsControlMode("qAppsControlMode")
                 .build())
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default Object	getAttachmentsConfiguration()	Configuration information for the file upload during chat feature.
default Object	getAutoSubscriptionConfiguration()	Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
default List<String>	getClientIdsForOidc()
default String	getDescription()	A description for the Amazon Q Business application.
String	getDisplayName()	The name of the Amazon Q Business application.
default Object	getEncryptionConfiguration()	Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
default String	getIamIdentityProviderArn()	The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
default String	getIdentityCenterInstanceArn()	The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
default String	getIdentityType()	The authentication type being used by a Amazon Q Business application.
default Object	getPersonalizationConfiguration()	Configuration information about chat response personalization.
default Object	getQAppsConfiguration()	Configuration information about Amazon Q Apps.
default String	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
default List<CfnTag>	getTags()	A list of key-value pairs that identify or categorize your Amazon Q Business application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The name of the Amazon Q Business application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-displayname

getAttachmentsConfiguration

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

Configuration information for the file upload during chat feature.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-attachmentsconfiguration

getAutoSubscriptionConfiguration

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

Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-autosubscriptionconfiguration

getClientIdsForOidc

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-clientidsforoidc

getDescription

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

A description for the Amazon Q Business application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-description

getEncryptionConfiguration

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

Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.

Amazon Q Business doesn't support asymmetric keys.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-encryptionconfiguration

getIamIdentityProviderArn

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

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-iamidentityproviderarn

getIdentityCenterInstanceArn

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

The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

Required : Yes

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitycenterinstancearn

getIdentityType

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

The authentication type being used by a Amazon Q Business application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitytype

getPersonalizationConfiguration

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

Configuration information about chat response personalization.

For more information, see Personalizing chat responses .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-personalizationconfiguration

getQAppsConfiguration

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

Configuration information about Amazon Q Apps.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-qappsconfiguration

getRoleArn

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

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-rolearn

getTags

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

A list of key-value pairs that identify or categorize your Amazon Q Business application.

You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-tags

builder

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

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps