CreateAccessGrantResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<S3ControlResponseMetadata>
- - com.amazonaws.services.s3control.model.CreateAccessGrantResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAccessGrantResult
extends AmazonWebServiceResult<S3ControlResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateAccessGrantResult()

Constructors
Constructor and Description
`CreateAccessGrantResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAccessGrantResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessGrantArn()` The Amazon Resource Name (ARN) of the access grant.
`String`	`getAccessGrantId()` The ID of the access grant.
`AccessGrantsLocationConfiguration`	`getAccessGrantsLocationConfiguration()` The configuration options of the grant location.
`String`	`getAccessGrantsLocationId()` The ID of the registered location to which you are granting access.
`String`	`getApplicationArn()` The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
`Date`	`getCreatedAt()` The date and time when you created the access grant.
`Grantee`	`getGrantee()` The user, group, or role to which you are granting access.
`String`	`getGrantScope()` The S3 path of the data to which you are granting access.
`String`	`getPermission()` The type of access that you are granting to your S3 data, which can be set to one of the following values:
`int`	`hashCode()`
`void`	`setAccessGrantArn(String accessGrantArn)` The Amazon Resource Name (ARN) of the access grant.
`void`	`setAccessGrantId(String accessGrantId)` The ID of the access grant.
`void`	`setAccessGrantsLocationConfiguration(AccessGrantsLocationConfiguration accessGrantsLocationConfiguration)` The configuration options of the grant location.
`void`	`setAccessGrantsLocationId(String accessGrantsLocationId)` The ID of the registered location to which you are granting access.
`void`	`setApplicationArn(String applicationArn)` The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
`void`	`setCreatedAt(Date createdAt)` The date and time when you created the access grant.
`void`	`setGrantee(Grantee grantee)` The user, group, or role to which you are granting access.
`void`	`setGrantScope(String grantScope)` The S3 path of the data to which you are granting access.
`void`	`setPermission(String permission)` The type of access that you are granting to your S3 data, which can be set to one of the following values:
`String`	`toString()` Returns a string representation of this object.
`CreateAccessGrantResult`	`withAccessGrantArn(String accessGrantArn)` The Amazon Resource Name (ARN) of the access grant.
`CreateAccessGrantResult`	`withAccessGrantId(String accessGrantId)` The ID of the access grant.
`CreateAccessGrantResult`	`withAccessGrantsLocationConfiguration(AccessGrantsLocationConfiguration accessGrantsLocationConfiguration)` The configuration options of the grant location.
`CreateAccessGrantResult`	`withAccessGrantsLocationId(String accessGrantsLocationId)` The ID of the registered location to which you are granting access.
`CreateAccessGrantResult`	`withApplicationArn(String applicationArn)` The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
`CreateAccessGrantResult`	`withCreatedAt(Date createdAt)` The date and time when you created the access grant.
`CreateAccessGrantResult`	`withGrantee(Grantee grantee)` The user, group, or role to which you are granting access.
`CreateAccessGrantResult`	`withGrantScope(String grantScope)` The S3 path of the data to which you are granting access.
`CreateAccessGrantResult`	`withPermission(Permission permission)` The type of access that you are granting to your S3 data, which can be set to one of the following values:
`CreateAccessGrantResult`	`withPermission(String permission)` The type of access that you are granting to your S3 data, which can be set to one of the following values:

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateAccessGrantResult
```
public CreateAccessGrantResult()
```
- Method Detail
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time when you created the access grant.
    
    Parameters:
    
    createdAt - The date and time when you created the access grant.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date and time when you created the access grant.
    
    Returns:
    
    The date and time when you created the access grant.
  - withCreatedAt
```
public CreateAccessGrantResult withCreatedAt(Date createdAt)
```
    The date and time when you created the access grant.
    
    Parameters:
    
    createdAt - The date and time when you created the access grant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessGrantId
```
public void setAccessGrantId(String accessGrantId)
```
    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
    
    Parameters:
    
    accessGrantId - The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
  - getAccessGrantId
```
public String getAccessGrantId()
```
    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
    
    Returns:
    
    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
  - withAccessGrantId
```
public CreateAccessGrantResult withAccessGrantId(String accessGrantId)
```
    The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
    
    Parameters:
    
    accessGrantId - The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessGrantArn
```
public void setAccessGrantArn(String accessGrantArn)
```
    The Amazon Resource Name (ARN) of the access grant.
    
    Parameters:
    
    accessGrantArn - The Amazon Resource Name (ARN) of the access grant.
  - getAccessGrantArn
```
public String getAccessGrantArn()
```
    The Amazon Resource Name (ARN) of the access grant.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the access grant.
  - withAccessGrantArn
```
public CreateAccessGrantResult withAccessGrantArn(String accessGrantArn)
```
    The Amazon Resource Name (ARN) of the access grant.
    
    Parameters:
    
    accessGrantArn - The Amazon Resource Name (ARN) of the access grant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGrantee
```
public void setGrantee(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.
    
    Parameters:
    
    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.
  - getGrantee
```
public Grantee getGrantee()
```
    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.
  - withGrantee
```
public CreateAccessGrantResult withGrantee(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessGrantsLocationId
```
public void setAccessGrantsLocationId(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.
    
    Parameters:
    
    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.
  - getAccessGrantsLocationId
```
public String getAccessGrantsLocationId()
```
    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.
    
    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.
  - withAccessGrantsLocationId
```
public CreateAccessGrantResult withAccessGrantsLocationId(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessGrantsLocationConfiguration
```
public void setAccessGrantsLocationConfiguration(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.
    
    Parameters:
    
    accessGrantsLocationConfiguration - The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
  - getAccessGrantsLocationConfiguration
```
public AccessGrantsLocationConfiguration getAccessGrantsLocationConfiguration()
```
    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
    
    Returns:
    
    The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
  - withAccessGrantsLocationConfiguration
```
public CreateAccessGrantResult withAccessGrantsLocationConfiguration(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.
    
    Parameters:
    
    accessGrantsLocationConfiguration - The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPermission
```
public void setPermission(String 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.
    Parameters:
    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.
    See Also:
    
    Permission
  - getPermission
```
public String getPermission()
```
    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.
    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
  - withPermission
```
public CreateAccessGrantResult withPermission(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Permission
  - withPermission
```
public CreateAccessGrantResult withPermission(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Permission
  - setApplicationArn
```
public void setApplicationArn(String applicationArn)
```
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
    
    Parameters:
    
    applicationArn - The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
  - getApplicationArn
```
public String getApplicationArn()
```
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, 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 the grant includes an application ARN, the grantee can only access the S3 data through this application.
  - withApplicationArn
```
public CreateAccessGrantResult withApplicationArn(String applicationArn)
```
    The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
    
    Parameters:
    
    applicationArn - The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGrantScope
```
public void setGrantScope(String grantScope)
```
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
    
    Parameters:
    
    grantScope - The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
  - getGrantScope
```
public String getGrantScope()
```
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
    
    Returns:
    
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
  - withGrantScope
```
public CreateAccessGrantResult withGrantScope(String grantScope)
```
    The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
    
    Parameters:
    
    grantScope - The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateAccessGrantResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.777

Class CreateAccessGrantResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

CreateAccessGrantResult

Method Detail

setCreatedAt

getCreatedAt

withCreatedAt

setAccessGrantId

getAccessGrantId

withAccessGrantId

setAccessGrantArn

getAccessGrantArn

withAccessGrantArn

setGrantee

getGrantee

withGrantee

setAccessGrantsLocationId

getAccessGrantsLocationId

withAccessGrantsLocationId

setAccessGrantsLocationConfiguration

getAccessGrantsLocationConfiguration

withAccessGrantsLocationConfiguration

setPermission

getPermission

withPermission

withPermission

setApplicationArn

getApplicationArn

withApplicationArn

setGrantScope

getGrantScope

withGrantScope

toString

equals

hashCode

clone