access_grants_locations

Creates, updates, deletes or gets an access_grants_location resource or lists access_grants_locations in a region

Overview

Name	access_grants_locations
Type	Resource
Description	The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.
Id	aws.s3.access_grants_locations

Fields

Name	Datatype	Description
access_grants_location_arn	string	The Amazon Resource Name (ARN) of the specified Access Grants location.
access_grants_location_id	string	The unique identifier for the specified Access Grants location.
iam_role_arn	string	The Amazon Resource Name (ARN) of the access grant location's associated IAM role.
location_scope	string	Descriptor for where the location actually points
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all access_grants_locations in a region.

SELECT
region,
access_grants_location_arn,
access_grants_location_id,
iam_role_arn,
location_scope,
tags
FROM aws.s3.access_grants_locations
WHERE region = 'us-east-1';

Gets all properties from an individual access_grants_location.

SELECT
region,
access_grants_location_arn,
access_grants_location_id,
iam_role_arn,
location_scope,
tags
FROM aws.s3.access_grants_locations
WHERE region = 'us-east-1' AND data__Identifier = '<AccessGrantsLocationId>';

INSERT example

Use the following StackQL query and manifest file to create a new access_grants_location resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.s3.access_grants_locations (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.s3.access_grants_locations (
 IamRoleArn,
 LocationScope,
 Tags,
 region
)
SELECT 
 '{{ IamRoleArn }}',
 '{{ LocationScope }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: access_grants_location
    props:
      - name: IamRoleArn
        value: '{{ IamRoleArn }}'
      - name: LocationScope
        value: '{{ LocationScope }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.s3.access_grants_locations
WHERE data__Identifier = '<AccessGrantsLocationId>'
AND region = 'us-east-1';

Permissions

To operate on the access_grants_locations resource, the following permissions are required:

Create

s3:CreateAccessGrantsLocation,
iam:PassRole,
s3:TagResource

Read

s3:GetAccessGrantsLocation

Delete

s3:DeleteAccessGrantsLocation

List

s3:ListAccessGrantsLocations

Update

s3:UpdateAccessGrantsLocation,
s3:TagResource,
iam:PassRole