Struct aws_sdk_cognitoidentity::input::CreateIdentityPoolInput

#[non_exhaustive]
pub struct CreateIdentityPoolInput {
    pub identity_pool_name: Option<String>,
    pub allow_unauthenticated_identities: bool,
    pub allow_classic_flow: Option<bool>,
    pub supported_login_providers: Option<HashMap<String, String>>,
    pub developer_provider_name: Option<String>,
    pub open_id_connect_provider_ar_ns: Option<Vec<String>>,
    pub cognito_identity_providers: Option<Vec<CognitoIdentityProvider>>,
    pub saml_provider_ar_ns: Option<Vec<String>>,
    pub identity_pool_tags: Option<HashMap<String, String>>,
}

Input to the CreateIdentityPool action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

identity_pool_name: Option<String>

A string that you provide.

allow_unauthenticated_identities: bool

TRUE if the identity pool supports unauthenticated logins.

allow_classic_flow: Option<bool>

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

supported_login_providers: Option<HashMap<String, String>>

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

developer_provider_name: Option<String>

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.

open_id_connect_provider_ar_ns: Option<Vec<String>>

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

cognito_identity_providers: Option<Vec<CognitoIdentityProvider>>

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

saml_provider_ar_ns: Option<Vec<String>>

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

identity_pool_tags: Option<HashMap<String, String>>

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.

Implementations

impl CreateIdentityPoolInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateIdentityPool, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateIdentityPool>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateIdentityPoolInput

impl CreateIdentityPoolInput

pub fn identity_pool_name(&self) -> Option<&str>

A string that you provide.

pub fn allow_unauthenticated_identities(&self) -> bool

TRUE if the identity pool supports unauthenticated logins.

pub fn allow_classic_flow(&self) -> Option<bool>

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) -> Option<&HashMap<String, String>>

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

pub fn developer_provider_name(&self) -> Option<&str>

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) -> Option<&[String]>

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

pub fn cognito_identity_providers(&self) -> Option<&[CognitoIdentityProvider]>

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

pub fn saml_provider_ar_ns(&self) -> Option<&[String]>

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

pub fn identity_pool_tags(&self) -> Option<&HashMap<String, String>>

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 CreateIdentityPoolInput

fn clone(&self) -> CreateIdentityPoolInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIdentityPoolInput

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

Formats the value using the given formatter.

impl PartialEq<CreateIdentityPoolInput> for CreateIdentityPoolInput

fn eq(&self, other: &CreateIdentityPoolInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateIdentityPoolInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateIdentityPoolInput