license_versions

Creates, updates, deletes, gets or lists a license_versions resource.

Overview

Name	license_versions
Type	Resource
Id	aws.license_manager.license_versions

Fields

The following fields are returned by SELECT queries:

list_license_versions

Name	Datatype	Description
licenses	array	License details.
next_token	string	Token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_license_versions	select	region		Lists all versions of the specified license.
create_license_version	insert	region, LicenseArn, LicenseName, ProductName, Issuer, HomeRegion, Validity, Entitlements, ConsumptionConfiguration, ClientToken		Creates a new version of the specified license.

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

list_license_versions

Lists all versions of the specified license.

SELECT
licenses,
next_token
FROM aws.license_manager.license_versions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_license_version

Creates a new version of the specified license.

INSERT INTO aws.license_manager.license_versions (
LicenseArn,
LicenseName,
ProductName,
Issuer,
HomeRegion,
Validity,
LicenseMetadata,
Entitlements,
ConsumptionConfiguration,
Status,
ClientToken,
SourceVersion,
ResetUsage,
region
)
SELECT 
'{{ LicenseArn }}' /* required */,
'{{ LicenseName }}' /* required */,
'{{ ProductName }}' /* required */,
'{{ Issuer }}' /* required */,
'{{ HomeRegion }}' /* required */,
'{{ Validity }}' /* required */,
'{{ LicenseMetadata }}',
'{{ Entitlements }}' /* required */,
'{{ ConsumptionConfiguration }}' /* required */,
'{{ Status }}',
'{{ ClientToken }}' /* required */,
'{{ SourceVersion }}',
{{ ResetUsage }},
'{{ region }}'
RETURNING
license_arn,
status,
version
;

Manifest

# Description fields are for documentation purposes
- name: license_versions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_versions resource.
  - name: LicenseArn
    value: "{{ LicenseArn }}"
    description: |
      Amazon Resource Name (ARN) of the license.
  - name: LicenseName
    value: "{{ LicenseName }}"
    description: |
      License name.
  - name: ProductName
    value: "{{ ProductName }}"
    description: |
      Product name.
  - name: Issuer
    description: |
      License issuer.
    value:
      Name: "{{ Name }}"
      SignKey: "{{ SignKey }}"
  - name: HomeRegion
    value: "{{ HomeRegion }}"
    description: |
      Home Region of the license.
  - name: Validity
    description: |
      Date and time range during which the license is valid, in ISO8601-UTC format.
    value:
      Begin: "{{ Begin }}"
      End: "{{ End }}"
  - name: LicenseMetadata
    description: |
      Information about the license.
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"
  - name: Entitlements
    description: |
      License entitlements.
    value:
      - Name: "{{ Name }}"
        Value: "{{ Value }}"
        MaxCount: {{ MaxCount }}
        Overage: {{ Overage }}
        Unit: "{{ Unit }}"
        AllowCheckIn: {{ AllowCheckIn }}
  - name: ConsumptionConfiguration
    description: |
      Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
    value:
      RenewType: "{{ RenewType }}"
      ProvisionalConfiguration:
        MaxTimeToLiveInMinutes: {{ MaxTimeToLiveInMinutes }}
      BorrowConfiguration:
        AllowEarlyCheckIn: {{ AllowEarlyCheckIn }}
        MaxTimeToLiveInMinutes: {{ MaxTimeToLiveInMinutes }}
  - name: Status
    value: "{{ Status }}"
    description: |
      License status.
    valid_values: ['AVAILABLE', 'PENDING_AVAILABLE', 'DEACTIVATED', 'SUSPENDED', 'EXPIRED', 'PENDING_DELETE', 'DELETED']
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: SourceVersion
    value: "{{ SourceVersion }}"
    description: |
      Current version of the license.
  - name: ResetUsage
    value: {{ ResetUsage }}
    description: |
      Specifies whether to reset the license usage for the new license version. If you don't specify a value, the license usage is not reset.