CreateLicenseConfiguration - AWS License Manager

CreateLicenseConfiguration

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.

Request Syntax

{ "Description": "string", "DisassociateWhenNotFound": boolean, "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "Name": "string", "ProductInformationList": [ { "ProductInformationFilterList": [ { "ProductInformationFilterComparator": "string", "ProductInformationFilterName": "string", "ProductInformationFilterValue": [ "string" ] } ], "ResourceType": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

Description of the license configuration.

Type: String

Required: No

DisassociateWhenNotFound

When true, disassociates a resource when software is uninstalled.

Type: Boolean

Required: No

LicenseCount

Number of licenses managed by the license configuration.

Type: Long

Required: No

LicenseCountHardLimit

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

Type: Boolean

Required: No

LicenseCountingType

Dimension used to track the license inventory.

Type: String

Valid Values: vCPU | Instance | Core | Socket

Required: Yes

LicenseRules

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.

Type: Array of strings

Required: No

Name

Name of the license configuration.

Type: String

Required: Yes

ProductInformationList

Product information.

Type: Array of ProductInformation objects

Required: No

Tags

Tags to add to the license configuration.

Type: Array of Tag objects

Required: No

Response Syntax

{ "LicenseConfigurationArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400

AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400

ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: