entitlements

Creates, updates, deletes or gets an entitlement resource or lists entitlements in a region

Overview

Name	entitlements
Type	Resource
Description	Resource Type definition for AWS::AppStream::Entitlement
Id	aws.appstream.entitlements

Fields

Name	Datatype	Description
name	string
stack_name	string
description	string
app_visibility	string
attributes	array
created_time	string
last_modified_time	string
region	string	AWS region.

Methods

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

SELECT examples

Gets all properties from an individual entitlement.

SELECT
region,
name,
stack_name,
description,
app_visibility,
attributes,
created_time,
last_modified_time
FROM aws.appstream.entitlements
WHERE region = 'us-east-1' AND data__Identifier = '<StackName>|<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appstream.entitlements (
 Name,
 StackName,
 AppVisibility,
 Attributes,
 region
)
SELECT 
'{{ Name }}',
 '{{ StackName }}',
 '{{ AppVisibility }}',
 '{{ Attributes }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appstream.entitlements (
 Name,
 StackName,
 Description,
 AppVisibility,
 Attributes,
 region
)
SELECT 
 '{{ Name }}',
 '{{ StackName }}',
 '{{ Description }}',
 '{{ AppVisibility }}',
 '{{ Attributes }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: entitlement
    props:
      - name: Name
        value: '{{ Name }}'
      - name: StackName
        value: '{{ StackName }}'
      - name: Description
        value: '{{ Description }}'
      - name: AppVisibility
        value: '{{ AppVisibility }}'
      - name: Attributes
        value:
          - Name: '{{ Name }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.appstream.entitlements
WHERE data__Identifier = '<StackName|Name>'
AND region = 'us-east-1';

Permissions

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

Create

appstream:CreateEntitlement

Read

appstream:DescribeEntitlements

Update

appstream:UpdateEntitlement

Delete

appstream:DeleteEntitlement