AWS::LicenseManager::License

Specifies a granted license.

Granted licenses are licenses for products that your organization purchased from AWS Marketplace or directly from a seller who integrated their software with managed entitlements. For more information, see Granted licenses in the AWS License Manager User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::LicenseManager::License",
  "Properties" : {
      "Beneficiary" : String,
      "ConsumptionConfiguration" : ConsumptionConfiguration,
      "Entitlements" : [ Entitlement, ... ],
      "HomeRegion" : String,
      "Issuer" : IssuerData,
      "LicenseMetadata" : [ Metadata, ... ],
      "LicenseName" : String,
      "ProductName" : String,
      "ProductSKU" : String,
      "Status" : String,
      "Validity" : ValidityDateFormat
    }
}

YAML

Type: AWS::LicenseManager::License
Properties:
  Beneficiary: String
  ConsumptionConfiguration: 
    ConsumptionConfiguration
  Entitlements: 
    - Entitlement
  HomeRegion: String
  Issuer: 
    IssuerData
  LicenseMetadata: 
    - Metadata
  LicenseName: String
  ProductName: String
  ProductSKU: String
  Status: String
  Validity: 
    ValidityDateFormat

Properties

Beneficiary

License beneficiary.

Required: No

Type: String

Update requires: No interruption

ConsumptionConfiguration

Configuration for consumption of the license.

Required: Yes

Type: ConsumptionConfiguration

Update requires: No interruption

Entitlements

License entitlements.

Required: Yes

Type: Array of Entitlement

Update requires: No interruption

HomeRegion

Home Region of the license.

Required: Yes

Type: String

Update requires: No interruption

Issuer

License issuer.

Required: Yes

Type: IssuerData

Update requires: No interruption

LicenseMetadata

License metadata.

Required: No

Type: Array of Metadata

Update requires: No interruption

LicenseName

License name.

Required: Yes

Type: String

Update requires: No interruption

ProductName

Product name.

Required: Yes

Type: String

Update requires: No interruption

ProductSKU

Product SKU.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Status

License status.

Required: No

Type: String

Allowed values: AVAILABLE | PENDING_AVAILABLE | DEACTIVATED | SUSPENDED | EXPIRED | PENDING_DELETE | DELETED

Update requires: No interruption

Validity

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

Required: Yes

Type: ValidityDateFormat

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the license.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

LicenseArn

The Amazon Resource Name (ARN) of the license.

Version

The license version.