Interface PutBucketPolicyRequest.Builder

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

  • Method Details

    • accountId

      PutBucketPolicyRequest.Builder accountId(String accountId)

      The Amazon Web Services account ID of the Outposts bucket.

      Parameters:
      accountId - The Amazon Web Services account ID of the Outposts bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucket

      PutBucketPolicyRequest.Builder bucket(String bucket)

      Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

      Parameters:
      bucket - Specifies the bucket.

      For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

      For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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

    • confirmRemoveSelfBucketAccess

      PutBucketPolicyRequest.Builder confirmRemoveSelfBucketAccess(Boolean confirmRemoveSelfBucketAccess)

      Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

      This is not supported by Amazon S3 on Outposts buckets.

      Parameters:
      confirmRemoveSelfBucketAccess - Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

      This is not supported by Amazon S3 on Outposts buckets.

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

    • policy

      PutBucketPolicyRequest.Builder policy(String policy)

      The bucket policy as a JSON document.

      Parameters:
      policy - The bucket policy as a JSON document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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