You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3Control::Types::CreateAccessPointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAccessPointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  account_id: "AccountId", # required
  name: "AccessPointName", # required
  bucket: "BucketName", # required
  vpc_configuration: {
    vpc_id: "VpcId", # required
  },
  public_access_block_configuration: {
    block_public_acls: false,
    ignore_public_acls: false,
    block_public_policy: false,
    restrict_public_buckets: false,
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The AWS account ID for the owner of the bucket for which you want to create an access point.

Returns:

  • (String) —

    The AWS account ID for the owner of the bucket for which you want to create an access point.

#bucket ⇒ String

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

  • (String) —

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

#name ⇒ String

The name you want to assign to this access point.

Returns:

  • (String) —

    The name you want to assign to this access point.

#public_access_block_configuration ⇒ Types::PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon Simple Storage Service Developer Guide.

This is not supported for Amazon S3 on Outposts.

Returns:

#vpc_configuration ⇒ Types::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:

  • (Types::VpcConfiguration) —

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