// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct RegisterUserInput {
/// <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
pub identity_type: ::std::option::Option<crate::types::IdentityType>,
/// <p>The email address of the user that you want to register.</p>
pub email: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Quick Sight role for the user. The user role can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>READER</code>: A user who has read-only access to dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p></li>
/// <li>
/// <p><code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight settings.</p></li>
/// <li>
/// <p><code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p></li>
/// <li>
/// <p><code>RESTRICTED_READER</code>: This role isn't currently available for use.</p></li>
/// <li>
/// <p><code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p></li>
/// </ul>
pub user_role: ::std::option::Option<crate::types::UserRole>,
/// <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight.</p>
pub iam_arn: ::std::option::Option<::std::string::String>,
/// <p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"> <code>assume-role</code> </a> in the <i>CLI Reference.</i></p>
pub session_name: ::std::option::Option<::std::string::String>,
/// <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
pub aws_account_id: ::std::option::Option<::std::string::String>,
/// <p>The namespace. Currently, you should set this to <code>default</code>.</p>
pub namespace: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Quick Sight user name that you want to create for the user you are registering.</p>
pub user_name: ::std::option::Option<::std::string::String>,
/// <p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p>
/// <ul>
/// <li>
/// <p>Create and update data sources</p></li>
/// <li>
/// <p>Create and update datasets</p></li>
/// <li>
/// <p>Create and update email reports</p></li>
/// <li>
/// <p>Subscribe to email reports</p></li>
/// </ul>
/// <p>To add custom permissions to an existing user, use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> instead.</p>
/// <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Quick Sight user.</p>
/// <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
/// <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
pub custom_permissions_name: ::std::option::Option<::std::string::String>,
/// <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
/// <ul>
/// <li>
/// <p><code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p></li>
/// <li>
/// <p><code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p></li>
/// </ul>
pub external_login_federation_provider_type: ::std::option::Option<::std::string::String>,
/// <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
pub custom_federation_provider_url: ::std::option::Option<::std::string::String>,
/// <p>The identity ID for a user in the external login provider.</p>
pub external_login_id: ::std::option::Option<::std::string::String>,
/// <p>The tags to associate with the user.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl RegisterUserInput {
/// <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
pub fn identity_type(&self) -> ::std::option::Option<&crate::types::IdentityType> {
self.identity_type.as_ref()
}
/// <p>The email address of the user that you want to register.</p>
pub fn email(&self) -> ::std::option::Option<&str> {
self.email.as_deref()
}
/// <p>The Amazon Quick Sight role for the user. The user role can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>READER</code>: A user who has read-only access to dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p></li>
/// <li>
/// <p><code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight settings.</p></li>
/// <li>
/// <p><code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p></li>
/// <li>
/// <p><code>RESTRICTED_READER</code>: This role isn't currently available for use.</p></li>
/// <li>
/// <p><code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p></li>
/// </ul>
pub fn user_role(&self) -> ::std::option::Option<&crate::types::UserRole> {
self.user_role.as_ref()
}
/// <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight.</p>
pub fn iam_arn(&self) -> ::std::option::Option<&str> {
self.iam_arn.as_deref()
}
/// <p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"> <code>assume-role</code> </a> in the <i>CLI Reference.</i></p>
pub fn session_name(&self) -> ::std::option::Option<&str> {
self.session_name.as_deref()
}
/// <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
self.aws_account_id.as_deref()
}
/// <p>The namespace. Currently, you should set this to <code>default</code>.</p>
pub fn namespace(&self) -> ::std::option::Option<&str> {
self.namespace.as_deref()
}
/// <p>The Amazon Quick Sight user name that you want to create for the user you are registering.</p>
pub fn user_name(&self) -> ::std::option::Option<&str> {
self.user_name.as_deref()
}
/// <p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p>
/// <ul>
/// <li>
/// <p>Create and update data sources</p></li>
/// <li>
/// <p>Create and update datasets</p></li>
/// <li>
/// <p>Create and update email reports</p></li>
/// <li>
/// <p>Subscribe to email reports</p></li>
/// </ul>
/// <p>To add custom permissions to an existing user, use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> instead.</p>
/// <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Quick Sight user.</p>
/// <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
/// <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
pub fn custom_permissions_name(&self) -> ::std::option::Option<&str> {
self.custom_permissions_name.as_deref()
}
/// <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
/// <ul>
/// <li>
/// <p><code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p></li>
/// <li>
/// <p><code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p></li>
/// </ul>
pub fn external_login_federation_provider_type(&self) -> ::std::option::Option<&str> {
self.external_login_federation_provider_type.as_deref()
}
/// <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
pub fn custom_federation_provider_url(&self) -> ::std::option::Option<&str> {
self.custom_federation_provider_url.as_deref()
}
/// <p>The identity ID for a user in the external login provider.</p>
pub fn external_login_id(&self) -> ::std::option::Option<&str> {
self.external_login_id.as_deref()
}
/// <p>The tags to associate with the user.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
}
impl RegisterUserInput {
/// Creates a new builder-style object to manufacture [`RegisterUserInput`](crate::operation::register_user::RegisterUserInput).
pub fn builder() -> crate::operation::register_user::builders::RegisterUserInputBuilder {
crate::operation::register_user::builders::RegisterUserInputBuilder::default()
}
}
/// A builder for [`RegisterUserInput`](crate::operation::register_user::RegisterUserInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct RegisterUserInputBuilder {
pub(crate) identity_type: ::std::option::Option<crate::types::IdentityType>,
pub(crate) email: ::std::option::Option<::std::string::String>,
pub(crate) user_role: ::std::option::Option<crate::types::UserRole>,
pub(crate) iam_arn: ::std::option::Option<::std::string::String>,
pub(crate) session_name: ::std::option::Option<::std::string::String>,
pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
pub(crate) namespace: ::std::option::Option<::std::string::String>,
pub(crate) user_name: ::std::option::Option<::std::string::String>,
pub(crate) custom_permissions_name: ::std::option::Option<::std::string::String>,
pub(crate) external_login_federation_provider_type: ::std::option::Option<::std::string::String>,
pub(crate) custom_federation_provider_url: ::std::option::Option<::std::string::String>,
pub(crate) external_login_id: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl RegisterUserInputBuilder {
/// <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
/// This field is required.
pub fn identity_type(mut self, input: crate::types::IdentityType) -> Self {
self.identity_type = ::std::option::Option::Some(input);
self
}
/// <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
pub fn set_identity_type(mut self, input: ::std::option::Option<crate::types::IdentityType>) -> Self {
self.identity_type = input;
self
}
/// <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
pub fn get_identity_type(&self) -> &::std::option::Option<crate::types::IdentityType> {
&self.identity_type
}
/// <p>The email address of the user that you want to register.</p>
/// This field is required.
pub fn email(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.email = ::std::option::Option::Some(input.into());
self
}
/// <p>The email address of the user that you want to register.</p>
pub fn set_email(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.email = input;
self
}
/// <p>The email address of the user that you want to register.</p>
pub fn get_email(&self) -> &::std::option::Option<::std::string::String> {
&self.email
}
/// <p>The Amazon Quick Sight role for the user. The user role can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>READER</code>: A user who has read-only access to dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p></li>
/// <li>
/// <p><code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight settings.</p></li>
/// <li>
/// <p><code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p></li>
/// <li>
/// <p><code>RESTRICTED_READER</code>: This role isn't currently available for use.</p></li>
/// <li>
/// <p><code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p></li>
/// </ul>
/// This field is required.
pub fn user_role(mut self, input: crate::types::UserRole) -> Self {
self.user_role = ::std::option::Option::Some(input);
self
}
/// <p>The Amazon Quick Sight role for the user. The user role can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>READER</code>: A user who has read-only access to dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p></li>
/// <li>
/// <p><code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight settings.</p></li>
/// <li>
/// <p><code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p></li>
/// <li>
/// <p><code>RESTRICTED_READER</code>: This role isn't currently available for use.</p></li>
/// <li>
/// <p><code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p></li>
/// </ul>
pub fn set_user_role(mut self, input: ::std::option::Option<crate::types::UserRole>) -> Self {
self.user_role = input;
self
}
/// <p>The Amazon Quick Sight role for the user. The user role can be one of the following:</p>
/// <ul>
/// <li>
/// <p><code>READER</code>: A user who has read-only access to dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p></li>
/// <li>
/// <p><code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight settings.</p></li>
/// <li>
/// <p><code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p></li>
/// <li>
/// <p><code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p></li>
/// <li>
/// <p><code>RESTRICTED_READER</code>: This role isn't currently available for use.</p></li>
/// <li>
/// <p><code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p></li>
/// </ul>
pub fn get_user_role(&self) -> &::std::option::Option<crate::types::UserRole> {
&self.user_role
}
/// <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight.</p>
pub fn iam_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.iam_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight.</p>
pub fn set_iam_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.iam_arn = input;
self
}
/// <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight.</p>
pub fn get_iam_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.iam_arn
}
/// <p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"> <code>assume-role</code> </a> in the <i>CLI Reference.</i></p>
pub fn session_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.session_name = ::std::option::Option::Some(input.into());
self
}
/// <p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"> <code>assume-role</code> </a> in the <i>CLI Reference.</i></p>
pub fn set_session_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.session_name = input;
self
}
/// <p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon Quick Sight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"> <code>assume-role</code> </a> in the <i>CLI Reference.</i></p>
pub fn get_session_name(&self) -> &::std::option::Option<::std::string::String> {
&self.session_name
}
/// <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
/// This field is required.
pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.aws_account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.aws_account_id = input;
self
}
/// <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.aws_account_id
}
/// <p>The namespace. Currently, you should set this to <code>default</code>.</p>
/// This field is required.
pub fn namespace(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.namespace = ::std::option::Option::Some(input.into());
self
}
/// <p>The namespace. Currently, you should set this to <code>default</code>.</p>
pub fn set_namespace(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.namespace = input;
self
}
/// <p>The namespace. Currently, you should set this to <code>default</code>.</p>
pub fn get_namespace(&self) -> &::std::option::Option<::std::string::String> {
&self.namespace
}
/// <p>The Amazon Quick Sight user name that you want to create for the user you are registering.</p>
pub fn user_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.user_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Quick Sight user name that you want to create for the user you are registering.</p>
pub fn set_user_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.user_name = input;
self
}
/// <p>The Amazon Quick Sight user name that you want to create for the user you are registering.</p>
pub fn get_user_name(&self) -> &::std::option::Option<::std::string::String> {
&self.user_name
}
/// <p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p>
/// <ul>
/// <li>
/// <p>Create and update data sources</p></li>
/// <li>
/// <p>Create and update datasets</p></li>
/// <li>
/// <p>Create and update email reports</p></li>
/// <li>
/// <p>Subscribe to email reports</p></li>
/// </ul>
/// <p>To add custom permissions to an existing user, use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> instead.</p>
/// <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Quick Sight user.</p>
/// <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
/// <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
pub fn custom_permissions_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.custom_permissions_name = ::std::option::Option::Some(input.into());
self
}
/// <p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p>
/// <ul>
/// <li>
/// <p>Create and update data sources</p></li>
/// <li>
/// <p>Create and update datasets</p></li>
/// <li>
/// <p>Create and update email reports</p></li>
/// <li>
/// <p>Subscribe to email reports</p></li>
/// </ul>
/// <p>To add custom permissions to an existing user, use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> instead.</p>
/// <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Quick Sight user.</p>
/// <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
/// <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
pub fn set_custom_permissions_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.custom_permissions_name = input;
self
}
/// <p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p>
/// <ul>
/// <li>
/// <p>Create and update data sources</p></li>
/// <li>
/// <p>Create and update datasets</p></li>
/// <li>
/// <p>Create and update email reports</p></li>
/// <li>
/// <p>Subscribe to email reports</p></li>
/// </ul>
/// <p>To add custom permissions to an existing user, use <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a> </code> instead.</p>
/// <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Quick Sight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a Quick Sight user.</p>
/// <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Quick Sight users to one of the default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
/// <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
pub fn get_custom_permissions_name(&self) -> &::std::option::Option<::std::string::String> {
&self.custom_permissions_name
}
/// <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
/// <ul>
/// <li>
/// <p><code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p></li>
/// <li>
/// <p><code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p></li>
/// </ul>
pub fn external_login_federation_provider_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.external_login_federation_provider_type = ::std::option::Option::Some(input.into());
self
}
/// <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
/// <ul>
/// <li>
/// <p><code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p></li>
/// <li>
/// <p><code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p></li>
/// </ul>
pub fn set_external_login_federation_provider_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.external_login_federation_provider_type = input;
self
}
/// <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
/// <ul>
/// <li>
/// <p><code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p></li>
/// <li>
/// <p><code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p></li>
/// </ul>
pub fn get_external_login_federation_provider_type(&self) -> &::std::option::Option<::std::string::String> {
&self.external_login_federation_provider_type
}
/// <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
pub fn custom_federation_provider_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.custom_federation_provider_url = ::std::option::Option::Some(input.into());
self
}
/// <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
pub fn set_custom_federation_provider_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.custom_federation_provider_url = input;
self
}
/// <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
pub fn get_custom_federation_provider_url(&self) -> &::std::option::Option<::std::string::String> {
&self.custom_federation_provider_url
}
/// <p>The identity ID for a user in the external login provider.</p>
pub fn external_login_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.external_login_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identity ID for a user in the external login provider.</p>
pub fn set_external_login_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.external_login_id = input;
self
}
/// <p>The identity ID for a user in the external login provider.</p>
pub fn get_external_login_id(&self) -> &::std::option::Option<::std::string::String> {
&self.external_login_id
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags to associate with the user.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>The tags to associate with the user.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>The tags to associate with the user.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// Consumes the builder and constructs a [`RegisterUserInput`](crate::operation::register_user::RegisterUserInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::register_user::RegisterUserInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::register_user::RegisterUserInput {
identity_type: self.identity_type,
email: self.email,
user_role: self.user_role,
iam_arn: self.iam_arn,
session_name: self.session_name,
aws_account_id: self.aws_account_id,
namespace: self.namespace,
user_name: self.user_name,
custom_permissions_name: self.custom_permissions_name,
external_login_federation_provider_type: self.external_login_federation_provider_type,
custom_federation_provider_url: self.custom_federation_provider_url,
external_login_id: self.external_login_id,
tags: self.tags,
})
}
}