java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3control.model.S3ControlRequest
    - - software.amazon.awssdk.services.s3control.model.CreateAccessGrantRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAccessGrantRequest
extends S3ControlRequest
implements ToCopyableBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateAccessGrantRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AccessGrantsLocationConfiguration`	`accessGrantsLocationConfiguration()`	The configuration options of the grant location.
`String`	`accessGrantsLocationId()`	The ID of the registered location to which you are granting access.
`String`	`accountId()`	The ID of the Amazon Web Services account that is making this request.
`String`	`applicationArn()`	The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
`static CreateAccessGrantRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Grantee`	`grantee()`	The user, group, or role to which you are granting access.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Permission`	`permission()`	The type of access that you are granting to your S3 data, which can be set to one of the following values:
`String`	`permissionAsString()`	The type of access that you are granting to your S3 data, which can be set to one of the following values:
`S3PrefixType`	`s3PrefixType()`	The type of `S3SubPrefix`.
`String`	`s3PrefixTypeAsString()`	The type of `S3SubPrefix`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAccessGrantRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	The Amazon Web Services resource tags that you are adding to the access grant.
`CreateAccessGrantRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - accountId
```
public final String accountId()
```
    The ID of the Amazon Web Services account that is making this request.
    
    Returns:
    
    The ID of the Amazon Web Services account that is making this request.
  - accessGrantsLocationId
```
public final String accessGrantsLocationId()
```
    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
    
    If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.
    
    Returns:
    
    The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.
    
    If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.
  - accessGrantsLocationConfiguration
```
public final AccessGrantsLocationConfiguration accessGrantsLocationConfiguration()
```
    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.
    
    Returns:
    
    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.
  - grantee
```
public final Grantee 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.
    
    Returns:
    
    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.
  - permission
```
public final Permission permission()
```
    The type of access that you are granting to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of access that you are granting to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - permissionAsString
```
public final String permissionAsString()
```
    The type of access that you are granting to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of access that you are granting to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - applicationArn
```
public final String applicationArn()
```
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.
  - s3PrefixType
```
public final S3PrefixType s3PrefixType()
```
    The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
    
    If the service returns an enum value that is not available in the current SDK version, s3PrefixType will return S3PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3PrefixTypeAsString().
    
    Returns:
    
    The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
    
    See Also:
    
    S3PrefixType
  - s3PrefixTypeAsString
```
public final String s3PrefixTypeAsString()
```
    The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
    
    If the service returns an enum value that is not available in the current SDK version, s3PrefixType will return S3PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3PrefixTypeAsString().
    
    Returns:
    
    The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.
    
    See Also:
    
    S3PrefixType
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
  - toBuilder
```
public CreateAccessGrantRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAccessGrantRequest.Builder,CreateAccessGrantRequest>
    
    Specified by:
    
    toBuilder in class S3ControlRequest
  - builder
```
public static CreateAccessGrantRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAccessGrantRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAccessGrantRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

accountId

accessGrantsLocationId

accessGrantsLocationConfiguration

grantee

permission

permissionAsString

applicationArn

s3PrefixType

s3PrefixTypeAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields