Class CreateAccessGrantResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.s3control.model.S3ControlResponse
-
- software.amazon.awssdk.services.s3control.model.CreateAccessGrantResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateAccessGrantResponse extends S3ControlResponse implements ToCopyableBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateAccessGrantResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessGrantArn()The Amazon Resource Name (ARN) of the access grant.StringaccessGrantId()The ID of the access grant.AccessGrantsLocationConfigurationaccessGrantsLocationConfiguration()The configuration options of the grant location.StringaccessGrantsLocationId()The ID of the registered location to which you are granting access.StringapplicationArn()The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.static CreateAccessGrantResponse.Builderbuilder()InstantcreatedAt()The date and time when you created the access grant.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)Granteegrantee()The user, group, or role to which you are granting access.StringgrantScope()The S3 path of the data to which you are granting access.inthashCode()Permissionpermission()The type of access that you are granting to your S3 data, which can be set to one of the following values:StringpermissionAsString()The type of access that you are granting to your S3 data, which can be set to one of the following values:List<SdkField<?>>sdkFields()static Class<? extends CreateAccessGrantResponse.Builder>serializableBuilderClass()CreateAccessGrantResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.s3control.model.S3ControlResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
createdAt
public final Instant createdAt()
The date and time when you created the access grant.
- Returns:
- The date and time when you created the access grant.
-
accessGrantId
public final String accessGrantId()
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.
-
accessGrantArn
public final String accessGrantArn()
The Amazon Resource Name (ARN) of the access grant.
- Returns:
- The Amazon Resource Name (ARN) of the access grant.
-
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.
-
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
defaultto the default locations3://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
defaultto the default locations3://and assigns an auto-generated ID to other locations that you register.
-
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.
- Returns:
- The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.
-
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,
permissionwill returnPermission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionAsString().- 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,
permissionwill returnPermission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompermissionAsString().- 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 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.
-
grantScope
public final String grantScope()
The S3 path of the data to which you are granting access. It is the result of appending the
Subprefixto the location scope.- Returns:
- The S3 path of the data to which you are granting access. It is the result of appending the
Subprefixto the location scope.
-
toBuilder
public CreateAccessGrantResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static CreateAccessGrantResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAccessGrantResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-