1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateGroupInput {
/// <p>The name of the group. Must be unique.</p>
pub group_name: ::std::option::Option<::std::string::String>,
/// <p>The user pool ID for the user pool.</p>
pub user_pool_id: ::std::option::Option<::std::string::String>,
/// <p>A string containing the description of the group.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> 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 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub precedence: ::std::option::Option<i32>,
}
impl CreateGroupInput {
/// <p>The name of the group. Must be unique.</p>
pub fn group_name(&self) -> ::std::option::Option<&str> {
self.group_name.as_deref()
}
/// <p>The user pool ID for the user pool.</p>
pub fn user_pool_id(&self) -> ::std::option::Option<&str> {
self.user_pool_id.as_deref()
}
/// <p>A string containing the description of the group.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> 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 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn precedence(&self) -> ::std::option::Option<i32> {
self.precedence
}
}
impl CreateGroupInput {
/// Creates a new builder-style object to manufacture [`CreateGroupInput`](crate::operation::create_group::CreateGroupInput).
pub fn builder() -> crate::operation::create_group::builders::CreateGroupInputBuilder {
crate::operation::create_group::builders::CreateGroupInputBuilder::default()
}
}
/// A builder for [`CreateGroupInput`](crate::operation::create_group::CreateGroupInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateGroupInputBuilder {
pub(crate) group_name: ::std::option::Option<::std::string::String>,
pub(crate) user_pool_id: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) precedence: ::std::option::Option<i32>,
}
impl CreateGroupInputBuilder {
/// <p>The name of the group. Must be unique.</p>
/// This field is required.
pub fn group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.group_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the group. Must be unique.</p>
pub fn set_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.group_name = input;
self
}
/// <p>The name of the group. Must be unique.</p>
pub fn get_group_name(&self) -> &::std::option::Option<::std::string::String> {
&self.group_name
}
/// <p>The user pool ID for the user pool.</p>
/// This field is required.
pub fn user_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.user_pool_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn set_user_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.user_pool_id = input;
self
}
/// <p>The user pool ID for the user pool.</p>
pub fn get_user_pool_id(&self) -> &::std::option::Option<::std::string::String> {
&self.user_pool_id
}
/// <p>A string containing the description of the group.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A string containing the description of the group.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A string containing the description of the group.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The role Amazon Resource Name (ARN) for the group.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> 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 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn precedence(mut self, input: i32) -> Self {
self.precedence = ::std::option::Option::Some(input);
self
}
/// <p>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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> 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 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn set_precedence(mut self, input: ::std::option::Option<i32>) -> Self {
self.precedence = input;
self
}
/// <p>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 <code>Precedence</code> values take precedence over groups with higher or null <code>Precedence</code> 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 <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims.</p>
/// <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither group takes precedence over the other. If two groups with the same <code>Precedence</code> have the same role ARN, that role is used in the <code>cognito:preferred_role</code> claim in tokens for users in each group. If the two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't set in users' tokens.</p>
/// <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code> value is <code>2^31-1</code>.</p>
pub fn get_precedence(&self) -> &::std::option::Option<i32> {
&self.precedence
}
/// Consumes the builder and constructs a [`CreateGroupInput`](crate::operation::create_group::CreateGroupInput).
pub fn build(self) -> ::std::result::Result<crate::operation::create_group::CreateGroupInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_group::CreateGroupInput {
group_name: self.group_name,
user_pool_id: self.user_pool_id,
description: self.description,
role_arn: self.role_arn,
precedence: self.precedence,
})
}
}