access_grants_instances

Creates, updates, deletes or gets an access_grants_instance resource or lists access_grants_instances in a region

Overview

Name	access_grants_instances
Type	Resource
Description	The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations
Id	aws.s3.access_grants_instances

Fields

Name	Datatype	Description
access_grants_instance_arn	string	The Amazon Resource Name (ARN) of the specified Access Grants instance.
identity_center_arn	string	The Amazon Resource Name (ARN) of the specified AWS Identity Center.
access_grants_instance_id	string	A unique identifier for the specified access grants instance.
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_instances in a region.

SELECT
region,
access_grants_instance_arn,
identity_center_arn,
access_grants_instance_id,
tags
FROM aws.s3.access_grants_instances
WHERE region = 'us-east-1';

Gets all properties from an individual access_grants_instance.

SELECT
region,
access_grants_instance_arn,
identity_center_arn,
access_grants_instance_id,
tags
FROM aws.s3.access_grants_instances
WHERE region = 'us-east-1' AND data__Identifier = '<AccessGrantsInstanceArn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Create

s3:CreateAccessGrantsInstance,
s3:TagResource

Read

s3:GetAccessGrantsInstance

Delete

s3:DeleteAccessGrantsInstance

Update

s3:TagResource

List

s3:ListAccessGrantsInstances