license_configurations

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

Overview

Name	license_configurations
Type	Resource
Id	aws.license_manager.license_configurations

Fields

The following fields are returned by SELECT queries:

get_license_configuration

Name	Datatype	Description
automated_discovery_information	object	Automated discovery information.
consumed_license_summary_list	array	Summaries of the licenses consumed by resources.
consumed_licenses	integer (int64)	Number of licenses assigned to resources.
description	string	Description of the license configuration.
disassociate_when_not_found	boolean	When true, disassociates a resource when software is uninstalled.
license_configuration_arn	string	Amazon Resource Name (ARN) of the license configuration.
license_configuration_id	string	Unique ID for the license configuration.
license_count	integer (int64)	Number of available licenses.
license_count_hard_limit	boolean	Sets the number of available licenses as a hard limit.
license_counting_type	string	Dimension for which the licenses are counted. (vCPU, Instance, Core, Socket)
license_expiry	integer (int64)	License Expiry.
license_rules	array	License rules.
managed_resource_summary_list	array	Summaries of the managed resources.
name	string	Name of the license configuration.
owner_account_id	string	Account ID of the owner of the license configuration.
product_information_list	array	Product information.
status	string	License configuration status.
tags	array	Tags for the license configuration.

list_license_configurations

Name	Datatype	Description
automated_discovery_information	object	Automated discovery information.
consumed_license_summary_list	array	Summaries for licenses consumed by various resources.
consumed_licenses	integer (int64)	Number of licenses consumed.
description	string	Description of the license configuration.
disassociate_when_not_found	boolean	When true, disassociates a resource when software is uninstalled.
license_configuration_arn	string	Amazon Resource Name (ARN) of the license configuration.
license_configuration_id	string	Unique ID of the license configuration.
license_count	integer (int64)	Number of licenses managed by the license configuration.
license_count_hard_limit	boolean	Number of available licenses as a hard limit.
license_counting_type	string	Dimension to use to track the license inventory. (vCPU, Instance, Core, Socket)
license_expiry	integer (int64)	License configuration expiry time in Unix timestamp format.
license_rules	array	License rules.
managed_resource_summary_list	array	Summaries for managed resources.
name	string	Name of the license configuration.
owner_account_id	string	Account ID of the license configuration's owner.
product_information_list	array	Product information.
status	string	Status of the license configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_license_configuration	select	region		Gets detailed information about the specified license configuration.
list_license_configurations	select	region		Lists the license configurations for your account.
create_license_configuration	insert	region, LicenseCountingType		Creates a license configuration. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
update_license_configuration	update	region, LicenseConfigurationArn		Modifies the attributes of an existing license configuration.
delete_license_configuration	delete	region		Deletes the specified license configuration. You cannot delete a license configuration that is in use.

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

get_license_configuration

Gets detailed information about the specified license configuration.

SELECT
automated_discovery_information,
consumed_license_summary_list,
consumed_licenses,
description,
disassociate_when_not_found,
license_configuration_arn,
license_configuration_id,
license_count,
license_count_hard_limit,
license_counting_type,
license_expiry,
license_rules,
managed_resource_summary_list,
name,
owner_account_id,
product_information_list,
status,
tags
FROM aws.license_manager.license_configurations
WHERE region = '{{ region }}' -- required
;

list_license_configurations

Lists the license configurations for your account.

SELECT
automated_discovery_information,
consumed_license_summary_list,
consumed_licenses,
description,
disassociate_when_not_found,
license_configuration_arn,
license_configuration_id,
license_count,
license_count_hard_limit,
license_counting_type,
license_expiry,
license_rules,
managed_resource_summary_list,
name,
owner_account_id,
product_information_list,
status
FROM aws.license_manager.license_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_license_configuration

Creates a license configuration. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

INSERT INTO aws.license_manager.license_configurations (
Name,
Description,
LicenseCountingType,
LicenseCount,
LicenseCountHardLimit,
LicenseRules,
Tags,
DisassociateWhenNotFound,
ProductInformationList,
LicenseExpiry,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ LicenseCountingType }}' /* required */,
{{ LicenseCount }},
{{ LicenseCountHardLimit }},
'{{ LicenseRules }}',
'{{ Tags }}',
{{ DisassociateWhenNotFound }},
'{{ ProductInformationList }}',
{{ LicenseExpiry }},
'{{ region }}'
RETURNING
license_configuration_arn
;

Manifest

# Description fields are for documentation purposes
- name: license_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_configurations resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      Name of the license configuration.
  - name: Description
    value: "{{ Description }}"
    description: |
      Description of the license configuration.
  - name: LicenseCountingType
    value: "{{ LicenseCountingType }}"
    description: |
      Dimension used to track the license inventory.
    valid_values: ['vCPU', 'Instance', 'Core', 'Socket']
  - name: LicenseCount
    value: {{ LicenseCount }}
    description: |
      Number of licenses managed by the license configuration.
  - name: LicenseCountHardLimit
    value: {{ LicenseCountHardLimit }}
    description: |
      Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
  - name: LicenseRules
    value:
      - "{{ LicenseRules }}"
    description: |
      License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows. Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores Instances dimension: allowedTenancy | maximumVcpus | minimumVcpus Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
  - name: Tags
    description: |
      Tags to add to the license configuration.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: DisassociateWhenNotFound
    value: {{ DisassociateWhenNotFound }}
    description: |
      When true, disassociates a resource when software is uninstalled.
  - name: ProductInformationList
    description: |
      Product information.
    value:
      - ResourceType: "{{ ResourceType }}"
        ProductInformationFilterList: "{{ ProductInformationFilterList }}"
  - name: LicenseExpiry
    value: {{ LicenseExpiry }}
    description: |
      License configuration expiry.

UPDATE examples

update_license_configuration

Modifies the attributes of an existing license configuration.

UPDATE aws.license_manager.license_configurations
SET 
LicenseConfigurationArn = '{{ LicenseConfigurationArn }}',
LicenseConfigurationStatus = '{{ LicenseConfigurationStatus }}',
LicenseRules = '{{ LicenseRules }}',
LicenseCount = {{ LicenseCount }},
LicenseCountHardLimit = {{ LicenseCountHardLimit }},
Name = '{{ Name }}',
Description = '{{ Description }}',
ProductInformationList = '{{ ProductInformationList }}',
DisassociateWhenNotFound = {{ DisassociateWhenNotFound }},
LicenseExpiry = {{ LicenseExpiry }}
WHERE 
region = '{{ region }}' --required
AND LicenseConfigurationArn = '{{ LicenseConfigurationArn }}' --required;

DELETE examples

delete_license_configuration

Deletes the specified license configuration. You cannot delete a license configuration that is in use.

DELETE FROM aws.license_manager.license_configurations
WHERE region = '{{ region }}' --required
;