acl_configurations
Creates, updates, deletes, gets or lists an acl_configurations resource.
Overview
| Name | acl_configurations |
| Type | Resource |
| Id | linode.object_storage.acl_configurations |
Fields
The following fields are returned by SELECT queries:
- get
The Object's canned ACL and policy.
| Name | Datatype | Description |
|---|---|---|
acl | string | The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL. (private, public-read, authenticated-read, public-read-write, custom) (example: public-read) |
acl_xml | string | The full XML of the object's ACL policy. (example: <AccessControlPolicy>...</AccessControlPolicy>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, regionId, bucket | View a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects and specify the level of access granted to those users. > 📘 > > You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes. <br /> object_storage:read_only<br /> Learn more... | |
update | replace | regionId, bucket, acl, name | Update a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects, and specify the level of access granted to those users. > 📘 > > You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes. <br /> object_storage:read_write<br /> Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
bucket | string | The bucket name. (example: {{bucket}}) |
name | string | The name of a specific object to get its access control list (ACL) details. Run the List Object Storage bucket contents operation to access all object names in a bucket. (example: {{name}}) |
regionId | string | Identifies a region where this bucket lives. > 📘 > > You can use a clusterId in place of regionId in requests for buckets that you created using the legacy version of the API. Run List clusters to see each cluster id. |
SELECT examples
- get
View a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects and specify the level of access granted to those users.
> 📘
>
> You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes.
<br /> object_storage:read_only<br />
Learn more...
SELECT
acl,
acl_xml
FROM linode.object_storage.acl_configurations
WHERE name = '{{ name }}' -- required
AND regionId = '{{ regionId }}' -- required
AND bucket = '{{ bucket }}' -- required
;
REPLACE examples
- update
Update a specific object's access control list (ACL) settings. ACLs define who can access your buckets and objects, and specify the level of access granted to those users.
> 📘
>
> You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes.
<br /> object_storage:read_write<br />
Learn more...
REPLACE linode.object_storage.acl_configurations
SET
acl = '{{ acl }}',
name = '{{ name }}'
WHERE
regionId = '{{ regionId }}' --required
AND bucket = '{{ bucket }}' --required
AND acl = '{{ acl }}' --required
AND name = '{{ name }}' --required
RETURNING
bucket,
message,
regionId;