pub struct CreateApplicationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateApplication
.
Creates an Amazon Q Business application.
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration
is enabled in the request. For more information, see Using service-linked roles for Q Apps.
When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
Implementations§
Source§impl CreateApplicationFluentBuilder
impl CreateApplicationFluentBuilder
Sourcepub fn as_input(&self) -> &CreateApplicationInputBuilder
pub fn as_input(&self) -> &CreateApplicationInputBuilder
Access the CreateApplication as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateApplicationOutput, SdkError<CreateApplicationError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateApplicationOutput, SdkError<CreateApplicationError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateApplicationOutput, CreateApplicationError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateApplicationOutput, CreateApplicationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
A name for the Amazon Q Business application.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
A name for the Amazon Q Business application.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
A name for the Amazon Q Business application.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<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.
Sourcepub fn identity_type(self, input: IdentityType) -> Self
pub fn identity_type(self, input: IdentityType) -> Self
The authentication type being used by a Amazon Q Business application.
Sourcepub fn set_identity_type(self, input: Option<IdentityType>) -> Self
pub fn set_identity_type(self, input: Option<IdentityType>) -> Self
The authentication type being used by a Amazon Q Business application.
Sourcepub fn get_identity_type(&self) -> &Option<IdentityType>
pub fn get_identity_type(&self) -> &Option<IdentityType>
The authentication type being used by a Amazon Q Business application.
Sourcepub fn iam_identity_provider_arn(self, input: impl Into<String>) -> Self
pub fn iam_identity_provider_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
Sourcepub fn set_iam_identity_provider_arn(self, input: Option<String>) -> Self
pub fn set_iam_identity_provider_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
Sourcepub fn get_iam_identity_provider_arn(&self) -> &Option<String>
pub fn get_iam_identity_provider_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
Sourcepub fn identity_center_instance_arn(self, input: impl Into<String>) -> Self
pub fn identity_center_instance_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
Sourcepub fn set_identity_center_instance_arn(self, input: Option<String>) -> Self
pub fn set_identity_center_instance_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
Sourcepub fn get_identity_center_instance_arn(&self) -> &Option<String>
pub fn get_identity_center_instance_arn(&self) -> &Option<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.
Sourcepub fn client_ids_for_oidc(self, input: impl Into<String>) -> Self
pub fn client_ids_for_oidc(self, input: impl Into<String>) -> Self
Appends an item to clientIdsForOIDC
.
To override the contents of this collection use set_client_ids_for_oidc
.
The OIDC client ID for a Amazon Q Business application.
Sourcepub fn set_client_ids_for_oidc(self, input: Option<Vec<String>>) -> Self
pub fn set_client_ids_for_oidc(self, input: Option<Vec<String>>) -> Self
The OIDC client ID for a Amazon Q Business application.
Sourcepub fn get_client_ids_for_oidc(&self) -> &Option<Vec<String>>
pub fn get_client_ids_for_oidc(&self) -> &Option<Vec<String>>
The OIDC client ID for a Amazon Q Business application.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the Amazon Q Business application.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the Amazon Q Business application.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the Amazon Q Business application.
Sourcepub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
pub fn encryption_configuration(self, input: EncryptionConfiguration) -> Self
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
Sourcepub fn set_encryption_configuration(
self,
input: Option<EncryptionConfiguration>,
) -> Self
pub fn set_encryption_configuration( self, input: Option<EncryptionConfiguration>, ) -> Self
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
Sourcepub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
pub fn get_encryption_configuration(&self) -> &Option<EncryptionConfiguration>
The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
Appends an item to tags
.
To override the contents of this collection use set_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: _ . : / = + - @.
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: _ . : / = + - @.
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: _ . : / = + - @.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that you provide to identify the request to create your Amazon Q Business application.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that you provide to identify the request to create your Amazon Q Business application.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that you provide to identify the request to create your Amazon Q Business application.
Sourcepub fn attachments_configuration(self, input: AttachmentsConfiguration) -> Self
pub fn attachments_configuration(self, input: AttachmentsConfiguration) -> Self
An option to allow end users to upload files directly during chat.
Sourcepub fn set_attachments_configuration(
self,
input: Option<AttachmentsConfiguration>,
) -> Self
pub fn set_attachments_configuration( self, input: Option<AttachmentsConfiguration>, ) -> Self
An option to allow end users to upload files directly during chat.
Sourcepub fn get_attachments_configuration(&self) -> &Option<AttachmentsConfiguration>
pub fn get_attachments_configuration(&self) -> &Option<AttachmentsConfiguration>
An option to allow end users to upload files directly during chat.
Sourcepub fn q_apps_configuration(self, input: QAppsConfiguration) -> Self
pub fn q_apps_configuration(self, input: QAppsConfiguration) -> Self
An option to allow end users to create and use Amazon Q Apps in the web experience.
Sourcepub fn set_q_apps_configuration(self, input: Option<QAppsConfiguration>) -> Self
pub fn set_q_apps_configuration(self, input: Option<QAppsConfiguration>) -> Self
An option to allow end users to create and use Amazon Q Apps in the web experience.
Sourcepub fn get_q_apps_configuration(&self) -> &Option<QAppsConfiguration>
pub fn get_q_apps_configuration(&self) -> &Option<QAppsConfiguration>
An option to allow end users to create and use Amazon Q Apps in the web experience.
Sourcepub fn personalization_configuration(
self,
input: PersonalizationConfiguration,
) -> Self
pub fn personalization_configuration( self, input: PersonalizationConfiguration, ) -> Self
Configuration information about chat response personalization. For more information, see Personalizing chat responses
Sourcepub fn set_personalization_configuration(
self,
input: Option<PersonalizationConfiguration>,
) -> Self
pub fn set_personalization_configuration( self, input: Option<PersonalizationConfiguration>, ) -> Self
Configuration information about chat response personalization. For more information, see Personalizing chat responses
Sourcepub fn get_personalization_configuration(
&self,
) -> &Option<PersonalizationConfiguration>
pub fn get_personalization_configuration( &self, ) -> &Option<PersonalizationConfiguration>
Configuration information about chat response personalization. For more information, see Personalizing chat responses
Sourcepub fn quick_sight_configuration(self, input: QuickSightConfiguration) -> Self
pub fn quick_sight_configuration(self, input: QuickSightConfiguration) -> Self
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.
Sourcepub fn set_quick_sight_configuration(
self,
input: Option<QuickSightConfiguration>,
) -> Self
pub fn set_quick_sight_configuration( self, input: Option<QuickSightConfiguration>, ) -> Self
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.
Sourcepub fn get_quick_sight_configuration(&self) -> &Option<QuickSightConfiguration>
pub fn get_quick_sight_configuration(&self) -> &Option<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.
Trait Implementations§
Source§impl Clone for CreateApplicationFluentBuilder
impl Clone for CreateApplicationFluentBuilder
Source§fn clone(&self) -> CreateApplicationFluentBuilder
fn clone(&self) -> CreateApplicationFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateApplicationFluentBuilder
impl !RefUnwindSafe for CreateApplicationFluentBuilder
impl Send for CreateApplicationFluentBuilder
impl Sync for CreateApplicationFluentBuilder
impl Unpin for CreateApplicationFluentBuilder
impl !UnwindSafe for CreateApplicationFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);