Struct rusoto_cognito_idp::CreateGroupRequest
[−]
[src]
pub struct CreateGroupRequest { pub description: Option<String>, pub group_name: String, pub precedence: Option<i64>, pub role_arn: Option<String>, pub user_pool_id: String, }
Fields
description: Option<String>
A string containing the description of the group.
group_name: String
The name of the group. Must be unique.
precedence: Option<i64>
A nonnegative 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 will be used in the cognito:roles
and cognito:preferred_role
claims in the user's tokens.
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 is not set in users' tokens.
The default Precedence
value is null.
role_arn: Option<String>
The role ARN for the group.
user_pool_id: String
The user pool ID for the user pool.
Trait Implementations
impl Default for CreateGroupRequest
[src]
fn default() -> CreateGroupRequest
[src]
Returns the "default value" for a type. Read more
impl Debug for CreateGroupRequest
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for CreateGroupRequest
[src]
fn clone(&self) -> CreateGroupRequest
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more