Interface Group.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Group.Builder,
,Group> SdkBuilder<Group.Builder,
,Group> SdkPojo
- Enclosing class:
Group
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) A string containing a description of the specified group.displayName
(String displayName) The display name value for the group.externalIds
(Collection<ExternalId> externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.externalIds
(Consumer<ExternalId.Builder>... externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.externalIds
(ExternalId... externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.The identifier for a group in the identity store.identityStoreId
(String identityStoreId) The globally unique identifier for the identity store.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
groupId
The identifier for a group in the identity store.
- Parameters:
groupId
- The identifier for a group in the identity store.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
- Parameters:
displayName
- The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalIds
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Parameters:
externalIds
- A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalIds
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Parameters:
externalIds
- A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalIds
A list of
This is a convenience method that creates an instance of theExternalId
objects that contains the identifiers issued to this resource by an external identity provider.ExternalId.Builder
avoiding the need to create one manually viaExternalId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexternalIds(List<ExternalId>)
.- Parameters:
externalIds
- a consumer that will call methods onExternalId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
A string containing a description of the specified group.
- Parameters:
description
- A string containing a description of the specified group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identityStoreId
The globally unique identifier for the identity store.
- Parameters:
identityStoreId
- The globally unique identifier for the identity store.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-