licenses

Creates, updates, deletes or gets a license resource or lists licenses in a region

Overview

Name	licenses
Type	Resource
Description	Resource Type definition for AWS::LicenseManager::License
Id	aws.licensemanager.licenses

Fields

Name	Datatype	Description
product_sku	string	ProductSKU of the license.
issuer	object
license_name	string	Name for the created license.
product_name	string	Product name for the created license.
home_region	string	Home region for the created license.
validity	object
entitlements	array
beneficiary	string	Beneficiary of the license.
consumption_configuration	object
license_metadata	array
license_arn	string	Amazon Resource Name is a unique name for each resource.
status	string
version	string	The version of the license.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LicenseName, ProductName, Issuer, HomeRegion, Validity, ConsumptionConfiguration, Entitlements, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all licenses in a region.

SELECT
region,
product_sku,
issuer,
license_name,
product_name,
home_region,
validity,
entitlements,
beneficiary,
consumption_configuration,
license_metadata,
license_arn,
status,
version
FROM aws.licensemanager.licenses
WHERE region = 'us-east-1';

Gets all properties from an individual license.

SELECT
region,
product_sku,
issuer,
license_name,
product_name,
home_region,
validity,
entitlements,
beneficiary,
consumption_configuration,
license_metadata,
license_arn,
status,
version
FROM aws.licensemanager.licenses
WHERE region = 'us-east-1' AND data__Identifier = '<LicenseArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.licensemanager.licenses (
 Issuer,
 LicenseName,
 ProductName,
 HomeRegion,
 Validity,
 Entitlements,
 ConsumptionConfiguration,
 region
)
SELECT 
'{{ Issuer }}',
 '{{ LicenseName }}',
 '{{ ProductName }}',
 '{{ HomeRegion }}',
 '{{ Validity }}',
 '{{ Entitlements }}',
 '{{ ConsumptionConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.licensemanager.licenses (
 ProductSKU,
 Issuer,
 LicenseName,
 ProductName,
 HomeRegion,
 Validity,
 Entitlements,
 Beneficiary,
 ConsumptionConfiguration,
 LicenseMetadata,
 Status,
 region
)
SELECT 
 '{{ ProductSKU }}',
 '{{ Issuer }}',
 '{{ LicenseName }}',
 '{{ ProductName }}',
 '{{ HomeRegion }}',
 '{{ Validity }}',
 '{{ Entitlements }}',
 '{{ Beneficiary }}',
 '{{ ConsumptionConfiguration }}',
 '{{ LicenseMetadata }}',
 '{{ Status }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: license
    props:
      - name: ProductSKU
        value: '{{ ProductSKU }}'
      - name: Issuer
        value:
          Name: '{{ Name }}'
          SignKey: '{{ SignKey }}'
      - name: LicenseName
        value: '{{ LicenseName }}'
      - name: ProductName
        value: '{{ ProductName }}'
      - name: HomeRegion
        value: '{{ HomeRegion }}'
      - name: Validity
        value:
          Begin: '{{ Begin }}'
          End: '{{ End }}'
      - name: Entitlements
        value:
          - Name: '{{ Name }}'
            Value: '{{ Value }}'
            MaxCount: '{{ MaxCount }}'
            Overage: '{{ Overage }}'
            Unit: '{{ Unit }}'
            AllowCheckIn: '{{ AllowCheckIn }}'
      - name: Beneficiary
        value: '{{ Beneficiary }}'
      - name: ConsumptionConfiguration
        value:
          RenewType: '{{ RenewType }}'
          ProvisionalConfiguration:
            MaxTimeToLiveInMinutes: '{{ MaxTimeToLiveInMinutes }}'
          BorrowConfiguration:
            MaxTimeToLiveInMinutes: '{{ MaxTimeToLiveInMinutes }}'
            AllowEarlyCheckIn: '{{ AllowEarlyCheckIn }}'
      - name: LicenseMetadata
        value:
          - Name: '{{ Name }}'
            Value: '{{ Value }}'
      - name: Status
        value: '{{ Status }}'

DELETE example

/*+ delete */
DELETE FROM aws.licensemanager.licenses
WHERE data__Identifier = '<LicenseArn>'
AND region = 'us-east-1';

Permissions

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

Create

license-manager:CreateLicense

Read

license-manager:GetLicense

Update

license-manager:CreateLicenseVersion

Delete

license-manager:DeleteLicense

List

license-manager:ListLicenses