Interface Group.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Group.Builder,Group>, SdkBuilder<Group.Builder,Group>, SdkPojo
Enclosing class:
Group
@Mutable @NotThreadSafe public static interface Group.Builder extends SdkPojo, CopyableBuilder<Group.Builder,Group>

  • Method Details

    • identityStoreId

      Group.Builder identityStoreId(String 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.

    • groupId

      Group.Builder groupId(String 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.

    • groupArn

      Group.Builder groupArn(String groupArn)

      The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

      Parameters:
      groupArn - The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • revision

      Group.Builder revision(String revision)

      The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.

      Parameters:
      revision - The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      Group.Builder displayName(String 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.

      Prefix search supports a maximum of 1,000 characters for the string.

      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.

      Prefix search supports a maximum of 1,000 characters for the string.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalIds

      Group.Builder externalIds(Collection<ExternalId> externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      Parameters:
      externalIds - A list of ExternalId 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

      Group.Builder externalIds(ExternalId... externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      Parameters:
      externalIds - A list of ExternalId 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

      Group.Builder externalIds(Consumer<ExternalId.Builder>... externalIds)

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

      This is a convenience method that creates an instance of the ExternalId.Builder avoiding the need to create one manually via ExternalId.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to externalIds(List<ExternalId>).

      Parameters:
      externalIds - a consumer that will call methods on ExternalId.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      Group.Builder description(String 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.

    • createdAt

      Group.Builder createdAt(Instant createdAt)

      The date and time the group was created.

      Parameters:
      createdAt - The date and time the group was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Group.Builder updatedAt(Instant updatedAt)

      The date and time the group was last updated.

      Parameters:
      updatedAt - The date and time the group was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      Group.Builder createdBy(String createdBy)

      The identifier of the user or system that created the group.

      Parameters:
      createdBy - The identifier of the user or system that created the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedBy

      Group.Builder updatedBy(String updatedBy)

      The identifier of the user or system that last updated the group.

      Parameters:
      updatedBy - The identifier of the user or system that last updated the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.