[ aws . license-manager ]

create-license

Description

Creates a license.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-license
--license-name <value>
--product-name <value>
--product-sku <value>
--issuer <value>
--home-region <value>
--validity <value>
--entitlements <value>
--beneficiary <value>
--consumption-configuration <value>
[--license-metadata <value>]
--client-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--license-name (string)

License name.

--product-name (string)

Product name.

--product-sku (string)

Product SKU.

--issuer (structure)

License issuer.

Name -> (string)

Issuer name.

SignKey -> (string)

Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

Shorthand Syntax:

Name=string,SignKey=string

JSON Syntax:

{
  "Name": "string",
  "SignKey": "string"
}

--home-region (string)

Home Region for the license.

--validity (structure)

Date and time range during which the license is valid, in ISO8601-UTC format.

Begin -> (string)

Start of the time range.

End -> (string)

End of the time range.

Shorthand Syntax:

Begin=string,End=string

JSON Syntax:

{
  "Begin": "string",
  "End": "string"
}

--entitlements (list)

License entitlements.

(structure)

Describes a resource entitled for use with a license.

Name -> (string)

Entitlement name.

Value -> (string)

Entitlement resource. Use only if the unit is None.

MaxCount -> (long)

Maximum entitlement count. Use if the unit is not None.

Overage -> (boolean)

Indicates whether overages are allowed.

Unit -> (string)

Entitlement unit.

AllowCheckIn -> (boolean)

Indicates whether check-ins are allowed.

Shorthand Syntax:

Name=string,Value=string,MaxCount=long,Overage=boolean,Unit=string,AllowCheckIn=boolean ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string",
    "MaxCount": long,
    "Overage": true|false,
    "Unit": "Count"|"None"|"Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second",
    "AllowCheckIn": true|false
  }
  ...
]

--beneficiary (string)

License beneficiary.

--consumption-configuration (structure)

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.

RenewType -> (string)

Renewal frequency.

ProvisionalConfiguration -> (structure)

Details about a provisional configuration.

MaxTimeToLiveInMinutes -> (integer)

Maximum time for the provisional configuration, in minutes.

BorrowConfiguration -> (structure)

Details about a borrow configuration.

AllowEarlyCheckIn -> (boolean)

Indicates whether early check-ins are allowed.

MaxTimeToLiveInMinutes -> (integer)

Maximum time for the borrow configuration, in minutes.

Shorthand Syntax:

RenewType=string,ProvisionalConfiguration={MaxTimeToLiveInMinutes=integer},BorrowConfiguration={AllowEarlyCheckIn=boolean,MaxTimeToLiveInMinutes=integer}

JSON Syntax:

{
  "RenewType": "None"|"Weekly"|"Monthly",
  "ProvisionalConfiguration": {
    "MaxTimeToLiveInMinutes": integer
  },
  "BorrowConfiguration": {
    "AllowEarlyCheckIn": true|false,
    "MaxTimeToLiveInMinutes": integer
  }
}

--license-metadata (list)

Information about the license.

(structure)

Describes key/value pairs.

Name -> (string)

The key name.

Value -> (string)

The value.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

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

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

LicenseArn -> (string)

Amazon Resource Name (ARN) of the license.

Status -> (string)

License status.

Version -> (string)

License version.