Package software.amazon.awssdk.services.s3control.model

Class Grantee

java.lang.Object

software.amazon.awssdk.services.s3control.model.Grantee

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Grantee.Builder,Grantee>

@Generated("software.amazon.awssdk:codegen")
public final class Grantee
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Grantee.Builder,Grantee>

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Grantee.Builder

Method Summary

Modifier and Type	Method	Description
static Grantee.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	granteeIdentifier()	The unique identifier of the Grantee.
GranteeType	granteeType()	The type of the grantee to which access has been granted.
String	granteeTypeAsString()	The type of the grantee to which access has been granted.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Grantee.Builder>	serializableBuilderClass()
Grantee.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

granteeType

public final GranteeType granteeType()

The type of the grantee to which access has been granted. It can be one of the following values:

• IAM - An IAM user or role.

• DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

• DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

If the service returns an enum value that is not available in the current SDK version, granteeType will return GranteeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().

Returns:

The type of the grantee to which access has been granted. It can be one of the following values:

• IAM - An IAM user or role.

• DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

• DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

See Also:

GranteeType

granteeTypeAsString

public final String granteeTypeAsString()

The type of the grantee to which access has been granted. It can be one of the following values:

• IAM - An IAM user or role.

• DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

• DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

If the service returns an enum value that is not available in the current SDK version, granteeType will return GranteeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granteeTypeAsString().

Returns:

The type of the grantee to which access has been granted. It can be one of the following values:

• IAM - An IAM user or role.

• DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

• DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

See Also:

GranteeType

granteeIdentifier

public final String granteeIdentifier()

The unique identifier of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

Returns:

The unique identifier of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

toBuilder

public Grantee.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Grantee.Builder,Grantee>

builder

public static Grantee.Builder builder()

serializableBuilderClass

public static Class<? extends Grantee.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo