Class: Aws::QBusiness::Types::CreateApplicationRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::CreateApplicationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attachments_configuration ⇒ Types::AttachmentsConfiguration

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

• #client_ids_for_oidc ⇒ Array<String>

  The OIDC client ID for a Amazon Q Business application.

• #client_token ⇒ String

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

• #description ⇒ String

  A description for the Amazon Q Business application.

• #display_name ⇒ String

  A name for the Amazon Q Business application.

• #encryption_configuration ⇒ Types::EncryptionConfiguration

  The identifier of the KMS key that is used to encrypt your data.

• #iam_identity_provider_arn ⇒ String

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

• #identity_center_instance_arn ⇒ String

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

• #identity_type ⇒ String

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

• #personalization_configuration ⇒ Types::PersonalizationConfiguration

  Configuration information about chat response personalization.

• #q_apps_configuration ⇒ Types::QAppsConfiguration

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

• #quick_sight_configuration ⇒ Types::QuickSightConfiguration

  The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication.

• #role_arn ⇒ String

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

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#attachments_configuration ⇒ Types::AttachmentsConfiguration

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

Returns:

• (Types::AttachmentsConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_ids_for_oidc ⇒ Array<String>

The OIDC client ID for a Amazon Q Business application.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the Amazon Q Business application.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A name for the Amazon Q Business application.

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

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

Returns:

• (Types::EncryptionConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iam_identity_provider_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_instance_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#personalization_configuration ⇒ Types::PersonalizationConfiguration

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

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html

Returns:

• (Types::PersonalizationConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#q_apps_configuration ⇒ Types::QAppsConfiguration

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

Returns:

• (Types::QAppsConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#quick_sight_configuration ⇒ Types::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].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html

Returns:

• (Types::QuickSightConfiguration)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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.

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions

Returns:

• (String)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-qbusiness/types.rb', line 1647

class CreateApplicationRequest < Struct.new(
  :display_name,
  :role_arn,
  :identity_type,
  :iam_identity_provider_arn,
  :identity_center_instance_arn,
  :client_ids_for_oidc,
  :description,
  :encryption_configuration,
  :tags,
  :client_token,
  :attachments_configuration,
  :q_apps_configuration,
  :personalization_configuration,
  :quick_sight_configuration)
  SENSITIVE = []
  include Aws::Structure
end