aws-cdk-lib.aws_licensemanager.CfnLicenseProps

interface CfnLicenseProps

LanguageType name
.NETAmazon.CDK.AWS.LicenseManager.CfnLicenseProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslicensemanager#CfnLicenseProps
Javasoftware.amazon.awscdk.services.licensemanager.CfnLicenseProps
Pythonaws_cdk.aws_licensemanager.CfnLicenseProps
TypeScript aws-cdk-lib » aws_licensemanager » CfnLicenseProps

Properties for defining a CfnLicense.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_licensemanager as licensemanager } from 'aws-cdk-lib';
const cfnLicenseProps: licensemanager.CfnLicenseProps = {
  consumptionConfiguration: {
    borrowConfiguration: {
      allowEarlyCheckIn: false,
      maxTimeToLiveInMinutes: 123,
    },
    provisionalConfiguration: {
      maxTimeToLiveInMinutes: 123,
    },
    renewType: 'renewType',
  },
  entitlements: [{
    name: 'name',
    unit: 'unit',

    // the properties below are optional
    allowCheckIn: false,
    maxCount: 123,
    overage: false,
    value: 'value',
  }],
  homeRegion: 'homeRegion',
  issuer: {
    name: 'name',

    // the properties below are optional
    signKey: 'signKey',
  },
  licenseName: 'licenseName',
  productName: 'productName',
  validity: {
    begin: 'begin',
    end: 'end',
  },

  // the properties below are optional
  beneficiary: 'beneficiary',
  licenseMetadata: [{
    name: 'name',
    value: 'value',
  }],
  productSku: 'productSku',
  status: 'status',
};

Properties

NameTypeDescription
consumptionConfigurationIResolvable | ConsumptionConfigurationPropertyConfiguration for consumption of the license.
entitlementsIResolvable | IResolvable | EntitlementProperty[]License entitlements.
homeRegionstringHome Region of the license.
issuerIResolvable | IssuerDataPropertyLicense issuer.
licenseNamestringLicense name.
productNamestringProduct name.
validityIResolvable | ValidityDateFormatPropertyDate and time range during which the license is valid, in ISO8601-UTC format.
beneficiary?stringLicense beneficiary.
licenseMetadata?IResolvable | IResolvable | MetadataProperty[]License metadata.
productSku?stringProduct SKU.
status?stringLicense status.

consumptionConfiguration

Type: IResolvable | ConsumptionConfigurationProperty

Configuration for consumption of the license.


entitlements

Type: IResolvable | IResolvable | EntitlementProperty[]

License entitlements.


homeRegion

Type: string

Home Region of the license.


issuer

Type: IResolvable | IssuerDataProperty

License issuer.


licenseName

Type: string

License name.


productName

Type: string

Product name.


validity

Type: IResolvable | ValidityDateFormatProperty

Date and time range during which the license is valid, in ISO8601-UTC format.


beneficiary?

Type: string (optional)

License beneficiary.


licenseMetadata?

Type: IResolvable | IResolvable | MetadataProperty[] (optional)

License metadata.


productSku?

Type: string (optional)

Product SKU.


status?

Type: string (optional)

License status.