View a markdown version of this page

AWS::LicenseManager::LicenseConfiguration - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::LicenseManager::LicenseConfiguration

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), host affinity (how long a VM must be associated with a host), and the number of licenses purchased and used.

Syntax

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

JSON

{
  "Type" : "AWS::LicenseManager::LicenseConfiguration",
  "Properties" : {
      "Description" : String,
      "DisassociateWhenNotFound" : Boolean,
      "LicenseCount" : Integer,
      "LicenseCountHardLimit" : Boolean,
      "LicenseCountingType" : String,
      "LicenseExpiry" : Integer,
      "LicenseRules" : [ String, ... ],
      "Name" : String,
      "ProductInformationList" : [ ProductInformation, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::LicenseManager::LicenseConfiguration
Properties:
  Description: String
  DisassociateWhenNotFound: Boolean
  LicenseCount: Integer
  LicenseCountHardLimit: Boolean
  LicenseCountingType: String
  LicenseExpiry: Integer
  LicenseRules: 
    - String
  Name: String
  ProductInformationList: 
    - ProductInformation
  Tags: 
    - Tag

Properties

Description

Description of the license configuration.

Required: No

Type: String

Update requires: No interruption

DisassociateWhenNotFound

When true, disassociates a resource when software is uninstalled.

Required: No

Type: Boolean

Update requires: No interruption

LicenseCount

Number of licenses managed by the license configuration.

Required: No

Type: Integer

Update requires: No interruption

LicenseCountHardLimit

Number of available licenses as a hard limit.

Required: No

Type: Boolean

Update requires: No interruption

LicenseCountingType

Dimension to use to track the license inventory.

Required: Yes

Type: String

Allowed values: vCPU | Instance | Core | Socket

Update requires: Replacement

LicenseExpiry

License configuration expiry time in Unix timestamp format.

Required: No

Type: Integer

Update requires: No interruption

LicenseRules

License rules.

Required: No

Type: Array of String

Update requires: Replacement

Name

Name of the license configuration.

Required: Yes

Type: String

Update requires: No interruption

ProductInformationList

Product information.

Required: No

Type: Array of ProductInformation

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

LicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

LicenseConfigurationId

Unique ID of the license configuration.

OwnerAccountId

Account ID of the license configuration's owner.

Status

Status of the license configuration.