Struct aws_sdk_cognitoidentityprovider::operation::create_user_pool_client::builders::CreateUserPoolClientInputBuilder
source · #[non_exhaustive]pub struct CreateUserPoolClientInputBuilder { /* private fields */ }
Expand description
A builder for CreateUserPoolClientInput
.
Implementations§
source§impl CreateUserPoolClientInputBuilder
impl CreateUserPoolClientInputBuilder
sourcepub fn user_pool_id(self, input: impl Into<String>) -> Self
pub fn user_pool_id(self, input: impl Into<String>) -> Self
The user pool ID for the user pool where you want to create a user pool client.
This field is required.sourcepub fn set_user_pool_id(self, input: Option<String>) -> Self
pub fn set_user_pool_id(self, input: Option<String>) -> Self
The user pool ID for the user pool where you want to create a user pool client.
sourcepub fn get_user_pool_id(&self) -> &Option<String>
pub fn get_user_pool_id(&self) -> &Option<String>
The user pool ID for the user pool where you want to create a user pool client.
sourcepub fn client_name(self, input: impl Into<String>) -> Self
pub fn client_name(self, input: impl Into<String>) -> Self
The client name for the user pool client you would like to create.
This field is required.sourcepub fn set_client_name(self, input: Option<String>) -> Self
pub fn set_client_name(self, input: Option<String>) -> Self
The client name for the user pool client you would like to create.
sourcepub fn get_client_name(&self) -> &Option<String>
pub fn get_client_name(&self) -> &Option<String>
The client name for the user pool client you would like to create.
sourcepub fn generate_secret(self, input: bool) -> Self
pub fn generate_secret(self, input: bool) -> Self
Boolean to specify whether you want to generate a secret for the user pool client being created.
sourcepub fn set_generate_secret(self, input: Option<bool>) -> Self
pub fn set_generate_secret(self, input: Option<bool>) -> Self
Boolean to specify whether you want to generate a secret for the user pool client being created.
sourcepub fn get_generate_secret(&self) -> &Option<bool>
pub fn get_generate_secret(&self) -> &Option<bool>
Boolean to specify whether you want to generate a secret for the user pool client being created.
sourcepub fn refresh_token_validity(self, input: i32) -> Self
pub fn refresh_token_validity(self, input: i32) -> Self
The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and TokenValidityUnits
as days
, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
sourcepub fn set_refresh_token_validity(self, input: Option<i32>) -> Self
pub fn set_refresh_token_validity(self, input: Option<i32>) -> Self
The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and TokenValidityUnits
as days
, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
sourcepub fn get_refresh_token_validity(&self) -> &Option<i32>
pub fn get_refresh_token_validity(&self) -> &Option<i32>
The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and TokenValidityUnits
as days
, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
sourcepub fn access_token_validity(self, input: i32) -> Self
pub fn access_token_validity(self, input: i32) -> Self
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and TokenValidityUnits
to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
sourcepub fn set_access_token_validity(self, input: Option<i32>) -> Self
pub fn set_access_token_validity(self, input: Option<i32>) -> Self
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and TokenValidityUnits
to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
sourcepub fn get_access_token_validity(&self) -> &Option<i32>
pub fn get_access_token_validity(&self) -> &Option<i32>
The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and TokenValidityUnits
to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
sourcepub fn id_token_validity(self, input: i32) -> Self
pub fn id_token_validity(self, input: i32) -> Self
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and TokenValidityUnits
as hours
, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
sourcepub fn set_id_token_validity(self, input: Option<i32>) -> Self
pub fn set_id_token_validity(self, input: Option<i32>) -> Self
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and TokenValidityUnits
as hours
, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
sourcepub fn get_id_token_validity(&self) -> &Option<i32>
pub fn get_id_token_validity(&self) -> &Option<i32>
The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and TokenValidityUnits
as hours
, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity
in an API request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
sourcepub fn token_validity_units(self, input: TokenValidityUnitsType) -> Self
pub fn token_validity_units(self, input: TokenValidityUnitsType) -> Self
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
sourcepub fn set_token_validity_units(
self,
input: Option<TokenValidityUnitsType>,
) -> Self
pub fn set_token_validity_units( self, input: Option<TokenValidityUnitsType>, ) -> Self
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
sourcepub fn get_token_validity_units(&self) -> &Option<TokenValidityUnitsType>
pub fn get_token_validity_units(&self) -> &Option<TokenValidityUnitsType>
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
sourcepub fn read_attributes(self, input: impl Into<String>) -> Self
pub fn read_attributes(self, input: impl Into<String>) -> Self
Appends an item to read_attributes
.
To override the contents of this collection use set_read_attributes
.
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes
for your app client, your app can read the values of email_verified
, phone_number_verified
, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
sourcepub fn set_read_attributes(self, input: Option<Vec<String>>) -> Self
pub fn set_read_attributes(self, input: Option<Vec<String>>) -> Self
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes
for your app client, your app can read the values of email_verified
, phone_number_verified
, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
sourcepub fn get_read_attributes(&self) -> &Option<Vec<String>>
pub fn get_read_attributes(&self) -> &Option<Vec<String>>
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes
for your app client, your app can read the values of email_verified
, phone_number_verified
, and the Standard attributes of your user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes
in the API response if you have specified your own custom set of read attributes.
sourcepub fn write_attributes(self, input: impl Into<String>) -> Self
pub fn write_attributes(self, input: impl Into<String>) -> Self
Appends an item to write_attributes
.
To override the contents of this collection use set_write_attributes
.
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name
to the new value.
When you don't specify the WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes
doesn't return any information. Amazon Cognito only populates WriteAttributes
in the API response if you have specified your own custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
sourcepub fn set_write_attributes(self, input: Option<Vec<String>>) -> Self
pub fn set_write_attributes(self, input: Option<Vec<String>>) -> Self
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name
to the new value.
When you don't specify the WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes
doesn't return any information. Amazon Cognito only populates WriteAttributes
in the API response if you have specified your own custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
sourcepub fn get_write_attributes(&self) -> &Option<Vec<String>>
pub fn get_write_attributes(&self) -> &Option<Vec<String>>
The list of user attributes that you want your app client to have write access to. After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list. An example of this kind of activity is when you present your user with a form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name
to the new value.
When you don't specify the WriteAttributes
for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes
doesn't return any information. Amazon Cognito only populates WriteAttributes
in the API response if you have specified your own custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
sourcepub fn explicit_auth_flows(self, input: ExplicitAuthFlowsType) -> Self
pub fn explicit_auth_flows(self, input: ExplicitAuthFlowsType) -> Self
Appends an item to explicit_auth_flows
.
To override the contents of this collection use set_explicit_auth_flows
.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows
, your user client supports ALLOW_REFRESH_TOKEN_AUTH
, ALLOW_USER_SRP_AUTH
, and ALLOW_CUSTOM_AUTH
.
Valid values include:
-
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. -
ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication. -
ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. -
ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication. -
ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH
, CUSTOM_AUTH_FLOW_ONLY
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
, like ALLOW_USER_SRP_AUTH
.
sourcepub fn set_explicit_auth_flows(
self,
input: Option<Vec<ExplicitAuthFlowsType>>,
) -> Self
pub fn set_explicit_auth_flows( self, input: Option<Vec<ExplicitAuthFlowsType>>, ) -> Self
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows
, your user client supports ALLOW_REFRESH_TOKEN_AUTH
, ALLOW_USER_SRP_AUTH
, and ALLOW_CUSTOM_AUTH
.
Valid values include:
-
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. -
ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication. -
ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. -
ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication. -
ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH
, CUSTOM_AUTH_FLOW_ONLY
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
, like ALLOW_USER_SRP_AUTH
.
sourcepub fn get_explicit_auth_flows(&self) -> &Option<Vec<ExplicitAuthFlowsType>>
pub fn get_explicit_auth_flows(&self) -> &Option<Vec<ExplicitAuthFlowsType>>
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows
, your user client supports ALLOW_REFRESH_TOKEN_AUTH
, ALLOW_USER_SRP_AUTH
, and ALLOW_CUSTOM_AUTH
.
Valid values include:
-
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password. -
ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication. -
ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords. -
ALLOW_USER_SRP_AUTH
: Enable SRP-based authentication. -
ALLOW_REFRESH_TOKEN_AUTH
: Enable authflow to refresh tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH
, CUSTOM_AUTH_FLOW_ONLY
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
, like ALLOW_USER_SRP_AUTH
.
sourcepub fn supported_identity_providers(self, input: impl Into<String>) -> Self
pub fn supported_identity_providers(self, input: impl Into<String>) -> Self
Appends an item to supported_identity_providers
.
To override the contents of this collection use set_supported_identity_providers
.
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
sourcepub fn set_supported_identity_providers(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_supported_identity_providers( self, input: Option<Vec<String>>, ) -> Self
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
sourcepub fn get_supported_identity_providers(&self) -> &Option<Vec<String>>
pub fn get_supported_identity_providers(&self) -> &Option<Vec<String>>
A list of provider names for the identity providers (IdPs) that are supported on this client. The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
sourcepub fn callback_urls(self, input: impl Into<String>) -> Self
pub fn callback_urls(self, input: impl Into<String>) -> Self
Appends an item to callback_urls
.
To override the contents of this collection use set_callback_urls
.
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn set_callback_urls(self, input: Option<Vec<String>>) -> Self
pub fn set_callback_urls(self, input: Option<Vec<String>>) -> Self
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn get_callback_urls(&self) -> &Option<Vec<String>>
pub fn get_callback_urls(&self) -> &Option<Vec<String>>
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn logout_urls(self, input: impl Into<String>) -> Self
pub fn logout_urls(self, input: impl Into<String>) -> Self
Appends an item to logout_urls
.
To override the contents of this collection use set_logout_urls
.
A list of allowed logout URLs for the IdPs.
sourcepub fn set_logout_urls(self, input: Option<Vec<String>>) -> Self
pub fn set_logout_urls(self, input: Option<Vec<String>>) -> Self
A list of allowed logout URLs for the IdPs.
sourcepub fn get_logout_urls(&self) -> &Option<Vec<String>>
pub fn get_logout_urls(&self) -> &Option<Vec<String>>
A list of allowed logout URLs for the IdPs.
sourcepub fn default_redirect_uri(self, input: impl Into<String>) -> Self
pub fn default_redirect_uri(self, input: impl Into<String>) -> Self
The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri
in authentication requests. Must be in the CallbackURLs
list.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
For more information, see Default redirect URI.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn set_default_redirect_uri(self, input: Option<String>) -> Self
pub fn set_default_redirect_uri(self, input: Option<String>) -> Self
The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri
in authentication requests. Must be in the CallbackURLs
list.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
For more information, see Default redirect URI.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn get_default_redirect_uri(&self) -> &Option<String>
pub fn get_default_redirect_uri(&self) -> &Option<String>
The default redirect URI. In app clients with one assigned IdP, replaces redirect_uri
in authentication requests. Must be in the CallbackURLs
list.
A redirect URI must:
-
Be an absolute URI.
-
Be registered with the authorization server.
-
Not include a fragment component.
For more information, see Default redirect URI.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
sourcepub fn allowed_o_auth_flows(self, input: OAuthFlowType) -> Self
pub fn allowed_o_auth_flows(self, input: OAuthFlowType) -> Self
Appends an item to allowed_o_auth_flows
.
To override the contents of this collection use set_allowed_o_auth_flows
.
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials
as the only allowed OAuth flow.
- code
-
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint. - implicit
-
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
-
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.
sourcepub fn set_allowed_o_auth_flows(self, input: Option<Vec<OAuthFlowType>>) -> Self
pub fn set_allowed_o_auth_flows(self, input: Option<Vec<OAuthFlowType>>) -> Self
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials
as the only allowed OAuth flow.
- code
-
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint. - implicit
-
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
-
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.
sourcepub fn get_allowed_o_auth_flows(&self) -> &Option<Vec<OAuthFlowType>>
pub fn get_allowed_o_auth_flows(&self) -> &Option<Vec<OAuthFlowType>>
The OAuth grant types that you want your app client to generate. To create an app client that generates client credentials grants, you must add client_credentials
as the only allowed OAuth flow.
- code
-
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint. - implicit
-
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
-
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.
sourcepub fn allowed_o_auth_scopes(self, input: impl Into<String>) -> Self
pub fn allowed_o_auth_scopes(self, input: impl Into<String>) -> Self
Appends an item to allowed_o_auth_scopes
.
To override the contents of this collection use set_allowed_o_auth_scopes
.
The allowed OAuth scopes. Possible values provided by OAuth are phone
, email
, openid
, and profile
. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
sourcepub fn set_allowed_o_auth_scopes(self, input: Option<Vec<String>>) -> Self
pub fn set_allowed_o_auth_scopes(self, input: Option<Vec<String>>) -> Self
The allowed OAuth scopes. Possible values provided by OAuth are phone
, email
, openid
, and profile
. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
sourcepub fn get_allowed_o_auth_scopes(&self) -> &Option<Vec<String>>
pub fn get_allowed_o_auth_scopes(&self) -> &Option<Vec<String>>
The allowed OAuth scopes. Possible values provided by OAuth are phone
, email
, openid
, and profile
. Possible values provided by Amazon Web Services are aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
sourcepub fn allowed_o_auth_flows_user_pool_client(self, input: bool) -> Self
pub fn allowed_o_auth_flows_user_pool_client(self, input: bool) -> Self
Set to true
to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient
must be true
before you can configure the following features in your app client.
-
CallBackURLs
: Callback URLs. -
LogoutURLs
: Sign-out redirect URLs. -
AllowedOAuthScopes
: OAuth 2.0 scopes. -
AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient
to true
in a CreateUserPoolClient
or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to false
.
sourcepub fn set_allowed_o_auth_flows_user_pool_client(
self,
input: Option<bool>,
) -> Self
pub fn set_allowed_o_auth_flows_user_pool_client( self, input: Option<bool>, ) -> Self
Set to true
to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient
must be true
before you can configure the following features in your app client.
-
CallBackURLs
: Callback URLs. -
LogoutURLs
: Sign-out redirect URLs. -
AllowedOAuthScopes
: OAuth 2.0 scopes. -
AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient
to true
in a CreateUserPoolClient
or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to false
.
sourcepub fn get_allowed_o_auth_flows_user_pool_client(&self) -> &Option<bool>
pub fn get_allowed_o_auth_flows_user_pool_client(&self) -> &Option<bool>
Set to true
to use OAuth 2.0 features in your user pool app client.
AllowedOAuthFlowsUserPoolClient
must be true
before you can configure the following features in your app client.
-
CallBackURLs
: Callback URLs. -
LogoutURLs
: Sign-out redirect URLs. -
AllowedOAuthScopes
: OAuth 2.0 scopes. -
AllowedOAuthFlows
: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient
to true
in a CreateUserPoolClient
or UpdateUserPoolClient
API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to false
.
sourcepub fn analytics_configuration(self, input: AnalyticsConfigurationType) -> Self
pub fn analytics_configuration(self, input: AnalyticsConfigurationType) -> Self
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
sourcepub fn set_analytics_configuration(
self,
input: Option<AnalyticsConfigurationType>,
) -> Self
pub fn set_analytics_configuration( self, input: Option<AnalyticsConfigurationType>, ) -> Self
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
sourcepub fn get_analytics_configuration(&self) -> &Option<AnalyticsConfigurationType>
pub fn get_analytics_configuration(&self) -> &Option<AnalyticsConfigurationType>
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
sourcepub fn prevent_user_existence_errors(
self,
input: PreventUserExistenceErrorTypes,
) -> Self
pub fn prevent_user_existence_errors( self, input: PreventUserExistenceErrorTypes, ) -> Self
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
-
ENABLED
- This prevents user existence-related errors. -
LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
sourcepub fn set_prevent_user_existence_errors(
self,
input: Option<PreventUserExistenceErrorTypes>,
) -> Self
pub fn set_prevent_user_existence_errors( self, input: Option<PreventUserExistenceErrorTypes>, ) -> Self
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
-
ENABLED
- This prevents user existence-related errors. -
LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
sourcepub fn get_prevent_user_existence_errors(
&self,
) -> &Option<PreventUserExistenceErrorTypes>
pub fn get_prevent_user_existence_errors( &self, ) -> &Option<PreventUserExistenceErrorTypes>
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED
and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
-
ENABLED
- This prevents user existence-related errors. -
LEGACY
- This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.
sourcepub fn enable_token_revocation(self, input: bool) -> Self
pub fn enable_token_revocation(self, input: bool) -> Self
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
sourcepub fn set_enable_token_revocation(self, input: Option<bool>) -> Self
pub fn set_enable_token_revocation(self, input: Option<bool>) -> Self
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
sourcepub fn get_enable_token_revocation(&self) -> &Option<bool>
pub fn get_enable_token_revocation(&self) -> &Option<bool>
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
sourcepub fn enable_propagate_additional_user_context_data(self, input: bool) -> Self
pub fn enable_propagate_additional_user_context_data(self, input: bool) -> Self
Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
sourcepub fn set_enable_propagate_additional_user_context_data(
self,
input: Option<bool>,
) -> Self
pub fn set_enable_propagate_additional_user_context_data( self, input: Option<bool>, ) -> Self
Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
sourcepub fn get_enable_propagate_additional_user_context_data(&self) -> &Option<bool>
pub fn get_enable_propagate_additional_user_context_data(&self) -> &Option<bool>
Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
sourcepub fn auth_session_validity(self, input: i32) -> Self
pub fn auth_session_validity(self, input: i32) -> Self
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
sourcepub fn set_auth_session_validity(self, input: Option<i32>) -> Self
pub fn set_auth_session_validity(self, input: Option<i32>) -> Self
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
sourcepub fn get_auth_session_validity(&self) -> &Option<i32>
pub fn get_auth_session_validity(&self) -> &Option<i32>
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
sourcepub fn build(self) -> Result<CreateUserPoolClientInput, BuildError>
pub fn build(self) -> Result<CreateUserPoolClientInput, BuildError>
Consumes the builder and constructs a CreateUserPoolClientInput
.
source§impl CreateUserPoolClientInputBuilder
impl CreateUserPoolClientInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateUserPoolClientOutput, SdkError<CreateUserPoolClientError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateUserPoolClientOutput, SdkError<CreateUserPoolClientError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for CreateUserPoolClientInputBuilder
impl Clone for CreateUserPoolClientInputBuilder
source§fn clone(&self) -> CreateUserPoolClientInputBuilder
fn clone(&self) -> CreateUserPoolClientInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for CreateUserPoolClientInputBuilder
impl Default for CreateUserPoolClientInputBuilder
source§fn default() -> CreateUserPoolClientInputBuilder
fn default() -> CreateUserPoolClientInputBuilder
source§impl PartialEq for CreateUserPoolClientInputBuilder
impl PartialEq for CreateUserPoolClientInputBuilder
source§fn eq(&self, other: &CreateUserPoolClientInputBuilder) -> bool
fn eq(&self, other: &CreateUserPoolClientInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateUserPoolClientInputBuilder
Auto Trait Implementations§
impl Freeze for CreateUserPoolClientInputBuilder
impl RefUnwindSafe for CreateUserPoolClientInputBuilder
impl Send for CreateUserPoolClientInputBuilder
impl Sync for CreateUserPoolClientInputBuilder
impl Unpin for CreateUserPoolClientInputBuilder
impl UnwindSafe for CreateUserPoolClientInputBuilder
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> 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 more