Struct aws_sdk_cognitoidentityprovider::operation::create_group::CreateGroupInput

#[non_exhaustive]
pub struct CreateGroupInput {
    pub group_name: Option<String>,
    pub user_pool_id: Option<String>,
    pub description: Option<String>,
    pub role_arn: Option<String>,
    pub precedence: Option<i32>,
}

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.

group_name: Option<String>

The name of the group. Must be unique.

user_pool_id: Option<String>

The user pool ID for the user pool.

description: Option<String>

A string containing the description of the group.

role_arn: Option<String>

The role Amazon Resource Name (ARN) for the group.

precedence: Option<i32>

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

Implementations

impl CreateGroupInput

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

The name of the group. Must be unique.

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

The user pool ID for the user pool.

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

A string containing the description of the group.

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

The role Amazon Resource Name (ARN) for the group.

pub fn precedence(&self) -> Option<i32>

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

impl CreateGroupInput

pub fn builder() -> CreateGroupInputBuilder

Creates a new builder-style object to manufacture CreateGroupInput.

Trait Implementations

impl Clone for CreateGroupInput

fn clone(&self) -> CreateGroupInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateGroupInput

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

Formats the value using the given formatter.

impl PartialEq for CreateGroupInput

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

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

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

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

impl StructuralPartialEq for CreateGroupInput