Struct aws_sdk_cognitoidentityprovider::operation::create_group::builders::CreateGroupFluentBuilder

pub struct CreateGroupFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateGroup.

Creates a new group in the specified user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl CreateGroupFluentBuilder

pub fn as_input(&self) -> &CreateGroupInputBuilder

Access the CreateGroup as a reference.

pub async fn send( self, ) -> Result<CreateGroupOutput, SdkError<CreateGroupError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateGroupOutput, CreateGroupError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The name of the group. Must be unique.

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

The name of the group. Must be unique.

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

The name of the group. Must be unique.

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

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

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

Trait Implementations

impl Clone for CreateGroupFluentBuilder

fn clone(&self) -> CreateGroupFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateGroupFluentBuilder

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

Formats the value using the given formatter.