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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachments_configurationTypes::AttachmentsConfiguration

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



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_oidcArray<String>

The OIDC client ID for a Amazon Q Business application.

Returns:

  • (Array<String>)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_tokenString

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)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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

#descriptionString

A description for the Amazon Q Business application.

Returns:

  • (String)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_nameString

A name for the Amazon Q Business application.

Returns:

  • (String)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_configurationTypes::EncryptionConfiguration

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



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_arnString

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

Returns:

  • (String)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_arnString

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)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_typeString

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

Returns:

  • (String)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_configurationTypes::PersonalizationConfiguration

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



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_configurationTypes::QAppsConfiguration

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



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_configurationTypes::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.



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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_arnString

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:

  • (String)


1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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

#tagsArray<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:



1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1714

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