grants

Creates, updates, deletes or gets a grant resource or lists grants in a region

Overview

Name	grants
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	awscc.licensemanager.grants

Fields

get (all properties)

Name	Datatype	Description
grant_arn	string	Arn of the grant.
grant_name	string	Name for the created Grant.
home_region	string	Home region for the created grant.
version	string	The version of the grant.
allowed_operations	array
principals	array
status	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
grant_arn	string	Arn of the grant.
region	string	AWS region.

For more information, see AWS::LicenseManager::Grant.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual grant.

SELECT
  region,
  grant_arn,
  grant_name,
  license_arn,
  home_region,
  version,
  allowed_operations,
  principals,
  status
FROM awscc.licensemanager.grants
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ grant_arn }}';

list (identifiers only)

Lists all grants in a region.

SELECT
  region,
  grant_arn
FROM awscc.licensemanager.grants_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.licensemanager.grants (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.licensemanager.grants (
  GrantName,
  LicenseArn,
  HomeRegion,
  AllowedOperations,
  Principals,
  Status,
  region
)
SELECT
  '{{ grant_name }}',
  '{{ license_arn }}',
  '{{ home_region }}',
  '{{ allowed_operations }}',
  '{{ principals }}',
  '{{ status }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: grant
    props:
      - name: grant_name
        value: '{{ grant_name }}'
      - name: license_arn
        value: '{{ license_arn }}'
      - name: home_region
        value: '{{ home_region }}'
      - name: allowed_operations
        value:
          - '{{ allowed_operations[0] }}'
      - name: principals
        value:
          - null
      - name: status
        value: '{{ status }}'

UPDATE example

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

/*+ update */
UPDATE awscc.licensemanager.grants
SET PatchDocument = string('{{ {
    "GrantName": grant_name,
    "LicenseArn": license_arn,
    "HomeRegion": home_region,
    "AllowedOperations": allowed_operations,
    "Principals": principals,
    "Status": status
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ grant_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.licensemanager.grants
WHERE
  Identifier = '{{ grant_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

license-manager:CreateGrant

Read

license-manager:GetGrant

Update

license-manager:CreateGrantVersion

Delete

license-manager:DeleteGrant

List

license-manager:ListDistributedGrants