Struct aws_sdk_cognitoidentityprovider::types::builders::GroupTypeBuilder

#[non_exhaustive]
pub struct GroupTypeBuilder { /* private fields */ }

A builder for GroupType.

Implementations

impl GroupTypeBuilder

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

The name of the group.

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

The name of the group.

pub fn get_group_name(&self) -> &Option<String>

The name of the group.

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

The user pool ID for the user pool.

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

The user pool ID for the user pool.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID for the user pool.

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

A string containing the description of the group.

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

A string containing the description of the group.

pub fn get_description(&self) -> &Option<String>

A string containing the description of the group.

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

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

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

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

pub fn get_role_arn(&self) -> &Option<String>

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

pub fn precedence(self, input: i32) -> Self

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 ornull 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.

pub fn set_precedence(self, input: Option<i32>) -> Self

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 ornull 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.

pub fn get_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 ornull 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.

pub fn last_modified_date(self, input: DateTime) -> Self

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn get_last_modified_date(&self) -> &Option<DateTime>

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn creation_date(self, input: DateTime) -> Self

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn set_creation_date(self, input: Option<DateTime>) -> Self

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn get_creation_date(&self) -> &Option<DateTime>

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn build(self) -> GroupType

Consumes the builder and constructs a GroupType.

Trait Implementations

impl Clone for GroupTypeBuilder

fn clone(&self) -> GroupTypeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupTypeBuilder

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

Formats the value using the given formatter.

impl Default for GroupTypeBuilder

fn default() -> GroupTypeBuilder

Returns the “default value” for a type.

impl PartialEq for GroupTypeBuilder

fn eq(&self, other: &GroupTypeBuilder) -> 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 GroupTypeBuilder