Class: Aws::Lightsail::Types::AccessRules

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

Overview

Note:

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

{
  get_object: "public", # accepts public, private
  allow_public_overrides: false,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_public_overridesBoolean

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.

Returns:

  • (Boolean)


198
199
200
201
202
203
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 198

class AccessRules < Struct.new(
  :get_object,
  :allow_public_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#get_objectString

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.

Returns:

  • (String)


198
199
200
201
202
203
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 198

class AccessRules < Struct.new(
  :get_object,
  :allow_public_overrides)
  SENSITIVE = []
  include Aws::Structure
end