1. Packages
  2. AWS
  3. API Docs
  4. licensemanager
  5. LicenseGrant
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi

aws.licensemanager.LicenseGrant

Explore with Pulumi AI

Provides a License Manager grant. This allows for sharing licenses with other AWS accounts.

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  test:
    type: aws:licensemanager:LicenseGrant
    properties:
      name: share-license-with-account
      allowedOperations:
        - ListPurchasedLicenses
        - CheckoutLicense
        - CheckInLicense
        - ExtendConsumptionLicense
        - CreateToken
      licenseArn: arn:aws:license-manager::111111111111:license:l-exampleARN
      principal: arn:aws:iam::111111111112:root
      homeRegion: us-east-1
Copy

Create LicenseGrant Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LicenseGrant(name: string, args: LicenseGrantArgs, opts?: CustomResourceOptions);
@overload
def LicenseGrant(resource_name: str,
                 args: LicenseGrantArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def LicenseGrant(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 allowed_operations: Optional[Sequence[str]] = None,
                 license_arn: Optional[str] = None,
                 principal: Optional[str] = None,
                 name: Optional[str] = None)
func NewLicenseGrant(ctx *Context, name string, args LicenseGrantArgs, opts ...ResourceOption) (*LicenseGrant, error)
public LicenseGrant(string name, LicenseGrantArgs args, CustomResourceOptions? opts = null)
public LicenseGrant(String name, LicenseGrantArgs args)
public LicenseGrant(String name, LicenseGrantArgs args, CustomResourceOptions options)
type: aws:licensemanager:LicenseGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LicenseGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LicenseGrantArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LicenseGrantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LicenseGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LicenseGrantArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var licenseGrantResource = new Aws.LicenseManager.LicenseGrant("licenseGrantResource", new()
{
    AllowedOperations = new[]
    {
        "string",
    },
    LicenseArn = "string",
    Principal = "string",
    Name = "string",
});
Copy
example, err := licensemanager.NewLicenseGrant(ctx, "licenseGrantResource", &licensemanager.LicenseGrantArgs{
	AllowedOperations: pulumi.StringArray{
		pulumi.String("string"),
	},
	LicenseArn: pulumi.String("string"),
	Principal:  pulumi.String("string"),
	Name:       pulumi.String("string"),
})
Copy
var licenseGrantResource = new LicenseGrant("licenseGrantResource", LicenseGrantArgs.builder()
    .allowedOperations("string")
    .licenseArn("string")
    .principal("string")
    .name("string")
    .build());
Copy
license_grant_resource = aws.licensemanager.LicenseGrant("licenseGrantResource",
    allowed_operations=["string"],
    license_arn="string",
    principal="string",
    name="string")
Copy
const licenseGrantResource = new aws.licensemanager.LicenseGrant("licenseGrantResource", {
    allowedOperations: ["string"],
    licenseArn: "string",
    principal: "string",
    name: "string",
});
Copy
type: aws:licensemanager:LicenseGrant
properties:
    allowedOperations:
        - string
    licenseArn: string
    name: string
    principal: string
Copy

LicenseGrant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LicenseGrant resource accepts the following input properties:

AllowedOperations This property is required. List<string>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
LicenseArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the license to grant.
Principal
This property is required.
Changes to this property will trigger replacement.
string
The target account for the grant in the form of the ARN for an account principal of the root user.
Name string
The Name of the grant.
AllowedOperations This property is required. []string
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
LicenseArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the license to grant.
Principal
This property is required.
Changes to this property will trigger replacement.
string
The target account for the grant in the form of the ARN for an account principal of the root user.
Name string
The Name of the grant.
allowedOperations This property is required. List<String>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
licenseArn
This property is required.
Changes to this property will trigger replacement.
String
The ARN of the license to grant.
principal
This property is required.
Changes to this property will trigger replacement.
String
The target account for the grant in the form of the ARN for an account principal of the root user.
name String
The Name of the grant.
allowedOperations This property is required. string[]
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
licenseArn
This property is required.
Changes to this property will trigger replacement.
string
The ARN of the license to grant.
principal
This property is required.
Changes to this property will trigger replacement.
string
The target account for the grant in the form of the ARN for an account principal of the root user.
name string
The Name of the grant.
allowed_operations This property is required. Sequence[str]
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
license_arn
This property is required.
Changes to this property will trigger replacement.
str
The ARN of the license to grant.
principal
This property is required.
Changes to this property will trigger replacement.
str
The target account for the grant in the form of the ARN for an account principal of the root user.
name str
The Name of the grant.
allowedOperations This property is required. List<String>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
licenseArn
This property is required.
Changes to this property will trigger replacement.
String
The ARN of the license to grant.
principal
This property is required.
Changes to this property will trigger replacement.
String
The target account for the grant in the form of the ARN for an account principal of the root user.
name String
The Name of the grant.

Outputs

All input properties are implicitly available as output properties. Additionally, the LicenseGrant resource produces the following output properties:

Arn string
The grant ARN.
HomeRegion string
The home region for the license.
Id string
The provider-assigned unique ID for this managed resource.
ParentArn string
The parent ARN.
Status string
The grant status.
Version string
The grant version.
Arn string
The grant ARN.
HomeRegion string
The home region for the license.
Id string
The provider-assigned unique ID for this managed resource.
ParentArn string
The parent ARN.
Status string
The grant status.
Version string
The grant version.
arn String
The grant ARN.
homeRegion String
The home region for the license.
id String
The provider-assigned unique ID for this managed resource.
parentArn String
The parent ARN.
status String
The grant status.
version String
The grant version.
arn string
The grant ARN.
homeRegion string
The home region for the license.
id string
The provider-assigned unique ID for this managed resource.
parentArn string
The parent ARN.
status string
The grant status.
version string
The grant version.
arn str
The grant ARN.
home_region str
The home region for the license.
id str
The provider-assigned unique ID for this managed resource.
parent_arn str
The parent ARN.
status str
The grant status.
version str
The grant version.
arn String
The grant ARN.
homeRegion String
The home region for the license.
id String
The provider-assigned unique ID for this managed resource.
parentArn String
The parent ARN.
status String
The grant status.
version String
The grant version.

Look up Existing LicenseGrant Resource

Get an existing LicenseGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LicenseGrantState, opts?: CustomResourceOptions): LicenseGrant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_operations: Optional[Sequence[str]] = None,
        arn: Optional[str] = None,
        home_region: Optional[str] = None,
        license_arn: Optional[str] = None,
        name: Optional[str] = None,
        parent_arn: Optional[str] = None,
        principal: Optional[str] = None,
        status: Optional[str] = None,
        version: Optional[str] = None) -> LicenseGrant
