Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LicenseManager.CreateLicenseConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data CreateLicenseConfiguration Source #

See: newCreateLicenseConfiguration smart constructor.

Constructors

CreateLicenseConfiguration'

Fields

description :: Maybe Text
Description of the license configuration.
disassociateWhenNotFound :: Maybe Bool
When true, disassociates a resource when software is uninstalled.
licenseCount :: Maybe Integer
Number of licenses managed by the license configuration.
licenseCountHardLimit :: Maybe Bool
Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
licenseRules :: Maybe [Text]
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.
productInformationList :: Maybe [ProductInformation]
Product information.
tags :: Maybe [Tag]
Tags to add to the license configuration.
name :: Text
Name of the license configuration.
licenseCountingType :: LicenseCountingType
Dimension used to track the license inventory.

Instances

Instances details

ToJSON CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods toJSON :: CreateLicenseConfiguration -> Value # toEncoding :: CreateLicenseConfiguration -> Encoding # toJSONList :: [CreateLicenseConfiguration] -> Value # toEncodingList :: [CreateLicenseConfiguration] -> Encoding #
ToHeaders CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods toHeaders :: CreateLicenseConfiguration -> [Header] #
ToPath CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods toPath :: CreateLicenseConfiguration -> ByteString #
ToQuery CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods toQuery :: CreateLicenseConfiguration -> QueryString #
AWSRequest CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Associated Types type AWSResponse CreateLicenseConfiguration # Methods request :: (Service -> Service) -> CreateLicenseConfiguration -> Request CreateLicenseConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateLicenseConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLicenseConfiguration))) #
Generic CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Associated Types type Rep CreateLicenseConfiguration :: Type -> Type # Methods from :: CreateLicenseConfiguration -> Rep CreateLicenseConfiguration x # to :: Rep CreateLicenseConfiguration x -> CreateLicenseConfiguration #
Read CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods readsPrec :: Int -> ReadS CreateLicenseConfiguration # readList :: ReadS [CreateLicenseConfiguration] # readPrec :: ReadPrec CreateLicenseConfiguration # readListPrec :: ReadPrec [CreateLicenseConfiguration] #
Show CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods showsPrec :: Int -> CreateLicenseConfiguration -> ShowS # show :: CreateLicenseConfiguration -> String # showList :: [CreateLicenseConfiguration] -> ShowS #
NFData CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods rnf :: CreateLicenseConfiguration -> () #
Eq CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods (==) :: CreateLicenseConfiguration -> CreateLicenseConfiguration -> Bool # (/=) :: CreateLicenseConfiguration -> CreateLicenseConfiguration -> Bool #
Hashable CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods hashWithSalt :: Int -> CreateLicenseConfiguration -> Int # hash :: CreateLicenseConfiguration -> Int #
type AWSResponse CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration type AWSResponse CreateLicenseConfiguration = CreateLicenseConfigurationResponse
type Rep CreateLicenseConfiguration Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration type Rep CreateLicenseConfiguration = D1 ('MetaData "CreateLicenseConfiguration" "Amazonka.LicenseManager.CreateLicenseConfiguration" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CreateLicenseConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disassociateWhenNotFound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "licenseCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "licenseCountHardLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "licenseRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "productInformationList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProductInformation]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "licenseCountingType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LicenseCountingType))))))

newCreateLicenseConfiguration Source #

Arguments

:: Text	`CreateLicenseConfiguration`
-> LicenseCountingType	`CreateLicenseConfiguration`
-> CreateLicenseConfiguration

Create a value of CreateLicenseConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateLicenseConfiguration, createLicenseConfiguration_description - Description of the license configuration.

CreateLicenseConfiguration, createLicenseConfiguration_disassociateWhenNotFound - When true, disassociates a resource when software is uninstalled.

CreateLicenseConfiguration, createLicenseConfiguration_licenseCount - Number of licenses managed by the license configuration.

CreateLicenseConfiguration, createLicenseConfiguration_licenseCountHardLimit - Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

CreateLicenseConfiguration, createLicenseConfiguration_licenseRules - 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.

CreateLicenseConfiguration, createLicenseConfiguration_productInformationList - Product information.

CreateLicenseConfiguration, createLicenseConfiguration_tags - Tags to add to the license configuration.

CreateLicenseConfiguration, createLicenseConfiguration_name - Name of the license configuration.

CreateLicenseConfiguration, createLicenseConfiguration_licenseCountingType - Dimension used to track the license inventory.

Request Lenses

createLicenseConfiguration_description :: Lens' CreateLicenseConfiguration (Maybe Text) Source #

Description of the license configuration.

createLicenseConfiguration_disassociateWhenNotFound :: Lens' CreateLicenseConfiguration (Maybe Bool) Source #

When true, disassociates a resource when software is uninstalled.

createLicenseConfiguration_licenseCount :: Lens' CreateLicenseConfiguration (Maybe Integer) Source #

Number of licenses managed by the license configuration.

createLicenseConfiguration_licenseCountHardLimit :: Lens' CreateLicenseConfiguration (Maybe Bool) Source #

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

createLicenseConfiguration_licenseRules :: Lens' CreateLicenseConfiguration (Maybe [Text]) Source #

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.

createLicenseConfiguration_productInformationList :: Lens' CreateLicenseConfiguration (Maybe [ProductInformation]) Source #

Product information.

createLicenseConfiguration_tags :: Lens' CreateLicenseConfiguration (Maybe [Tag]) Source #

Tags to add to the license configuration.

createLicenseConfiguration_name :: Lens' CreateLicenseConfiguration Text Source #

Name of the license configuration.

createLicenseConfiguration_licenseCountingType :: Lens' CreateLicenseConfiguration LicenseCountingType Source #

Dimension used to track the license inventory.

Destructuring the Response

data CreateLicenseConfigurationResponse Source #

See: newCreateLicenseConfigurationResponse smart constructor.

Constructors

CreateLicenseConfigurationResponse'
Fields licenseConfigurationArn :: Maybe Text Amazon Resource Name (ARN) of the license configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Associated Types type Rep CreateLicenseConfigurationResponse :: Type -> Type # Methods from :: CreateLicenseConfigurationResponse -> Rep CreateLicenseConfigurationResponse x # to :: Rep CreateLicenseConfigurationResponse x -> CreateLicenseConfigurationResponse #
Read CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods readsPrec :: Int -> ReadS CreateLicenseConfigurationResponse # readList :: ReadS [CreateLicenseConfigurationResponse] # readPrec :: ReadPrec CreateLicenseConfigurationResponse # readListPrec :: ReadPrec [CreateLicenseConfigurationResponse] #
Show CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods showsPrec :: Int -> CreateLicenseConfigurationResponse -> ShowS # show :: CreateLicenseConfigurationResponse -> String # showList :: [CreateLicenseConfigurationResponse] -> ShowS #
NFData CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods rnf :: CreateLicenseConfigurationResponse -> () #
Eq CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration Methods (==) :: CreateLicenseConfigurationResponse -> CreateLicenseConfigurationResponse -> Bool # (/=) :: CreateLicenseConfigurationResponse -> CreateLicenseConfigurationResponse -> Bool #
type Rep CreateLicenseConfigurationResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateLicenseConfiguration type Rep CreateLicenseConfigurationResponse = D1 ('MetaData "CreateLicenseConfigurationResponse" "Amazonka.LicenseManager.CreateLicenseConfiguration" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CreateLicenseConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "licenseConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLicenseConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateLicenseConfigurationResponse'`
-> CreateLicenseConfigurationResponse

Create a value of CreateLicenseConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateLicenseConfigurationResponse, createLicenseConfigurationResponse_licenseConfigurationArn - Amazon Resource Name (ARN) of the license configuration.

$sel:httpStatus:CreateLicenseConfigurationResponse', createLicenseConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createLicenseConfigurationResponse_licenseConfigurationArn :: Lens' CreateLicenseConfigurationResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the license configuration.

createLicenseConfigurationResponse_httpStatus :: Lens' CreateLicenseConfigurationResponse Int Source #

The response's http status code.