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	awscc.s3.access_grants_locations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
access_grants_location_id	string	The unique identifier for the specified Access Grants location.
region	string	AWS region.

For more information, see AWS::S3::AccessGrantsLocation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	access_grants_locations	INSERT	, region
delete_resource	access_grants_locations	DELETE	Identifier, region
update_resource	access_grants_locations	UPDATE	Identifier, PatchDocument, region
list_resources	access_grants_locations_list_only	SELECT	region
get_resource	access_grants_locations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.s3.access_grants_locations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ access_grants_location_id }}';

list (identifiers only)

Lists all access_grants_locations in a region.

SELECT
  region,
  access_grants_location_id
FROM awscc.s3.access_grants_locations_list_only
WHERE
  region = 'us-east-1';

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 awscc.s3.access_grants_locations (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.s3.access_grants_locations (
  IamRoleArn,
  LocationScope,
  Tags,
  region
)
SELECT
  '{{ iam_role_arn }}',
  '{{ location_scope }}',
  '{{ 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: iam_role_arn
        value: '{{ iam_role_arn }}'
      - name: location_scope
        value: '{{ location_scope }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.s3.access_grants_locations
SET PatchDocument = string('{{ {
    "IamRoleArn": iam_role_arn,
    "LocationScope": location_scope
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ access_grants_location_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.s3.access_grants_locations
WHERE
  Identifier = '{{ access_grants_location_id }}' 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,
s3:ListTagsForResource

Delete

s3:DeleteAccessGrantsLocation

List

s3:ListAccessGrantsLocations

Update

s3:UpdateAccessGrantsLocation,
s3:TagResource,
s3:UntagResource,
iam:PassRole