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

Interface CreateAccessGrantRequest.Builder

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

  • Method Details

    • accountId

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

    • accessGrantsLocationId

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

      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.

    • accessGrantsLocationConfiguration

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

    • accessGrantsLocationConfiguration

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

      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:

    • grantee

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

    • permission

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

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

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

    • s3PrefixType

      CreateAccessGrantRequest.Builder s3PrefixType(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

      CreateAccessGrantRequest.Builder s3PrefixType(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:

    • tags

      CreateAccessGrantRequest.Builder tags(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.

    • tags

      CreateAccessGrantRequest.Builder tags(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.

    • tags

      CreateAccessGrantRequest.Builder tags(Consumer<Tag.Builder>... 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

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

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