Struct CognitoUserPoolConfiguration

#[non_exhaustive]
pub struct CognitoUserPoolConfiguration {
    pub user_pool_arn: String,
    pub client_ids: Option<Vec<String>>,
    pub group_configuration: Option<CognitoGroupConfiguration>,
}

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.

This data type part of a Configuration structure that is used as a parameter to CreateIdentitySource.

Example:"CognitoUserPoolConfiguration":{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": \["a1b2c3d4e5f6g7h8i9j0kalbmc"\],"groupConfiguration": {"groupEntityType": "MyCorp::Group"}}

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.

user_pool_arn: String

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

client_ids: Option<Vec<String>>

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": \["&ExampleCogClientId;"\]

group_configuration: Option<CognitoGroupConfiguration>

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

Implementations

impl CognitoUserPoolConfiguration

pub fn user_pool_arn(&self) -> &str

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Example: "UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"

pub fn client_ids(&self) -> &[String]

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": \["&ExampleCogClientId;"\]

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .client_ids.is_none().

pub fn group_configuration(&self) -> Option<&CognitoGroupConfiguration>

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

impl CognitoUserPoolConfiguration

pub fn builder() -> CognitoUserPoolConfigurationBuilder

Creates a new builder-style object to manufacture CognitoUserPoolConfiguration.

Trait Implementations

impl Clone for CognitoUserPoolConfiguration

fn clone(&self) -> CognitoUserPoolConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CognitoUserPoolConfiguration

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

Formats the value using the given formatter.

impl PartialEq for CognitoUserPoolConfiguration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CognitoUserPoolConfiguration