Package software.amazon.awssdk.services.iam.model

Interface CreateUserRequest.Builder

    • Method Detail

      • path

        CreateUserRequest.Builder path​(String path)

        The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

        This parameter is optional. If it is not included, it defaults to a slash (/).

        This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

        Parameters:
        path - The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

        This parameter is optional. If it is not included, it defaults to a slash (/).

        This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( !) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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

      • userName

        CreateUserRequest.Builder userName​(String userName)

        The name of the user to create.

        IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

        Parameters:
        userName - The name of the user to create.

        IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

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

      • permissionsBoundary

        CreateUserRequest.Builder permissionsBoundary​(String permissionsBoundary)

        The ARN of the managed policy that is used to set the permissions boundary for the user.

        A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

        For more information about policy types, see Policy types in the IAM User Guide.

        Parameters:
        permissionsBoundary - The ARN of the managed policy that is used to set the permissions boundary for the user.

        A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide.

        For more information about policy types, see Policy types in the IAM User Guide.

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

      • tags

        CreateUserRequest.Builder tags​(Collection<Tag> tags)

        A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

        Parameters:
        tags - A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

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

      • tags

        CreateUserRequest.Builder tags​(Tag... tags)

        A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

        Parameters:
        tags - A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

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

      • tags

        CreateUserRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

        If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)