AWS SDK for C++  1.9.153
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::AccessRules Class Reference

#include <AccessRules.h>

Public Member Functions

 AccessRules ()
 
 AccessRules (Aws::Utils::Json::JsonView jsonValue)
 
AccessRulesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AccessTypeGetGetObject () const
 
bool GetObjectHasBeenSet () const
 
void SetGetObject (const AccessType &value)
 
void SetGetObject (AccessType &&value)
 
AccessRulesWithGetObject (const AccessType &value)
 
AccessRulesWithGetObject (AccessType &&value)
 
bool GetAllowPublicOverrides () const
 
bool AllowPublicOverridesHasBeenSet () const
 
void SetAllowPublicOverrides (bool value)
 
AccessRulesWithAllowPublicOverrides (bool value)
 

Detailed Description

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

Amazon Lightsail Developer Guide.

See Also:

AWS API Reference

Definition at line 35 of file AccessRules.h.

Constructor & Destructor Documentation

◆ AccessRules() [1/2]

Aws::Lightsail::Model::AccessRules::AccessRules ( )

◆ AccessRules() [2/2]

Aws::Lightsail::Model::AccessRules::AccessRules ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AllowPublicOverridesHasBeenSet()

bool Aws::Lightsail::Model::AccessRules::AllowPublicOverridesHasBeenSet ( ) const
inline

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

Definition at line 169 of file AccessRules.h.

◆ GetAllowPublicOverrides()

bool Aws::Lightsail::Model::AccessRules::GetAllowPublicOverrides ( ) const
inline

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

Definition at line 157 of file AccessRules.h.

◆ GetGetObject()

const AccessType& Aws::Lightsail::Model::AccessRules::GetGetObject ( ) const
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 59 of file AccessRules.h.

◆ GetObjectHasBeenSet()

bool Aws::Lightsail::Model::AccessRules::GetObjectHasBeenSet ( ) const
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 76 of file AccessRules.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::AccessRules::Jsonize ( ) const

◆ operator=()

AccessRules& Aws::Lightsail::Model::AccessRules::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAllowPublicOverrides()

void Aws::Lightsail::Model::AccessRules::SetAllowPublicOverrides ( bool  value)
inline

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

Definition at line 181 of file AccessRules.h.

◆ SetGetObject() [1/2]

void Aws::Lightsail::Model::AccessRules::SetGetObject ( AccessType &&  value)
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 110 of file AccessRules.h.

◆ SetGetObject() [2/2]

void Aws::Lightsail::Model::AccessRules::SetGetObject ( const AccessType value)
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 93 of file AccessRules.h.

◆ WithAllowPublicOverrides()

AccessRules& Aws::Lightsail::Model::AccessRules::WithAllowPublicOverrides ( bool  value)
inline

A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

Definition at line 193 of file AccessRules.h.

◆ WithGetObject() [1/2]

AccessRules& Aws::Lightsail::Model::AccessRules::WithGetObject ( AccessType &&  value)
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 144 of file AccessRules.h.

◆ WithGetObject() [2/2]

AccessRules& Aws::Lightsail::Model::AccessRules::WithGetObject ( const AccessType value)
inline

Specifies the anonymous access to all objects in a bucket.

The following options can be specified:

  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

    If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

    If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

Definition at line 127 of file AccessRules.h.


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