license_asset_groups

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

Overview

Name	license_asset_groups
Type	Resource
Id	aws.license_manager.license_asset_groups

Fields

The following fields are returned by SELECT queries:

get_license_asset_group

Name	Datatype	Description
associated_license_asset_ruleset_arns	array	ARNs of associated license asset rulesets.
description	string	License asset group description.
latest_resource_discovery_time	string (date-time)	Latest resource discovery time.
latest_usage_analysis_time	string (date-time)	Latest usage analysis time.
license_asset_group_arn	string	Amazon Resource Name (ARN) of the license asset group. (pattern: <code>^arn:aws[a-zA-Z-]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>)
license_asset_group_configurations	array	License asset group configurations.
name	string	License asset group name.
properties	array	License asset group properties.
status	string	License asset group status. (ACTIVE, DISABLED, DELETED)
status_message	string	License asset group status message.

list_license_asset_groups

Name	Datatype	Description
license_asset_groups	array	License asset groups.
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
get_license_asset_group	select	region		Gets a license asset group.
list_license_asset_groups	select	region		Lists license asset groups.
create_license_asset_group	insert	region, Name, LicenseAssetGroupConfigurations, AssociatedLicenseAssetRulesetARNs, ClientToken		Creates a license asset group.
update_license_asset_group	update	region, AssociatedLicenseAssetRulesetARNs, LicenseAssetGroupArn, ClientToken		Updates a license asset group.
delete_license_asset_group	delete	region		Deletes a license asset group.

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_asset_group

Gets a license asset group.

SELECT
associated_license_asset_ruleset_arns,
description,
latest_resource_discovery_time,
latest_usage_analysis_time,
license_asset_group_arn,
license_asset_group_configurations,
name,
properties,
status,
status_message
FROM aws.license_manager.license_asset_groups
WHERE region = '{{ region }}' -- required
;

list_license_asset_groups

Lists license asset groups.

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

INSERT examples

create_license_asset_group

Creates a license asset group.

INSERT INTO aws.license_manager.license_asset_groups (
Name,
Description,
LicenseAssetGroupConfigurations,
AssociatedLicenseAssetRulesetARNs,
Properties,
Tags,
ClientToken,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ LicenseAssetGroupConfigurations }}' /* required */,
'{{ AssociatedLicenseAssetRulesetARNs }}' /* required */,
'{{ Properties }}',
'{{ Tags }}',
'{{ ClientToken }}' /* required */,
'{{ region }}'
RETURNING
license_asset_group_arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: license_asset_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the license_asset_groups resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      License asset group name.
  - name: Description
    value: "{{ Description }}"
    description: |
      License asset group description.
  - name: LicenseAssetGroupConfigurations
    description: |
      License asset group configurations.
    value:
      - UsageDimension: "{{ UsageDimension }}"
  - name: AssociatedLicenseAssetRulesetARNs
    value:
      - "{{ AssociatedLicenseAssetRulesetARNs }}"
    description: |
      ARNs of associated license asset rulesets.
  - name: Properties
    description: |
      License asset group properties.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Tags
    description: |
      Tags to add to the license asset group.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

UPDATE examples

update_license_asset_group

Updates a license asset group.

UPDATE aws.license_manager.license_asset_groups
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
LicenseAssetGroupConfigurations = '{{ LicenseAssetGroupConfigurations }}',
AssociatedLicenseAssetRulesetARNs = '{{ AssociatedLicenseAssetRulesetARNs }}',
Properties = '{{ Properties }}',
LicenseAssetGroupArn = '{{ LicenseAssetGroupArn }}',
Status = '{{ Status }}',
ClientToken = '{{ ClientToken }}'
WHERE 
region = '{{ region }}' --required
AND AssociatedLicenseAssetRulesetARNs = '{{ AssociatedLicenseAssetRulesetARNs }}' --required
AND LicenseAssetGroupArn = '{{ LicenseAssetGroupArn }}' --required
AND ClientToken = '{{ ClientToken }}' --required
RETURNING
license_asset_group_arn,
status;

DELETE examples

delete_license_asset_group

Deletes a license asset group.

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