Interface CreateApplicationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, QBusinessRequest.Builder, SdkBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateApplicationRequest

@Mutable
@NotThreadSafe
public static interface CreateApplicationRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>

Method Summary

Modifier and Type	Method	Description
default CreateApplicationRequest.Builder	attachmentsConfiguration(Consumer<AttachmentsConfiguration.Builder> attachmentsConfiguration)	An option to allow end users to upload files directly during chat.
CreateApplicationRequest.Builder	attachmentsConfiguration(AttachmentsConfiguration attachmentsConfiguration)	An option to allow end users to upload files directly during chat.
CreateApplicationRequest.Builder	clientIdsForOIDC(String... clientIdsForOIDC)	The OIDC client ID for a Amazon Q Business application.
CreateApplicationRequest.Builder	clientIdsForOIDC(Collection<String> clientIdsForOIDC)	The OIDC client ID for a Amazon Q Business application.
CreateApplicationRequest.Builder	clientToken(String clientToken)	A token that you provide to identify the request to create your Amazon Q Business application.
CreateApplicationRequest.Builder	description(String description)	A description for the Amazon Q Business application.
CreateApplicationRequest.Builder	displayName(String displayName)	A name for the Amazon Q Business application.
default CreateApplicationRequest.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	The identifier of the KMS key that is used to encrypt your data.
CreateApplicationRequest.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	The identifier of the KMS key that is used to encrypt your data.
CreateApplicationRequest.Builder	iamIdentityProviderArn(String iamIdentityProviderArn)	The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
CreateApplicationRequest.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.
CreateApplicationRequest.Builder	identityType(String identityType)	The authentication type being used by a Amazon Q Business application.
CreateApplicationRequest.Builder	identityType(IdentityType identityType)	The authentication type being used by a Amazon Q Business application.
CreateApplicationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateApplicationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateApplicationRequest.Builder	personalizationConfiguration(Consumer<PersonalizationConfiguration.Builder> personalizationConfiguration)	Configuration information about chat response personalization.
CreateApplicationRequest.Builder	personalizationConfiguration(PersonalizationConfiguration personalizationConfiguration)	Configuration information about chat response personalization.
default CreateApplicationRequest.Builder	qAppsConfiguration(Consumer<QAppsConfiguration.Builder> qAppsConfiguration)	An option to allow end users to create and use Amazon Q Apps in the web experience.
CreateApplicationRequest.Builder	qAppsConfiguration(QAppsConfiguration qAppsConfiguration)	An option to allow end users to create and use Amazon Q Apps in the web experience.
default CreateApplicationRequest.Builder	quickSightConfiguration(Consumer<QuickSightConfiguration.Builder> quickSightConfiguration)	The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication.
CreateApplicationRequest.Builder	quickSightConfiguration(QuickSightConfiguration quickSightConfiguration)	The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication.
CreateApplicationRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
CreateApplicationRequest.Builder	tags(Collection<Tag> tags)	A list of key-value pairs that identify or categorize your Amazon Q Business application.
CreateApplicationRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of key-value pairs that identify or categorize your Amazon Q Business application.
CreateApplicationRequest.Builder	tags(Tag... tags)	A list of key-value pairs that identify or categorize your Amazon Q Business application.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

displayName

CreateApplicationRequest.Builder displayName(String displayName)

A name for the Amazon Q Business application.

Parameters:

displayName - A name for the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

CreateApplicationRequest.Builder roleArn(String roleArn)

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.

Parameters:

roleArn - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityType

CreateApplicationRequest.Builder identityType(String identityType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IdentityType
• IdentityType

identityType

CreateApplicationRequest.Builder identityType(IdentityType identityType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IdentityType
• IdentityType

iamIdentityProviderArn

CreateApplicationRequest.Builder iamIdentityProviderArn(String iamIdentityProviderArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

identityCenterInstanceArn

CreateApplicationRequest.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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientIdsForOIDC

CreateApplicationRequest.Builder clientIdsForOIDC(Collection<String> clientIdsForOIDC)

The OIDC client ID for a Amazon Q Business application.

Parameters:

clientIdsForOIDC - The OIDC client ID for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientIdsForOIDC

CreateApplicationRequest.Builder clientIdsForOIDC(String... clientIdsForOIDC)

The OIDC client ID for a Amazon Q Business application.

Parameters:

clientIdsForOIDC - The OIDC client ID for a Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateApplicationRequest.Builder description(String description)

A description for the Amazon Q Business application.

Parameters:

description - A description for the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

CreateApplicationRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

Parameters:

encryptionConfiguration - The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionConfiguration

default CreateApplicationRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionConfiguration(EncryptionConfiguration)

tags

CreateApplicationRequest.Builder tags(Collection<Tag> 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. 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: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateApplicationRequest.Builder tags(Tag... 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. 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: _ . : / = + - @.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateApplicationRequest.Builder tags(Consumer<Tag.Builder>... 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: _ . : / = + - @.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

clientToken

CreateApplicationRequest.Builder clientToken(String clientToken)

A token that you provide to identify the request to create your Amazon Q Business application.

Parameters:

clientToken - A token that you provide to identify the request to create your Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachmentsConfiguration

CreateApplicationRequest.Builder attachmentsConfiguration(AttachmentsConfiguration attachmentsConfiguration)

An option to allow end users to upload files directly during chat.

Parameters:

attachmentsConfiguration - An option to allow end users to upload files directly during chat.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachmentsConfiguration

default CreateApplicationRequest.Builder attachmentsConfiguration(Consumer<AttachmentsConfiguration.Builder> attachmentsConfiguration)

An option to allow end users to upload files directly during chat.

This is a convenience method that creates an instance of the AttachmentsConfiguration.Builder avoiding the need to create one manually via AttachmentsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentsConfiguration(AttachmentsConfiguration).

Parameters:

attachmentsConfiguration - a consumer that will call methods on AttachmentsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• attachmentsConfiguration(AttachmentsConfiguration)

qAppsConfiguration

CreateApplicationRequest.Builder qAppsConfiguration(QAppsConfiguration qAppsConfiguration)

An option to allow end users to create and use Amazon Q Apps in the web experience.

Parameters:

qAppsConfiguration - An option to allow end users to create and use Amazon Q Apps in the web experience.

Returns:

Returns a reference to this object so that method calls can be chained together.

qAppsConfiguration

default CreateApplicationRequest.Builder qAppsConfiguration(Consumer<QAppsConfiguration.Builder> qAppsConfiguration)

An option to allow end users to create and use Amazon Q Apps in the web experience.

This is a convenience method that creates an instance of the QAppsConfiguration.Builder avoiding the need to create one manually via QAppsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to qAppsConfiguration(QAppsConfiguration).

Parameters:

qAppsConfiguration - a consumer that will call methods on QAppsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• qAppsConfiguration(QAppsConfiguration)

personalizationConfiguration

CreateApplicationRequest.Builder personalizationConfiguration(PersonalizationConfiguration personalizationConfiguration)

Configuration information about chat response personalization. For more information, see Personalizing chat responses

Parameters:

personalizationConfiguration - Configuration information about chat response personalization. For more information, see Personalizing chat responses

Returns:

Returns a reference to this object so that method calls can be chained together.

personalizationConfiguration

default CreateApplicationRequest.Builder personalizationConfiguration(Consumer<PersonalizationConfiguration.Builder> personalizationConfiguration)

Configuration information about chat response personalization. For more information, see Personalizing chat responses

This is a convenience method that creates an instance of the PersonalizationConfiguration.Builder avoiding the need to create one manually via PersonalizationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to personalizationConfiguration(PersonalizationConfiguration).

Parameters:

personalizationConfiguration - a consumer that will call methods on PersonalizationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• personalizationConfiguration(PersonalizationConfiguration)

quickSightConfiguration

CreateApplicationRequest.Builder quickSightConfiguration(QuickSightConfiguration quickSightConfiguration)

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

Parameters:

quickSightConfiguration - The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

Returns:

Returns a reference to this object so that method calls can be chained together.

quickSightConfiguration

default CreateApplicationRequest.Builder quickSightConfiguration(Consumer<QuickSightConfiguration.Builder> quickSightConfiguration)

The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.

This is a convenience method that creates an instance of the QuickSightConfiguration.Builder avoiding the need to create one manually via QuickSightConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quickSightConfiguration(QuickSightConfiguration).

Parameters:

quickSightConfiguration - a consumer that will call methods on QuickSightConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• quickSightConfiguration(QuickSightConfiguration)

overrideConfiguration

CreateApplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateApplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.