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

Interface GetDataAccessRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetDataAccessRequest.Builder,GetDataAccessRequest>, S3ControlRequest.Builder, SdkBuilder<GetDataAccessRequest.Builder,GetDataAccessRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDataAccessRequest
public static interface GetDataAccessRequest.Builder extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<GetDataAccessRequest.Builder,GetDataAccessRequest>

  • Method Details

    • accountId

      GetDataAccessRequest.Builder accountId(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.

    • target

      GetDataAccessRequest.Builder target(String target)

      The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.

      Parameters:
      target - The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permission

      GetDataAccessRequest.Builder permission(String permission)

      The type of permission granted 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 permission granted 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

      GetDataAccessRequest.Builder permission(Permission permission)

      The type of permission granted 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 permission granted 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:

    • durationSeconds

      GetDataAccessRequest.Builder durationSeconds(Integer durationSeconds)

      The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.

      Parameters:
      durationSeconds - The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privilege

      GetDataAccessRequest.Builder privilege(String privilege)

      The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

      • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

      • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

      Parameters:
      privilege - The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

      • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

      • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

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

    • privilege

      GetDataAccessRequest.Builder privilege(Privilege privilege)

      The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

      • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

      • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

      Parameters:
      privilege - The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

      • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

      • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

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

    • targetType

      GetDataAccessRequest.Builder targetType(String targetType)

      The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.

      Parameters:
      targetType - The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data 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:

    • targetType

      GetDataAccessRequest.Builder targetType(S3PrefixType targetType)

      The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.

      Parameters:
      targetType - The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data 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:

    • overrideConfiguration

      GetDataAccessRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetDataAccessRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.