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

For more information, see AWS::AppStream::Entitlement.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, StackName, AppVisibility, Attributes, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	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 awscc.appstream.entitlements
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ stack_name }}|{{ 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 awscc.appstream.entitlements (
  Name,
  StackName,
  AppVisibility,
  Attributes,
  region
)
SELECT
  '{{ name }}',
  '{{ stack_name }}',
  '{{ app_visibility }}',
  '{{ attributes }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appstream.entitlements (
  Name,
  StackName,
  Description,
  AppVisibility,
  Attributes,
  region
)
SELECT
  '{{ name }}',
  '{{ stack_name }}',
  '{{ description }}',
  '{{ app_visibility }}',
  '{{ attributes }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: stack_name
      value: '{{ stack_name }}'
    - name: description
      value: '{{ description }}'
    - name: app_visibility
      value: '{{ app_visibility }}'
    - name: attributes
      value:
        - name: '{{ name }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appstream.entitlements
SET PatchDocument = string('{{ {
    "Description": description,
    "AppVisibility": app_visibility,
    "Attributes": attributes
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ stack_name }}|{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.entitlements
WHERE
  Identifier = '{{ stack_name }}|{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

appstream:CreateEntitlement

Read

appstream:DescribeEntitlements

Update

appstream:UpdateEntitlement

Delete

appstream:DeleteEntitlement