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

Class: Aws::S3Control::Types::PutAccessPointPolicyRequest

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

Overview

Note:

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

{
  account_id: "AccountId", # required
  name: "AccessPointName", # required
  policy: "Policy", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The AWS account ID for owner of the bucket associated with the specified access point.

Returns:

  • (String) —

    The AWS account ID for owner of the bucket associated with the specified access point.

#name ⇒ String

The name of the access point that you want to associate with the specified policy.

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

  • (String) —

    The name of the access point that you want to associate with the specified policy.

#policy ⇒ String

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    The policy that you want to apply to the specified access point.