entitlements

Creates, updates, deletes, gets or lists an entitlements resource.

Overview

Name	entitlements
Type	Resource
Id	aws.appstream.entitlements

Fields

The following fields are returned by SELECT queries:

describe_entitlements

Name	Datatype	Description
entitlements	array	The entitlements.
next_token	string	The pagination token used to retrieve the next page of results for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_entitlements	select	region		Retrieves a list that describes one of more entitlements.
create_entitlement	insert	region, Name, StackName, AppVisibility, Attributes		Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. WorkSpaces Applications user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
associate_application_to_entitlement	update	region, StackName, EntitlementName, ApplicationIdentifier		Associates an application to entitle.
update_entitlement	update	region, Name, StackName		Updates the specified entitlement.
delete_entitlement	delete	region		Deletes the specified entitlement.
disassociate_application_from_entitlement	exec	region, StackName, EntitlementName, ApplicationIdentifier		Deletes the specified application from the specified entitlement.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_entitlements

Retrieves a list that describes one of more entitlements.

SELECT
entitlements,
next_token
FROM aws.appstream.entitlements
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_entitlement

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. WorkSpaces Applications user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

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

Manifest

# Description fields are for documentation purposes
- name: entitlements
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the entitlements resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the entitlement.
  - name: StackName
    value: "{{ StackName }}"
    description: |
      The name of the stack with which the entitlement is associated.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the entitlement.
  - name: AppVisibility
    value: "{{ AppVisibility }}"
    description: |
      Specifies whether all or selected apps are entitled.
    valid_values: ['ALL', 'ASSOCIATED']
  - name: Attributes
    description: |
      The attributes of the entitlement.
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"

UPDATE examples

associate_application_to_entitlement

Associates an application to entitle.

UPDATE aws.appstream.entitlements
SET 
StackName = '{{ StackName }}',
EntitlementName = '{{ EntitlementName }}',
ApplicationIdentifier = '{{ ApplicationIdentifier }}'
WHERE 
region = '{{ region }}' --required
AND StackName = '{{ StackName }}' --required
AND EntitlementName = '{{ EntitlementName }}' --required
AND ApplicationIdentifier = '{{ ApplicationIdentifier }}' --required;

update_entitlement

Updates the specified entitlement.

UPDATE aws.appstream.entitlements
SET 
Name = '{{ Name }}',
StackName = '{{ StackName }}',
Description = '{{ Description }}',
AppVisibility = '{{ AppVisibility }}',
Attributes = '{{ Attributes }}'
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND StackName = '{{ StackName }}' --required
RETURNING
entitlement;

DELETE examples

delete_entitlement

Deletes the specified entitlement.

DELETE FROM aws.appstream.entitlements
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_application_from_entitlement

Deletes the specified application from the specified entitlement.

EXEC aws.appstream.entitlements.disassociate_application_from_entitlement 
@region='{{ region }}' --required 
@@json=
'{
"StackName": "{{ StackName }}", 
"EntitlementName": "{{ EntitlementName }}", 
"ApplicationIdentifier": "{{ ApplicationIdentifier }}"
}'
;