func GetLicenseGrant(ctx *Context, name string, id IDInput, state *LicenseGrantState, opts ...ResourceOption) (*LicenseGrant, error)
public static LicenseGrant Get(string name, Input<string> id, LicenseGrantState? state, CustomResourceOptions? opts = null)
public static LicenseGrant get(String name, Output<String> id, LicenseGrantState state, CustomResourceOptions options)
resources:  _:    type: aws:licensemanager:LicenseGrant    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllowedOperations List<string>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
Arn string
The grant ARN.
HomeRegion string
The home region for the license.
LicenseArn Changes to this property will trigger replacement. string
The ARN of the license to grant.
Name string
The Name of the grant.
ParentArn string
The parent ARN.
Principal Changes to this property will trigger replacement. string
The target account for the grant in the form of the ARN for an account principal of the root user.
Status string
The grant status.
Version string
The grant version.
AllowedOperations []string
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
Arn string
The grant ARN.
HomeRegion string
The home region for the license.
LicenseArn Changes to this property will trigger replacement. string
The ARN of the license to grant.
Name string
The Name of the grant.
ParentArn string
The parent ARN.
Principal Changes to this property will trigger replacement. string
The target account for the grant in the form of the ARN for an account principal of the root user.
Status string
The grant status.
Version string
The grant version.
allowedOperations List<String>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
arn String
The grant ARN.
homeRegion String
The home region for the license.
licenseArn Changes to this property will trigger replacement. String
The ARN of the license to grant.
name String
The Name of the grant.
parentArn String
The parent ARN.
principal Changes to this property will trigger replacement. String
The target account for the grant in the form of the ARN for an account principal of the root user.
status String
The grant status.
version String
The grant version.
allowedOperations string[]
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
arn string
The grant ARN.
homeRegion string
The home region for the license.
licenseArn Changes to this property will trigger replacement. string
The ARN of the license to grant.
name string
The Name of the grant.
parentArn string
The parent ARN.
principal Changes to this property will trigger replacement. string
The target account for the grant in the form of the ARN for an account principal of the root user.
status string
The grant status.
version string
The grant version.
allowed_operations Sequence[str]
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
arn str
The grant ARN.
home_region str
The home region for the license.
license_arn Changes to this property will trigger replacement. str
The ARN of the license to grant.
name str
The Name of the grant.
parent_arn str
The parent ARN.
principal Changes to this property will trigger replacement. str
The target account for the grant in the form of the ARN for an account principal of the root user.
status str
The grant status.
version str
The grant version.
allowedOperations List<String>
A list of the allowed operations for the grant. This is a subset of the allowed operations on the license.
arn String
The grant ARN.
homeRegion String
The home region for the license.
licenseArn Changes to this property will trigger replacement. String
The ARN of the license to grant.
name String
The Name of the grant.
parentArn String
The parent ARN.
principal Changes to this property will trigger replacement. String
The target account for the grant in the form of the ARN for an account principal of the root user.
status String
The grant status.
version String
The grant version.

Import

Using pulumi import, import aws_licensemanager_grant using the grant arn. For example:

$ pulumi import aws:licensemanager/licenseGrant:LicenseGrant test arn:aws:license-manager::123456789011:grant:g-01d313393d9e443d8664cc054db1e089
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.