Class: Aws::QBusiness::Types::CreateDataAccessorRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:display_name]

Instance Attribute Summary collapse

Instance Attribute Details

#action_configurations ⇒ Array<Types::ActionConfiguration>

A list of action configurations specifying the allowed actions and any associated filters.

Returns:



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#application_id ⇒ String

The unique identifier of the Amazon Q Business application.

Returns:

  • (String) 


2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#authentication_detail ⇒ Types::DataAccessorAuthenticationDetail

The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.

Returns:



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier you provide to ensure idempotency of the request.

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

Returns:

  • (String) 


2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_name ⇒ String

A friendly name for the data accessor.

Returns:

  • (String) 


2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#principal ⇒ String

The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.

Returns:

  • (String) 


2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to associate with the data accessor.

Returns:



2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2179

class CreateDataAccessorRequest < Struct.new(
  :application_id,
  :principal,
  :action_configurations,
  :client_token,
  :display_name,
  :authentication_detail,
  :tags)
  SENSITIVE = [:display_name]
  include Aws::Structure
end