AWSCognitoIdentityProviderCreateGroupRequest

Objective-C

@interface AWSCognitoIdentityProviderCreateGroupRequest

Swift

class AWSCognitoIdentityProviderCreateGroupRequest

  • A string containing the description of the group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable detail;

    Swift

    var detail: String? { get set }

  • The name of the group. Must be unique.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable groupName;

    Swift

    var groupName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable precedence;

    Swift

    var precedence: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable roleArn;

    Swift

    var roleArn: String? { get set }

  • The user pool ID for the user pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }