Package software.amazon.awscdk.services.qbusiness

Class CfnApplication.Builder

java.lang.Object

software.amazon.awscdk.services.qbusiness.CfnApplication.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApplication>

Enclosing class:

CfnApplication

@Stability(Stable)
public static final class CfnApplication.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApplication>

A fluent builder for CfnApplication.

Method Summary

Modifier and Type	Method	Description
CfnApplication.Builder	attachmentsConfiguration(IResolvable attachmentsConfiguration)	Configuration information for the file upload during chat feature.
CfnApplication.Builder	attachmentsConfiguration(CfnApplication.AttachmentsConfigurationProperty attachmentsConfiguration)	Configuration information for the file upload during chat feature.
CfnApplication	build()
static CfnApplication.Builder	create(software.constructs.Construct scope, String id)
CfnApplication.Builder	description(String description)	A description for the Amazon Q Business application.
CfnApplication.Builder	displayName(String displayName)	The name of the Amazon Q Business application.
CfnApplication.Builder	encryptionConfiguration(IResolvable encryptionConfiguration)	Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
CfnApplication.Builder	encryptionConfiguration(CfnApplication.EncryptionConfigurationProperty encryptionConfiguration)	Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
CfnApplication.Builder	identityCenterInstanceArn(String identityCenterInstanceArn)	The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
CfnApplication.Builder	qAppsConfiguration(IResolvable qAppsConfiguration)	Configuration information about Amazon Q Apps.
CfnApplication.Builder	qAppsConfiguration(CfnApplication.QAppsConfigurationProperty qAppsConfiguration)	Configuration information about Amazon Q Apps.
CfnApplication.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
CfnApplication.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs that identify or categorize your Amazon Q Business application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnApplication.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnApplication.Builder.

displayName

@Stability(Stable)
public CfnApplication.Builder displayName(String displayName)

The name of the Amazon Q Business application.

Parameters:

displayName - The name of the Amazon Q Business application. This parameter is required.

Returns:

this

See Also:

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

attachmentsConfiguration

@Stability(Stable)
public CfnApplication.Builder attachmentsConfiguration(IResolvable attachmentsConfiguration)

Configuration information for the file upload during chat feature.

Parameters:

attachmentsConfiguration - Configuration information for the file upload during chat feature. This parameter is required.

Returns:

this

See Also:

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

attachmentsConfiguration

@Stability(Stable)
public CfnApplication.Builder attachmentsConfiguration(CfnApplication.AttachmentsConfigurationProperty attachmentsConfiguration)

Configuration information for the file upload during chat feature.

Parameters:

attachmentsConfiguration - Configuration information for the file upload during chat feature. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnApplication.Builder description(String description)

A description for the Amazon Q Business application.

Parameters:

description - A description for the Amazon Q Business application. This parameter is required.

Returns:

this

See Also:

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

encryptionConfiguration

@Stability(Stable)
public CfnApplication.Builder encryptionConfiguration(IResolvable encryptionConfiguration)

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.

Parameters:

encryptionConfiguration - Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. This parameter is required.

Returns:

this

See Also:

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

encryptionConfiguration

@Stability(Stable)
public CfnApplication.Builder encryptionConfiguration(CfnApplication.EncryptionConfigurationProperty encryptionConfiguration)

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.

Parameters:

encryptionConfiguration - Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. This parameter is required.

Returns:

this

See Also:

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

identityCenterInstanceArn

@Stability(Stable)
public CfnApplication.Builder identityCenterInstanceArn(String identityCenterInstanceArn)

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

Parameters:

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

Returns:

this

See Also:

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

qAppsConfiguration

@Stability(Stable)
public CfnApplication.Builder qAppsConfiguration(IResolvable qAppsConfiguration)

Configuration information about Amazon Q Apps.

(preview feature)

Parameters:

qAppsConfiguration - Configuration information about Amazon Q Apps. This parameter is required.

Returns:

this

See Also:

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

qAppsConfiguration

@Stability(Stable)
public CfnApplication.Builder qAppsConfiguration(CfnApplication.QAppsConfigurationProperty qAppsConfiguration)

Configuration information about Amazon Q Apps.

(preview feature)

Parameters:

qAppsConfiguration - Configuration information about Amazon Q Apps. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnApplication.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnApplication.Builder tags(List<? extends CfnTag> tags)

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: _ . : / = + -

Parameters:

tags - A list of key-value pairs that identify or categorize your Amazon Q Business application. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnApplication build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnApplication>

Returns:

a newly built instance of CfnApplication.