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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
access_grants_instance_arn	string	The Amazon Resource Name (ARN) of the specified Access Grants instance.
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual access_grants_instance.

SELECT
  region,
  access_grants_instance_arn,
  identity_center_arn,
  access_grants_instance_id,
  tags
FROM awscc.s3.access_grants_instances
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ access_grants_instance_arn }}';

list (identifiers only)

Lists all access_grants_instances in a region.

SELECT
  region,
  access_grants_instance_arn
FROM awscc.s3.access_grants_instances_list_only
WHERE
  region = 'us-east-1';

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

All Properties

/*+ create */
INSERT INTO awscc.s3.access_grants_instances (
  IdentityCenterArn,
  Tags,
  region
)
SELECT
  '{{ identity_center_arn }}',
  '{{ 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: identity_center_arn
        value: '{{ identity_center_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.s3.access_grants_instances
SET PatchDocument = string('{{ {
    "IdentityCenterArn": identity_center_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ access_grants_instance_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.s3.access_grants_instances
WHERE
  Identifier = '{{ access_grants_instance_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

s3:CreateAccessGrantsInstance,
s3:AssociateAccessGrantsIdentityCenter,
s3:TagResource

Read

s3:GetAccessGrantsInstance,
s3:ListTagsForResource

Delete

s3:GetAccessGrantsInstance,
s3:DeleteAccessGrantsInstance,
s3:DissociateAccessGrantsIdentityCenter

Update

s3:TagResource,
s3:UntagResource

List

s3:ListAccessGrantsInstances