Class: Aws::S3Control::Types::PutBucketPolicyRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID of the Outposts bucket.

Returns:

  • (String)


6671
6672
6673
6674
6675
6676
6677
6678
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6671

class PutBucketPolicyRequest < Struct.new(
  :account_id,
  :bucket,
  :confirm_remove_self_bucket_access,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#bucket ⇒ String

Specifies the bucket.

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)


6671
6672
6673
6674
6675
6676
6677
6678
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6671

class PutBucketPolicyRequest < Struct.new(
  :account_id,
  :bucket,
  :confirm_remove_self_bucket_access,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#confirm_remove_self_bucket_access ⇒ Boolean

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This is not supported by Amazon S3 on Outposts buckets.

Returns:

  • (Boolean)


6671
6672
6673
6674
6675
6676
6677
6678
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6671

class PutBucketPolicyRequest < Struct.new(
  :account_id,
  :bucket,
  :confirm_remove_self_bucket_access,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

The bucket policy as a JSON document.

Returns:

  • (String)


6671
6672
6673
6674
6675
6676
6677
6678
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6671

class PutBucketPolicyRequest < Struct.new(
  :account_id,
  :bucket,
  :confirm_remove_self_bucket_access,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end