1. Packages
  2. AWS
  3. API Docs
  4. licensemanager
  5. LicenseConfiguration
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.licensemanager.LicenseConfiguration

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Provides a License Manager license configuration resource.

    Note: Removing the license_count attribute is not supported by the License Manager API.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.licensemanager.LicenseConfiguration("example", {
        name: "Example",
        description: "Example",
        licenseCount: 10,
        licenseCountHardLimit: true,
        licenseCountingType: "Socket",
        licenseRules: ["#minimumSockets=2"],
        tags: {
            foo: "barr",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.licensemanager.LicenseConfiguration("example",
        name="Example",
        description="Example",
        license_count=10,
        license_count_hard_limit=True,
        license_counting_type="Socket",
        license_rules=["#minimumSockets=2"],
        tags={
            "foo": "barr",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/licensemanager"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := licensemanager.NewLicenseConfiguration(ctx, "example", &licensemanager.LicenseConfigurationArgs{
    			Name:                  pulumi.String("Example"),
    			Description:           pulumi.String("Example"),
    			LicenseCount:          pulumi.Int(10),
    			LicenseCountHardLimit: pulumi.Bool(true),
    			LicenseCountingType:   pulumi.String("Socket"),
    			LicenseRules: pulumi.StringArray{
    				pulumi.String("#minimumSockets=2"),
    			},
    			Tags: pulumi.StringMap{
    				"foo": pulumi.String("barr"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.LicenseManager.LicenseConfiguration("example", new()
        {
            Name = "Example",
            Description = "Example",
            LicenseCount = 10,
            LicenseCountHardLimit = true,
            LicenseCountingType = "Socket",
            LicenseRules = new[]
            {
                "#minimumSockets=2",
            },
            Tags = 
            {
                { "foo", "barr" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.licensemanager.LicenseConfiguration;
    import com.pulumi.aws.licensemanager.LicenseConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new LicenseConfiguration("example", LicenseConfigurationArgs.builder()
                .name("Example")
                .description("Example")
                .licenseCount(10)
                .licenseCountHardLimit(true)
                .licenseCountingType("Socket")
                .licenseRules("#minimumSockets=2")
                .tags(Map.of("foo", "barr"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:licensemanager:LicenseConfiguration
        properties:
          name: 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

    Create LicenseConfiguration Resource

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

    Constructor syntax

    new LicenseConfiguration(name: string, args: LicenseConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def LicenseConfiguration(resource_name: str,
                             args: LicenseConfigurationArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def LicenseConfiguration(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             license_counting_type: Optional[str] = None,
                             description: Optional[str] = None,
                             license_count: Optional[int] = None,
                             license_count_hard_limit: Optional[bool] = None,
                             license_rules: Optional[Sequence[str]] = None,
                             name: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None)
    func NewLicenseConfiguration(ctx *Context, name string, args LicenseConfigurationArgs, opts ...ResourceOption) (*LicenseConfiguration, error)
    public LicenseConfiguration(string name, LicenseConfigurationArgs args, CustomResourceOptions? opts = null)
    public LicenseConfiguration(String name, LicenseConfigurationArgs args)
    public LicenseConfiguration(String name, LicenseConfigurationArgs args, CustomResourceOptions options)
    
    type: aws:licensemanager:LicenseConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LicenseConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LicenseConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LicenseConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LicenseConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LicenseConfigurationArgs
    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 licenseConfigurationResource = new Aws.LicenseManager.LicenseConfiguration("licenseConfigurationResource", new()
    {
        LicenseCountingType = "string",
        Description = "string",
        LicenseCount = 0,
        LicenseCountHardLimit = false,
        LicenseRules = new[]
        {
            "string",
        },
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := licensemanager.NewLicenseConfiguration(ctx, "licenseConfigurationResource", &licensemanager.LicenseConfigurationArgs{
    	LicenseCountingType:   pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	LicenseCount:          pulumi.Int(0),
    	LicenseCountHardLimit: pulumi.Bool(false),
    	LicenseRules: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var licenseConfigurationResource = new LicenseConfiguration("licenseConfigurationResource", LicenseConfigurationArgs.builder()
        .licenseCountingType("string")
        .description("string")
        .licenseCount(0)
        .licenseCountHardLimit(false)
        .licenseRules("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    license_configuration_resource = aws.licensemanager.LicenseConfiguration("licenseConfigurationResource",
        license_counting_type="string",
        description="string",
        license_count=0,
        license_count_hard_limit=False,
        license_rules=["string"],
        name="string",
        tags={
            "string": "string",
        })
    
    const licenseConfigurationResource = new aws.licensemanager.LicenseConfiguration("licenseConfigurationResource", {
        licenseCountingType: "string",
        description: "string",
        licenseCount: 0,
        licenseCountHardLimit: false,
        licenseRules: ["string"],
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:licensemanager:LicenseConfiguration
    properties:
        description: string
        licenseCount: 0
        licenseCountHardLimit: false
        licenseCountingType: string
        licenseRules:
            - string
        name: string
        tags:
            string: string
    

    LicenseConfiguration 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 LicenseConfiguration resource accepts the following input properties:

    LicenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    Description string
    Description of the license configuration.
    LicenseCount int
    Number of licenses managed by the license configuration.
    LicenseCountHardLimit bool
    Sets the number of available licenses as a hard limit.
    LicenseRules List<string>
    Array of configured License Manager rules.
    Name string
    Name of the license configuration.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    LicenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    Description string
    Description of the license configuration.
    LicenseCount int
    Number of licenses managed by the license configuration.
    LicenseCountHardLimit bool
    Sets the number of available licenses as a hard limit.
    LicenseRules []string
    Array of configured License Manager rules.
    Name string
    Name of the license configuration.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    licenseCountingType String
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    description String
    Description of the license configuration.
    licenseCount Integer
    Number of licenses managed by the license configuration.
    licenseCountHardLimit Boolean
    Sets the number of available licenses as a hard limit.
    licenseRules List<String>
    Array of configured License Manager rules.
    name String
    Name of the license configuration.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    licenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    description string
    Description of the license configuration.
    licenseCount number
    Number of licenses managed by the license configuration.
    licenseCountHardLimit boolean
    Sets the number of available licenses as a hard limit.
    licenseRules string[]
    Array of configured License Manager rules.
    name string
    Name of the license configuration.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    license_counting_type str
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    description str
    Description of the license configuration.
    license_count int
    Number of licenses managed by the license configuration.
    license_count_hard_limit bool
    Sets the number of available licenses as a hard limit.
    license_rules Sequence[str]
    Array of configured License Manager rules.
    name str
    Name of the license configuration.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    licenseCountingType String
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    description String
    Description of the license configuration.
    licenseCount Number
    Number of licenses managed by the license configuration.
    licenseCountHardLimit Boolean
    Sets the number of available licenses as a hard limit.
    licenseRules List<String>
    Array of configured License Manager rules.
    name String
    Name of the license configuration.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The license configuration ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    Account ID of the owner of the license configuration.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The license configuration ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    Account ID of the owner of the license configuration.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The license configuration ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    Account ID of the owner of the license configuration.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The license configuration ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    Account ID of the owner of the license configuration.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The license configuration ARN.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    Account ID of the owner of the license configuration.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The license configuration ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    Account ID of the owner of the license configuration.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing LicenseConfiguration Resource

    Get an existing LicenseConfiguration 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?: LicenseConfigurationState, opts?: CustomResourceOptions): LicenseConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            license_count: Optional[int] = None,
            license_count_hard_limit: Optional[bool] = None,
            license_counting_type: Optional[str] = None,
            license_rules: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            owner_account_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> LicenseConfiguration
    func GetLicenseConfiguration(ctx *Context, name string, id IDInput, state *LicenseConfigurationState, opts ...ResourceOption) (*LicenseConfiguration, error)
    public static LicenseConfiguration Get(string name, Input<string> id, LicenseConfigurationState? state, CustomResourceOptions? opts = null)
    public static LicenseConfiguration get(String name, Output<String> id, LicenseConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Arn string
    The license configuration ARN.
    Description string
    Description of the license configuration.
    LicenseCount int
    Number of licenses managed by the license configuration.
    LicenseCountHardLimit bool
    Sets the number of available licenses as a hard limit.
    LicenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    LicenseRules List<string>
    Array of configured License Manager rules.
    Name string
    Name of the license configuration.
    OwnerAccountId string
    Account ID of the owner of the license configuration.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The license configuration ARN.
    Description string
    Description of the license configuration.
    LicenseCount int
    Number of licenses managed by the license configuration.
    LicenseCountHardLimit bool
    Sets the number of available licenses as a hard limit.
    LicenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    LicenseRules []string
    Array of configured License Manager rules.
    Name string
    Name of the license configuration.
    OwnerAccountId string
    Account ID of the owner of the license configuration.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The license configuration ARN.
    description String
    Description of the license configuration.
    licenseCount Integer
    Number of licenses managed by the license configuration.
    licenseCountHardLimit Boolean
    Sets the number of available licenses as a hard limit.
    licenseCountingType String
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    licenseRules List<String>
    Array of configured License Manager rules.
    name String
    Name of the license configuration.
    ownerAccountId String
    Account ID of the owner of the license configuration.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The license configuration ARN.
    description string
    Description of the license configuration.
    licenseCount number
    Number of licenses managed by the license configuration.
    licenseCountHardLimit boolean
    Sets the number of available licenses as a hard limit.
    licenseCountingType string
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    licenseRules string[]
    Array of configured License Manager rules.
    name string
    Name of the license configuration.
    ownerAccountId string
    Account ID of the owner of the license configuration.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The license configuration ARN.
    description str
    Description of the license configuration.
    license_count int
    Number of licenses managed by the license configuration.
    license_count_hard_limit bool
    Sets the number of available licenses as a hard limit.
    license_counting_type str
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    license_rules Sequence[str]
    Array of configured License Manager rules.
    name str
    Name of the license configuration.
    owner_account_id str
    Account ID of the owner of the license configuration.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The license configuration ARN.
    description String
    Description of the license configuration.
    licenseCount Number
    Number of licenses managed by the license configuration.
    licenseCountHardLimit Boolean
    Sets the number of available licenses as a hard limit.
    licenseCountingType String
    Dimension to use to track license inventory. Specify either vCPU, Instance, Core or Socket.
    licenseRules List<String>
    Array of configured License Manager rules.
    name String
    Name of the license configuration.
    ownerAccountId String
    Account ID of the owner of the license configuration.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import license configurations using the id. For example:

    $ pulumi import aws:licensemanager/licenseConfiguration:LicenseConfiguration example arn:aws:license-manager:eu-west-1:123456789012:license-configuration:lic-0123456789abcdef0123456789abcdef
    

    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.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi