Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . license-manager ]

create-license-configuration

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-license-configuration
--name <value>
[--description <value>]
--license-counting-type <value>
[--license-count <value>]
[--license-count-hard-limit | --no-license-count-hard-limit]
[--license-rules <value>]
[--tags <value>]
[--product-information-list <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

Name of the license configuration.

--description (string)

Description of the license configuration.

--license-counting-type (string)

Dimension used to track the license inventory.

Possible values:

  • vCPU
  • Instance
  • Core
  • Socket

--license-count (long)

Number of licenses managed by the license configuration.

--license-count-hard-limit | --no-license-count-hard-limit (boolean)

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

--license-rules (list)

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 | maximumCores | minimumCores | maximumSockets | minimumSockets | 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 .

(string)

Syntax:

"string" "string" ...

--tags (list)

Tags to add to the license configuration.

(structure)

Details about a tag for a license configuration.

Key -> (string)

Tag key.

Value -> (string)

Tag value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--product-information-list (list)

Product information.

(structure)

Describes product information for a license configuration.

ResourceType -> (string)

Resource type. The possible values are SSM_MANAGED | RDS .

ProductInformationFilterList -> (list)

Product information filters.

The following filters and logical operators are supported when the resource type is SSM_MANAGED :

  • Application Name - The name of the application. Logical operator is EQUALS .
  • Application Publisher - The publisher of the application. Logical operator is EQUALS .
  • Application Version - The version of the application. Logical operator is EQUALS .
  • Platform Name - The name of the platform. Logical operator is EQUALS .
  • Platform Type - The platform type. Logical operator is EQUALS .
  • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS . Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter .

The following filters and logical operators are supported when the resource type is RDS :

  • Engine Edition - The edition of the database engine. Logical operator is EQUALS . Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 .
  • License Pack - The license pack. Logical operator is EQUALS . Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap .

(structure)

Describes product information filters.

ProductInformationFilterName -> (string)

Filter name.

ProductInformationFilterValue -> (list)

Filter value.

(string)

ProductInformationFilterComparator -> (string)

Logical operator.

JSON Syntax:

[
  {
    "ResourceType": "string",
    "ProductInformationFilterList": [
      {
        "ProductInformationFilterName": "string",
        "ProductInformationFilterValue": ["string", ...],
        "ProductInformationFilterComparator": "string"
      }
      ...
    ]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Example 1: To create a license configuration

The following create-license-configuration example creates a license configuration with a hard limit of 10 cores.

aws license-manager create-license-configuration --name my-license-configuration \
    --license-counting-type Core \
    --license-count 10 \
    --license-count-hard-limit

Output:

{
  "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111"
}

Example 2: To create a license configuration

The following create-license-configuration example creates a license configuration with a soft limit of 100 vCPUs. It uses a rule to enable vCPU optimization.

aws license-manager create-license-configuration --name my-license-configuration
    --license-counting-type vCPU \
    --license-count 100 \
    --license-rules "#honorVcpuOptimization=true"

Output:

{
  "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222"
}

Output

LicenseConfigurationArn -> (string)

Amazon Resource Name (ARN) of the license configuration.