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

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

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

Overview

Note:

When passing PublicAccessBlockConfiguration as input to an Aws::Client method, you can use a vanilla 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 Simple Storage Service Developer Guide.

Returned by:

See Also:

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

    Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket.

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

    Specifies whether Amazon S3 should block public bucket policies for this bucket.

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

    Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.

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

    Specifies whether Amazon S3 should restrict public bucket policies for this bucket.