1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. licensemanager

Module licensemanager

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Association

class Association extends CustomResource

Provides a License Manager association.

Note: License configurations can also be associated with launch templates by specifying the licenseSpecifications block for an aws.ec2.LaunchTemplate.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleAmi = pulumi.output(aws.getAmi({
    filters: [{
        name: "name",
        values: ["amzn-ami-vpc-nat*"],
    }],
    mostRecent: true,
    owners: ["amazon"],
}, { async: true }));
const exampleInstance = new aws.ec2.Instance("example", {
    ami: exampleAmi.id,
    instanceType: "t2.micro",
});
const exampleLicenseConfiguration = new aws.licensemanager.LicenseConfiguration("example", {
    licenseCountingType: "Instance",
});
const exampleAssociation = new aws.licensemanager.Association("example", {
    licenseConfigurationArn: exampleLicenseConfiguration.arn,
    resourceArn: exampleInstance.arn,
});

constructor

new Association(name: string, args: AssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a Association resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AssociationState, opts?: pulumi.CustomResourceOptions): Association

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Association

Returns true if the given object is an instance of Association. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property licenseConfigurationArn

public licenseConfigurationArn: pulumi.Output<string>;

ARN of the license configuration.

property resourceArn

public resourceArn: pulumi.Output<string>;

ARN of the resource associated with the license configuration.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource LicenseConfiguration

class LicenseConfiguration extends CustomResource

Provides a License Manager license configuration resource.

Note: Removing the licenseCount attribute is not supported by the License Manager API - recreate the resource instead.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.licensemanager.LicenseConfiguration("example", {
    description: "Example",
    licenseCount: 10,
    licenseCountHardLimit: true,
    licenseCountingType: "Socket",
    licenseRules: ["#minimumSockets=2"],
    tags: {
        foo: "barr",
    },
});

Rules

License rules should be in the format of #RuleType=RuleValue. Supported rule types:

  • minimumVcpus - Resource must have minimum vCPU count in order to use the license. Default: 1
  • maximumVcpus - Resource must have maximum vCPU count in order to use the license. Default: unbounded, limit: 10000
  • minimumCores - Resource must have minimum core count in order to use the license. Default: 1
  • maximumCores - Resource must have maximum core count in order to use the license. Default: unbounded, limit: 10000
  • minimumSockets - Resource must have minimum socket count in order to use the license. Default: 1
  • maximumSockets - Resource must have maximum socket count in order to use the license. Default: unbounded, limit: 10000
  • allowedTenancy - Defines where the license can be used. If set, restricts license usage to selected tenancies. Specify a comma delimited list of EC2-Default, EC2-DedicatedHost, EC2-DedicatedInstance

constructor

new LicenseConfiguration(name: string, args: LicenseConfigurationArgs, opts?: pulumi.CustomResourceOptions)

Create a LicenseConfiguration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LicenseConfigurationState, opts?: pulumi.CustomResourceOptions): LicenseConfiguration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is LicenseConfiguration

Returns true if the given object is an instance of LicenseConfiguration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the license configuration.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property licenseCount

public licenseCount: pulumi.Output<number | undefined>;

Number of licenses managed by the license configuration.

property licenseCountHardLimit

public licenseCountHardLimit: pulumi.Output<boolean | undefined>;

Sets the number of available licenses as a hard limit.

property licenseCountingType

public licenseCountingType: pulumi.Output<string>;

Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.

property licenseRules

public licenseRules: pulumi.Output<string[] | undefined>;

Array of configured License Manager rules.

property name

public name: pulumi.Output<string>;

Name of the license configuration.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AssociationArgs

interface AssociationArgs

The set of arguments for constructing a Association resource.

property licenseConfigurationArn

licenseConfigurationArn: pulumi.Input<string>;

ARN of the license configuration.

property resourceArn

resourceArn: pulumi.Input<string>;

ARN of the resource associated with the license configuration.

interface AssociationState

interface AssociationState

Input properties used for looking up and filtering Association resources.

property licenseConfigurationArn

licenseConfigurationArn?: pulumi.Input<string>;

ARN of the license configuration.

property resourceArn

resourceArn?: pulumi.Input<string>;

ARN of the resource associated with the license configuration.

interface LicenseConfigurationArgs

interface LicenseConfigurationArgs

The set of arguments for constructing a LicenseConfiguration resource.

property description

description?: pulumi.Input<string>;

Description of the license configuration.

property licenseCount

licenseCount?: pulumi.Input<number>;

Number of licenses managed by the license configuration.

property licenseCountHardLimit

licenseCountHardLimit?: pulumi.Input<boolean>;

Sets the number of available licenses as a hard limit.

property licenseCountingType

licenseCountingType: pulumi.Input<string>;

Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.

property licenseRules

licenseRules?: pulumi.Input<pulumi.Input<string>[]>;

Array of configured License Manager rules.

property name

name?: pulumi.Input<string>;

Name of the license configuration.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface LicenseConfigurationState

interface LicenseConfigurationState

Input properties used for looking up and filtering LicenseConfiguration resources.

property description

description?: pulumi.Input<string>;

Description of the license configuration.

property licenseCount

licenseCount?: pulumi.Input<number>;

Number of licenses managed by the license configuration.

property licenseCountHardLimit

licenseCountHardLimit?: pulumi.Input<boolean>;

Sets the number of available licenses as a hard limit.

property licenseCountingType

licenseCountingType?: pulumi.Input<string>;

Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.

property licenseRules

licenseRules?: pulumi.Input<pulumi.Input<string>[]>;

Array of configured License Manager rules.

property name

name?: pulumi.Input<string>;

Name of the license configuration.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.