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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#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 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) 


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#bucket_account_id ⇒ String

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:

  • (String) 


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#name ⇒ String

The name you want to assign to this access point.

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ‘ZoneID` (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by `–xa-s3`. For more information, see [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html

Returns:

  • (String) 


1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#public_access_block_configuration ⇒ Types::PublicAccessBlockConfiguration

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

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#scope ⇒ Types::Scope

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see [Managing access to shared datasets in directory buckets with access points] in the *Amazon S3 User Guide*.

<note markdown=“1”> Scope is only supported for access points attached to directory buckets.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#tags ⇒ Array<Types::Tag>

An array of tags that you can apply to an access point. Tags are key-value pairs of metadata used to control access to your access points. For more information about tags, see [Using tags with Amazon S3]. For information about tagging access points, see [Using tags for attribute-based access control (ABAC)].

<note markdown=“1”> * You must have the ‘s3:TagResource` permission to create an access

point with tags for a general purpose bucket.

  • You must have the ‘s3express:TagResource` permission to create an access point with tags for a directory bucket.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html#using-tags-for-abac

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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

#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).

<note markdown=“1”> This is required for creating an access point for Amazon S3 on Outposts buckets.

</note>

Returns:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/aws-sdk-s3control/types.rb', line 1037

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