Class: Aws::S3::Types::PublicAccessBlockConfiguration

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

Overview

Note:

When making an API call, you may pass PublicAccessBlockConfiguration data as a hash:

{
  block_public_acls: false,
  ignore_public_acls: false,
  block_public_policy: false,
  restrict_public_buckets: false,
}

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. 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 S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#block_public_acls ⇒ Boolean

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ‘TRUE` causes the following behavior:

  • PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.

  • PUT Object calls fail if the request includes a public ACL.

  • PUT Bucket calls fail if the request includes a public ACL.

Enabling this setting doesn’t affect existing policies or ACLs.

Returns:

  • (Boolean) 


11227
11228
11229
11230
11231
11232
11233
11234
 
# File 'lib/aws-sdk-s3/types.rb', line 11227

class PublicAccessBlockConfiguration < Struct.new(
  :block_public_acls,
  :ignore_public_acls,
  :block_public_policy,
  :restrict_public_buckets)
  SENSITIVE = []
  include Aws::Structure
end

#block_public_policy ⇒ Boolean

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ‘TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Enabling this setting doesn’t affect existing bucket policies.

Returns:

  • (Boolean) 


11227
11228
11229
11230
11231
11232
11233
11234
 
# File 'lib/aws-sdk-s3/types.rb', line 11227

class PublicAccessBlockConfiguration < Struct.new(
  :block_public_acls,
  :ignore_public_acls,
  :block_public_policy,
  :restrict_public_buckets)
  SENSITIVE = []
  include Aws::Structure
end

#ignore_public_acls ⇒ Boolean

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ‘TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

Enabling this setting doesn’t affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set.

Returns:

  • (Boolean) 


11227
11228
11229
11230
11231
11232
11233
11234
 
# File 'lib/aws-sdk-s3/types.rb', line 11227

class PublicAccessBlockConfiguration < Struct.new(
  :block_public_acls,
  :ignore_public_acls,
  :block_public_policy,
  :restrict_public_buckets)
  SENSITIVE = []
  include Aws::Structure
end

#restrict_public_buckets ⇒ Boolean

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ‘TRUE` restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

Enabling this setting doesn’t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

Returns:

  • (Boolean) 


11227
11228
11229
11230
11231
11232
11233
11234
 
# File 'lib/aws-sdk-s3/types.rb', line 11227

class PublicAccessBlockConfiguration < Struct.new(
  :block_public_acls,
  :ignore_public_acls,
  :block_public_policy,
  :restrict_public_buckets)
  SENSITIVE = []
  include Aws::Structure
end