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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

When making an API call, you may pass CreateAccessPointRequest data as a 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,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

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

Returns:

  • (String)


526
527
528
529
530
531
532
533
534
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 526

class CreateAccessPointRequest < Struct.new(
  :account_id,
  :name,
  :bucket,
  :vpc_configuration,
  :public_access_block_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#bucketString

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:

  • (String)


526
527
528
529
530
531
532
533
534
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 526

class CreateAccessPointRequest < Struct.new(
  :account_id,
  :name,
  :bucket,
  :vpc_configuration,
  :public_access_block_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name you want to assign to this access point.

Returns:

  • (String)


526
527
528
529
530
531
532
533
534
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 526

class CreateAccessPointRequest < Struct.new(
  :account_id,
  :name,
  :bucket,
  :vpc_configuration,
  :public_access_block_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#public_access_block_configurationTypes::PublicAccessBlockConfiguration

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



526
527
528
529
530
531
532
533
534
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 526

class CreateAccessPointRequest < Struct.new(
  :account_id,
  :name,
  :bucket,
  :vpc_configuration,
  :public_access_block_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::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.



526
527
528
529
530
531
532
533
534
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 526

class CreateAccessPointRequest < Struct.new(
  :account_id,
  :name,
  :bucket,
  :vpc_configuration,
  :public_access_block_configuration)
  SENSITIVE = []
  include Aws::Structure
end