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

Interface CreateAccessPointRequest.Builder

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

  • Method Details

    • accountId

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

      CreateAccessPointRequest.Builder name(String name)

      The name you want to assign to this access point.

      Parameters:
      name - The name you want to assign to this access point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucket

      CreateAccessPointRequest.Builder bucket(String bucket)

      The name of the bucket that you want to associate this access point with.

      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 - The name of the bucket that you want to associate this access point with.

      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.

    • vpcConfiguration

      CreateAccessPointRequest.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

      If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

      This is required for creating an access point for Amazon S3 on Outposts buckets.

      Parameters:
      vpcConfiguration - If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

      This is required for creating an access point for Amazon S3 on Outposts buckets.

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

    • vpcConfiguration

      default CreateAccessPointRequest.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

      If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

      This is required for creating an access point for Amazon S3 on Outposts buckets.

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

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

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

    • publicAccessBlockConfiguration

      CreateAccessPointRequest.Builder publicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration)

      The PublicAccessBlock configuration that you want to apply to the access point.

      Parameters:
      publicAccessBlockConfiguration - The PublicAccessBlock configuration that you want to apply to the access point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicAccessBlockConfiguration

      default CreateAccessPointRequest.Builder publicAccessBlockConfiguration(Consumer<PublicAccessBlockConfiguration.Builder> publicAccessBlockConfiguration)

      The PublicAccessBlock configuration that you want to apply to the access point.

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

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

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

    • bucketAccountId

      CreateAccessPointRequest.Builder bucketAccountId(String bucketAccountId)

      The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

      For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

      Parameters:
      bucketAccountId - The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

      For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

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

    • overrideConfiguration

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

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