com.amazonaws.services.s3control.model

Class CreateAccessGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3control.model.CreateAccessGrantRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAccessGrantRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAccessGrantRequest()

Method Summary

Modifier and Type	Method and Description
CreateAccessGrantRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AccessGrantsLocationConfiguration	getAccessGrantsLocationConfiguration() The configuration options of the grant location.
String	getAccessGrantsLocationId() The ID of the registered location to which you are granting access.
String	getAccountId() The ID of the Amazon Web Services account that is making this request.
String	getApplicationArn() The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
Grantee	getGrantee() The user, group, or role 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:
String	getS3PrefixType() The type of S3SubPrefix.
List<Tag>	getTags() The Amazon Web Services resource tags that you are adding to the access grant.
int	hashCode()
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	setAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
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	setGrantee(Grantee grantee) The user, group, or role 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:
void	setS3PrefixType(String s3PrefixType) The type of S3SubPrefix.
void	setTags(Collection<Tag> tags) The Amazon Web Services resource tags that you are adding to the access grant.
String	toString() Returns a string representation of this object.
CreateAccessGrantRequest	withAccessGrantsLocationConfiguration(AccessGrantsLocationConfiguration accessGrantsLocationConfiguration) The configuration options of the grant location.
CreateAccessGrantRequest	withAccessGrantsLocationId(String accessGrantsLocationId) The ID of the registered location to which you are granting access.
CreateAccessGrantRequest	withAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
CreateAccessGrantRequest	withApplicationArn(String applicationArn) The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.
CreateAccessGrantRequest	withGrantee(Grantee grantee) The user, group, or role to which you are granting access.
CreateAccessGrantRequest	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:
CreateAccessGrantRequest	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:
CreateAccessGrantRequest	withS3PrefixType(S3PrefixType s3PrefixType) The type of S3SubPrefix.
CreateAccessGrantRequest	withS3PrefixType(String s3PrefixType) The type of S3SubPrefix.
CreateAccessGrantRequest	withTags(Collection<Tag> tags) The Amazon Web Services resource tags that you are adding to the access grant.
CreateAccessGrantRequest	withTags(Tag... tags) The Amazon Web Services resource tags that you are adding to the access grant.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAccessGrantRequest

public CreateAccessGrantRequest()

Method Detail

setAccountId

public void setAccountId(String accountId)

The ID of the Amazon Web Services account that is making this request.

Parameters:

accountId - The ID of the Amazon Web Services account that is making this request.

getAccountId

public String getAccountId()

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.

withAccountId

public CreateAccessGrantRequest withAccountId(String accountId)

The ID of the Amazon Web Services account that is making this request.

Parameters:

accountId - The ID of the Amazon Web Services account that is making this request.

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.

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.

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.

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.

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.

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.

withAccessGrantsLocationId

public CreateAccessGrantRequest 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.

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.

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.

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:

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. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

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. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

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. 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.

withAccessGrantsLocationConfiguration

public CreateAccessGrantRequest 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. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

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. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

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 CreateAccessGrantRequest 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.

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 CreateAccessGrantRequest 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 CreateAccessGrantRequest 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 an application ARN is included in the request to create an access grant, 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 an application ARN is included in the request to create an access grant, 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 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.

withApplicationArn

public CreateAccessGrantRequest withApplicationArn(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.

Parameters:

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:

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

setS3PrefixType

public void setS3PrefixType(String 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.

Parameters:

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.

See Also:

S3PrefixType

getS3PrefixType

public String getS3PrefixType()

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.

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

withS3PrefixType

public CreateAccessGrantRequest withS3PrefixType(String 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.

Parameters:

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.

Returns:

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

See Also:

S3PrefixType

withS3PrefixType

public CreateAccessGrantRequest withS3PrefixType(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.

Parameters:

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.

Returns:

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

See Also:

S3PrefixType

getTags

public List<Tag> getTags()

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.

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.

setTags

public void setTags(Collection<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.

Parameters:

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.

withTags

public CreateAccessGrantRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withTags

public CreateAccessGrantRequest withTags(Collection<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.

Parameters:

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.

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 CreateAccessGrantRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()