Struct aws_sdk_cognitoidentity::client::fluent_builders::CreateIdentityPool

pub struct CreateIdentityPool { /* private fields */ }

Fluent builder constructing a request to CreateIdentityPool.

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

• Facebook: graph.facebook.com

• Google: accounts.google.com

• Amazon: www.amazon.com

• Twitter: api.twitter.com

• Digits: www.digits.com

You must use AWS Developer credentials to call this API.

Implementations

impl CreateIdentityPool

pub async fn send(
    self
) -> Result<CreateIdentityPoolOutput, SdkError<CreateIdentityPoolError>>

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.

pub fn identity_pool_name(self, input: impl Into<String>) -> Self

A string that you provide.

pub fn set_identity_pool_name(self, input: Option<String>) -> Self

A string that you provide.

pub fn allow_unauthenticated_identities(self, input: bool) -> Self

TRUE if the identity pool supports unauthenticated logins.

pub fn set_allow_unauthenticated_identities(self, input: Option<bool>) -> Self

TRUE if the identity pool supports unauthenticated logins.

pub fn allow_classic_flow(self, input: bool) -> Self

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

pub fn set_allow_classic_flow(self, input: Option<bool>) -> Self

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

pub fn supported_login_providers(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to SupportedLoginProviders.

To override the contents of this collection use set_supported_login_providers.

Optional key:value pairs mapping provider names to provider app IDs.

pub fn set_supported_login_providers(
    self,
    input: Option<HashMap<String, String>>
) -> Self

Optional key:value pairs mapping provider names to provider app IDs.

pub fn developer_provider_name(self, input: impl Into<String>) -> Self

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

pub fn set_developer_provider_name(self, input: Option<String>) -> Self

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

pub fn open_id_connect_provider_ar_ns(self, input: impl Into<String>) -> Self

Appends an item to OpenIdConnectProviderARNs.

To override the contents of this collection use set_open_id_connect_provider_ar_ns.

The Amazon Resource Names (ARN) of the OpenID Connect providers.

pub fn set_open_id_connect_provider_ar_ns(
    self,
    input: Option<Vec<String>>
) -> Self

The Amazon Resource Names (ARN) of the OpenID Connect providers.

pub fn cognito_identity_providers(self, input: CognitoIdentityProvider) -> Self

Appends an item to CognitoIdentityProviders.

To override the contents of this collection use set_cognito_identity_providers.

An array of Amazon Cognito user pools and their client IDs.

pub fn set_cognito_identity_providers(
    self,
    input: Option<Vec<CognitoIdentityProvider>>
) -> Self

An array of Amazon Cognito user pools and their client IDs.

pub fn saml_provider_ar_ns(self, input: impl Into<String>) -> Self

Appends an item to SamlProviderARNs.

To override the contents of this collection use set_saml_provider_ar_ns.

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

pub fn set_saml_provider_ar_ns(self, input: Option<Vec<String>>) -> Self

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

pub fn identity_pool_tags(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to IdentityPoolTags.

To override the contents of this collection use set_identity_pool_tags.

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

pub fn set_identity_pool_tags(
    self,
    input: Option<HashMap<String, String>>
) -> Self

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Trait Implementations

impl Clone for CreateIdentityPool

fn clone(&self) -> CreateIdentityPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateIdentityPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.