application_entitlement_associations

Creates, updates, deletes or gets an application_entitlement_association resource or lists application_entitlement_associations in a region

Overview

Name	application_entitlement_associations
Type	Resource
Description	Resource Type definition for AWS::AppStream::ApplicationEntitlementAssociation
Id	awscc.appstream.application_entitlement_associations

Fields

Name	Datatype	Description
stack_name	string
entitlement_name	string
application_identifier	string
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StackName, EntitlementName, ApplicationIdentifier, region
delete_resource	DELETE	Identifier, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual application_entitlement_association.

SELECT
  region,
  stack_name,
  entitlement_name,
  application_identifier
FROM awscc.appstream.application_entitlement_associations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ stack_name }}|{{ entitlement_name }}|{{ application_identifier }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appstream.application_entitlement_associations (
  StackName,
  EntitlementName,
  ApplicationIdentifier,
  region
)
SELECT
  '{{ stack_name }}',
  '{{ entitlement_name }}',
  '{{ application_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appstream.application_entitlement_associations (
  StackName,
  EntitlementName,
  ApplicationIdentifier,
  region
)
SELECT
  '{{ stack_name }}',
  '{{ entitlement_name }}',
  '{{ application_identifier }}',
  '{{ 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: application_entitlement_association
  props:
    - name: stack_name
      value: '{{ stack_name }}'
    - name: entitlement_name
      value: '{{ entitlement_name }}'
    - name: application_identifier
      value: '{{ application_identifier }}'

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.application_entitlement_associations
WHERE
  Identifier = '{{ stack_name }}|{{ entitlement_name }}|{{ application_identifier }}' 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 application_entitlement_associations resource, the following permissions are required:

Create

appstream:AssociateApplicationToEntitlement,
appstream:ListEntitledApplications

Read

appstream:ListEntitledApplications

Delete

appstream:DisassociateApplicationFromEntitlement,
appstream:ListEntitledApplications