LicenseManager / Client / create_license_configuration

create_license_configuration#

LicenseManager.Client.create_license_configuration(**kwargs)#

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

See also: AWS API Documentation

Request Syntax

response = client.create_license_configuration(
    Name='string',
    Description='string',
    LicenseCountingType='vCPU'|'Instance'|'Core'|'Socket',
    LicenseCount=123,
    LicenseCountHardLimit=True|False,
    LicenseRules=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DisassociateWhenNotFound=True|False,
    ProductInformationList=[
        {
            'ResourceType': 'string',
            'ProductInformationFilterList': [
                {
                    'ProductInformationFilterName': 'string',
                    'ProductInformationFilterValue': [
                        'string',
                    ],
                    'ProductInformationFilterComparator': 'string'
                },
            ]
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    Name of the license configuration.

  • Description (string) – Description of the license configuration.

  • LicenseCountingType (string) –

    [REQUIRED]

    Dimension used to track the license inventory.

  • LicenseCount (integer) – Number of licenses managed by the license configuration.

  • LicenseCountHardLimit (boolean) – Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

  • LicenseRules (list) –

    License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

    • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

    • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

    • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

    • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

    The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

    • (string) –

  • Tags (list) –

    Tags to add to the license configuration.

    • (dict) –

      Details about a tag for a license configuration.

      • Key (string) –

        Tag key.

      • Value (string) –

        Tag value.

  • DisassociateWhenNotFound (boolean) – When true, disassociates a resource when software is uninstalled.

  • ProductInformationList (list) –

    Product information.

    • (dict) –

      Describes product information for a license configuration.

      • ResourceType (string) – [REQUIRED]

        Resource type. The possible values are SSM_MANAGED | RDS.

      • ProductInformationFilterList (list) – [REQUIRED]

        A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

        Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

        The following filters and are supported when the resource type is SSM_MANAGED:

        • Application Name - The name of the application. Logical operator is EQUALS.

        • Application Publisher - The publisher of the application. Logical operator is EQUALS.

        • Application Version - The version of the application. Logical operator is EQUALS.

        • Platform Name - The name of the platform. Logical operator is EQUALS.

        • Platform Type - The platform type. Logical operator is EQUALS.

        • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

        • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

        • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

        The following filters and logical operators are supported when the resource type is RDS:

        • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

        • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

        • (dict) –

          Describes product information filters.

          • ProductInformationFilterName (string) – [REQUIRED]

            Filter name.

          • ProductInformationFilterValue (list) –

            Filter value.

            • (string) –

          • ProductInformationFilterComparator (string) – [REQUIRED]

            Logical operator.

Return type:

dict

Returns:

Response Syntax

{
    'LicenseConfigurationArn': 'string'
}

Response Structure

  • (dict) –

    • LicenseConfigurationArn (string) –

      Amazon Resource Name (ARN) of the license configuration.

Exceptions

  • LicenseManager.Client.exceptions.InvalidParameterValueException

  • LicenseManager.Client.exceptions.ServerInternalException

  • LicenseManager.Client.exceptions.ResourceLimitExceededException

  • LicenseManager.Client.exceptions.AuthorizationException

  • LicenseManager.Client.exceptions.AccessDeniedException

  • LicenseManager.Client.exceptions.RateLimitExceededException