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

Interface CreateAccessGrantResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>, S3ControlResponse.Builder, SdkBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateAccessGrantResponse
public static interface CreateAccessGrantResponse.Builder extends S3ControlResponse.Builder, SdkPojo, CopyableBuilder<CreateAccessGrantResponse.Builder,CreateAccessGrantResponse>

  • Method Details

    • createdAt

      CreateAccessGrantResponse.Builder createdAt(Instant 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.

    • accessGrantId

      CreateAccessGrantResponse.Builder accessGrantId(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.

    • accessGrantArn

      CreateAccessGrantResponse.Builder accessGrantArn(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.

    • grantee

      CreateAccessGrantResponse.Builder grantee(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.

    • grantee

      default CreateAccessGrantResponse.Builder grantee(Consumer<Grantee.Builder> 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.

      This is a convenience method that creates an instance of the Grantee.Builder avoiding the need to create one manually via Grantee.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to grantee(Grantee).

      Parameters:
      grantee - a consumer that will call methods on Grantee.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessGrantsLocationId

      CreateAccessGrantResponse.Builder accessGrantsLocationId(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.

    • accessGrantsLocationConfiguration

      CreateAccessGrantResponse.Builder accessGrantsLocationConfiguration(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.

    • accessGrantsLocationConfiguration

      default CreateAccessGrantResponse.Builder accessGrantsLocationConfiguration(Consumer<AccessGrantsLocationConfiguration.Builder> accessGrantsLocationConfiguration)

      The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

      This is a convenience method that creates an instance of the AccessGrantsLocationConfiguration.Builder avoiding the need to create one manually via AccessGrantsLocationConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessGrantsLocationConfiguration(AccessGrantsLocationConfiguration).

      Parameters:
      accessGrantsLocationConfiguration - a consumer that will call methods on AccessGrantsLocationConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permission

      CreateAccessGrantResponse.Builder permission(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

      CreateAccessGrantResponse.Builder permission(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:

    • applicationArn

      CreateAccessGrantResponse.Builder applicationArn(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.

    • grantScope

      CreateAccessGrantResponse.Builder grantScope(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.