AWS SDK for C++  1.8.98
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Control::Model::PublicAccessBlockConfiguration Class Reference

#include <PublicAccessBlockConfiguration.h>

Public Member Functions

 PublicAccessBlockConfiguration ()
 
 PublicAccessBlockConfiguration (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PublicAccessBlockConfigurationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
bool GetBlockPublicAcls () const
 
bool BlockPublicAclsHasBeenSet () const
 
void SetBlockPublicAcls (bool value)
 
PublicAccessBlockConfigurationWithBlockPublicAcls (bool value)
 
bool GetIgnorePublicAcls () const
 
bool IgnorePublicAclsHasBeenSet () const
 
void SetIgnorePublicAcls (bool value)
 
PublicAccessBlockConfigurationWithIgnorePublicAcls (bool value)
 
bool GetBlockPublicPolicy () const
 
bool BlockPublicPolicyHasBeenSet () const
 
void SetBlockPublicPolicy (bool value)
 
PublicAccessBlockConfigurationWithBlockPublicPolicy (bool value)
 
bool GetRestrictPublicBuckets () const
 
bool RestrictPublicBucketsHasBeenSet () const
 
void SetRestrictPublicBuckets (bool value)
 
PublicAccessBlockConfigurationWithRestrictPublicBuckets (bool value)
 

Detailed Description

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

This is not supported for Amazon S3 on Outposts.

See Also:

AWS API Reference

Definition at line 35 of file PublicAccessBlockConfiguration.h.

Constructor & Destructor Documentation

◆ PublicAccessBlockConfiguration() [1/2]

Aws::S3Control::Model::PublicAccessBlockConfiguration::PublicAccessBlockConfiguration ( )

◆ PublicAccessBlockConfiguration() [2/2]

Aws::S3Control::Model::PublicAccessBlockConfiguration::PublicAccessBlockConfiguration ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3Control::Model::PublicAccessBlockConfiguration::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ BlockPublicAclsHasBeenSet()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::BlockPublicAclsHasBeenSet ( ) const
inline

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 67 of file PublicAccessBlockConfiguration.h.

◆ BlockPublicPolicyHasBeenSet()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::BlockPublicPolicyHasBeenSet ( ) const
inline

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 151 of file PublicAccessBlockConfiguration.h.

◆ GetBlockPublicAcls()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::GetBlockPublicAcls ( ) const
inline

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 55 of file PublicAccessBlockConfiguration.h.

◆ GetBlockPublicPolicy()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::GetBlockPublicPolicy ( ) const
inline

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 142 of file PublicAccessBlockConfiguration.h.

◆ GetIgnorePublicAcls()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::GetIgnorePublicAcls ( ) const
inline

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

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

This is not supported for Amazon S3 on Outposts.

Definition at line 102 of file PublicAccessBlockConfiguration.h.

◆ GetRestrictPublicBuckets()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::GetRestrictPublicBuckets ( ) const
inline

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

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.

This is not supported for Amazon S3 on Outposts.

Definition at line 182 of file PublicAccessBlockConfiguration.h.

◆ IgnorePublicAclsHasBeenSet()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::IgnorePublicAclsHasBeenSet ( ) const
inline

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

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

This is not supported for Amazon S3 on Outposts.

Definition at line 112 of file PublicAccessBlockConfiguration.h.

◆ operator=()

PublicAccessBlockConfiguration& Aws::S3Control::Model::PublicAccessBlockConfiguration::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ RestrictPublicBucketsHasBeenSet()

bool Aws::S3Control::Model::PublicAccessBlockConfiguration::RestrictPublicBucketsHasBeenSet ( ) const
inline

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

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.

This is not supported for Amazon S3 on Outposts.

Definition at line 194 of file PublicAccessBlockConfiguration.h.

◆ SetBlockPublicAcls()

void Aws::S3Control::Model::PublicAccessBlockConfiguration::SetBlockPublicAcls ( bool  value)
inline

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 79 of file PublicAccessBlockConfiguration.h.

◆ SetBlockPublicPolicy()

void Aws::S3Control::Model::PublicAccessBlockConfiguration::SetBlockPublicPolicy ( bool  value)
inline

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 160 of file PublicAccessBlockConfiguration.h.

◆ SetIgnorePublicAcls()

void Aws::S3Control::Model::PublicAccessBlockConfiguration::SetIgnorePublicAcls ( bool  value)
inline

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

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

This is not supported for Amazon S3 on Outposts.

Definition at line 122 of file PublicAccessBlockConfiguration.h.

◆ SetRestrictPublicBuckets()

void Aws::S3Control::Model::PublicAccessBlockConfiguration::SetRestrictPublicBuckets ( bool  value)
inline

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

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.

This is not supported for Amazon S3 on Outposts.

Definition at line 206 of file PublicAccessBlockConfiguration.h.

◆ WithBlockPublicAcls()

PublicAccessBlockConfiguration& Aws::S3Control::Model::PublicAccessBlockConfiguration::WithBlockPublicAcls ( bool  value)
inline

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 91 of file PublicAccessBlockConfiguration.h.

◆ WithBlockPublicPolicy()

PublicAccessBlockConfiguration& Aws::S3Control::Model::PublicAccessBlockConfiguration::WithBlockPublicPolicy ( bool  value)
inline

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. 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.

This is not supported for Amazon S3 on Outposts.

Definition at line 169 of file PublicAccessBlockConfiguration.h.

◆ WithIgnorePublicAcls()

PublicAccessBlockConfiguration& Aws::S3Control::Model::PublicAccessBlockConfiguration::WithIgnorePublicAcls ( bool  value)
inline

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

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

This is not supported for Amazon S3 on Outposts.

Definition at line 132 of file PublicAccessBlockConfiguration.h.

◆ WithRestrictPublicBuckets()

PublicAccessBlockConfiguration& Aws::S3Control::Model::PublicAccessBlockConfiguration::WithRestrictPublicBuckets ( bool  value)
inline

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only AWS service principals and authorized users within this account.

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.

This is not supported for Amazon S3 on Outposts.

Definition at line 218 of file PublicAccessBlockConfiguration.h.


The documentation for this class was generated from the following file: