software.amazon.awssdk.services.s3control.model

Interface GetBucketPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetBucketPolicyRequest.Builder,GetBucketPolicyRequest>, S3ControlRequest.Builder, SdkBuilder<GetBucketPolicyRequest.Builder,GetBucketPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetBucketPolicyRequest

public static interface GetBucketPolicyRequest.Builder
extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<GetBucketPolicyRequest.Builder,GetBucketPolicyRequest>

Method Summary

Modifier and Type	Method and Description
GetBucketPolicyRequest.Builder	accountId(String accountId) The AWS account ID of the Outposts bucket.
GetBucketPolicyRequest.Builder	bucket(String bucket) Specifies the bucket.
GetBucketPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetBucketPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accountId

GetBucketPolicyRequest.Builder accountId(String accountId)

The AWS account ID of the Outposts bucket.

Parameters:

accountId - The AWS account ID of the Outposts bucket.

Returns:

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

bucket

GetBucketPolicyRequest.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 AWS 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 AWS 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.

overrideConfiguration

GetBucketPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetBucketPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder