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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::LicenseManager::License
<a name="aws-resource-licensemanager-license"></a>

Specifies a granted license.

Granted licenses are licenses for products that your organization purchased from Amazon Web Services Marketplace or directly from a seller who integrated their software with managed entitlements. For more information, see [Granted licenses](https://docs.amazonaws.cn/license-manager/latest/userguide/granted-licenses.html) in the *Amazon License Manager User Guide*.

## Syntax
<a name="aws-resource-licensemanager-license-syntax"></a>

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

### JSON
<a name="aws-resource-licensemanager-license-syntax.json"></a>

```
{
  "Type" : "AWS::LicenseManager::License",
  "Properties" : {
      "[Beneficiary](#cfn-licensemanager-license-beneficiary)" : String,
      "[ConsumptionConfiguration](#cfn-licensemanager-license-consumptionconfiguration)" : ConsumptionConfiguration,
      "[Entitlements](#cfn-licensemanager-license-entitlements)" : [ Entitlement, ... ],
      "[HomeRegion](#cfn-licensemanager-license-homeregion)" : String,
      "[Issuer](#cfn-licensemanager-license-issuer)" : IssuerData,
      "[LicenseMetadata](#cfn-licensemanager-license-licensemetadata)" : [ Metadata, ... ],
      "[LicenseName](#cfn-licensemanager-license-licensename)" : String,
      "[ProductName](#cfn-licensemanager-license-productname)" : String,
      "[ProductSKU](#cfn-licensemanager-license-productsku)" : String,
      "[Status](#cfn-licensemanager-license-status)" : String,
      "[Tags](#cfn-licensemanager-license-tags)" : [ Tag, ... ],
      "[Validity](#cfn-licensemanager-license-validity)" : ValidityDateFormat
    }
}
```

### YAML
<a name="aws-resource-licensemanager-license-syntax.yaml"></a>

```
Type: AWS::LicenseManager::License
Properties:
  [Beneficiary](#cfn-licensemanager-license-beneficiary): String
  [ConsumptionConfiguration](#cfn-licensemanager-license-consumptionconfiguration): 
    ConsumptionConfiguration
  [Entitlements](#cfn-licensemanager-license-entitlements): 
    - Entitlement
  [HomeRegion](#cfn-licensemanager-license-homeregion): String
  [Issuer](#cfn-licensemanager-license-issuer): 
    IssuerData
  [LicenseMetadata](#cfn-licensemanager-license-licensemetadata): 
    - Metadata
  [LicenseName](#cfn-licensemanager-license-licensename): String
  [ProductName](#cfn-licensemanager-license-productname): String
  [ProductSKU](#cfn-licensemanager-license-productsku): String
  [Status](#cfn-licensemanager-license-status): String
  [Tags](#cfn-licensemanager-license-tags): 
    - Tag
  [Validity](#cfn-licensemanager-license-validity): 
    ValidityDateFormat
```

## Properties
<a name="aws-resource-licensemanager-license-properties"></a>

`Beneficiary`  <a name="cfn-licensemanager-license-beneficiary"></a>
License beneficiary.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConsumptionConfiguration`  <a name="cfn-licensemanager-license-consumptionconfiguration"></a>
Configuration for consumption of the license.  
*Required*: Yes  
*Type*: [ConsumptionConfiguration](aws-properties-licensemanager-license-consumptionconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Entitlements`  <a name="cfn-licensemanager-license-entitlements"></a>
License entitlements.  
*Required*: Yes  
*Type*: Array of [Entitlement](aws-properties-licensemanager-license-entitlement.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HomeRegion`  <a name="cfn-licensemanager-license-homeregion"></a>
Home Region of the license.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Issuer`  <a name="cfn-licensemanager-license-issuer"></a>
License issuer.  
*Required*: Yes  
*Type*: [IssuerData](aws-properties-licensemanager-license-issuerdata.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LicenseMetadata`  <a name="cfn-licensemanager-license-licensemetadata"></a>
License metadata.  
*Required*: No  
*Type*: Array of [Metadata](aws-properties-licensemanager-license-metadata.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LicenseName`  <a name="cfn-licensemanager-license-licensename"></a>
License name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProductName`  <a name="cfn-licensemanager-license-productname"></a>
Product name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProductSKU`  <a name="cfn-licensemanager-license-productsku"></a>
Product SKU.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-licensemanager-license-status"></a>
License status.  
*Required*: No  
*Type*: String  
*Allowed values*: `AVAILABLE | PENDING_AVAILABLE | DEACTIVATED | SUSPENDED | EXPIRED | PENDING_DELETE | DELETED`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-licensemanager-license-tags"></a>
One or more tags.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-licensemanager-license-tag.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Validity`  <a name="cfn-licensemanager-license-validity"></a>
Date and time range during which the license is valid, in ISO8601-UTC format.  
*Required*: Yes  
*Type*: [ValidityDateFormat](aws-properties-licensemanager-license-validitydateformat.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-licensemanager-license-return-values"></a>

### Ref
<a name="aws-resource-licensemanager-license-return-values-ref"></a>

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 [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-licensemanager-license-return-values-fn--getatt"></a>

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 [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-licensemanager-license-return-values-fn--getatt-fn--getatt"></a>

`LicenseArn`  <a name="LicenseArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the license.

`Version`  <a name="Version-fn::getatt"></a>
The license version.