AWS::LicenseManager::Grant - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::LicenseManager::Grant

Specifies a grant.

A grant shares the use of license entitlements with specific AWS accounts. 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::Grant",
  "Properties" : {
      "AllowedOperations" : [ String, ... ],
      "GrantName" : String,
      "HomeRegion" : String,
      "LicenseArn" : String,
      "Principals" : [ String, ... ],
      "Status" : String
    }
}

YAML

Type: AWS::LicenseManager::Grant
Properties:
  AllowedOperations: 
    - String
  GrantName: String
  HomeRegion: String
  LicenseArn: String
  Principals: 
    - String
  Status: String

Properties

AllowedOperations

Allowed operations for the grant.

Required: No

Type: Array of String

Minimum: 1

Maximum: 8

Update requires: No interruption

GrantName

Grant name.

Required: No

Type: String

Update requires: No interruption

HomeRegion

Home Region of the grant.

Required: No

Type: String

Update requires: No interruption

LicenseArn

License ARN.

Required: No

Type: String

Maximum: 2048

Update requires: No interruption

Principals

The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

  • An AWS account, which includes only the account specified.

  • An organizational unit (OU), which includes all accounts in the OU.

  • An organization, which will include all accounts across your organization.

Required: No

Type: Array of String

Minimum: 1

Maximum: 1

Update requires: No interruption

Status

Granted license status.

Required: No

Type: String

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

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 grant.

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.

GrantArn

The Amazon Resource Name (ARN) of the grant.

Version

The grant version.