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

Interface GetAccessPointRequest.Builder

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

  • Method Details

    • accountId

      GetAccessPointRequest.Builder accountId(String accountId)

      The Amazon Web Services account ID for the account that owns the specified access point.

      Parameters:
      accountId - The Amazon Web Services account ID for the account that owns the specified access point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetAccessPointRequest.Builder name(String name)

      The name of the access point whose configuration information you want to retrieve.

      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 access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.

      Parameters:
      name - The name of the access point whose configuration information you want to retrieve.

      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 access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.

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

    • overrideConfiguration

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

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