Package software.amazon.awscdk.services.licensemanager

Class CfnLicense

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.licensemanager.CfnLicense
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ILicenseRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:09.114Z") @Stability(Stable) public class CfnLicense extends CfnResource implements IInspectable, ILicenseRef
Specifies a granted license.

Granted licenses are licenses for products that your organization purchased from AWS Marketplace or directly from a seller who integrated their software with managed entitlements. For more information, see Granted licenses in the AWS License Manager User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.licensemanager.*;
 CfnLicense cfnLicense = CfnLicense.Builder.create(this, "MyCfnLicense")
         .consumptionConfiguration(ConsumptionConfigurationProperty.builder()
                 .borrowConfiguration(BorrowConfigurationProperty.builder()
                         .allowEarlyCheckIn(false)
                         .maxTimeToLiveInMinutes(123)
                         .build())
                 .provisionalConfiguration(ProvisionalConfigurationProperty.builder()
                         .maxTimeToLiveInMinutes(123)
                         .build())
                 .renewType("renewType")
                 .build())
         .entitlements(List.of(EntitlementProperty.builder()
                 .name("name")
                 .unit("unit")
                 // the properties below are optional
                 .allowCheckIn(false)
                 .maxCount(123)
                 .overage(false)
                 .value("value")
                 .build()))
         .homeRegion("homeRegion")
         .issuer(IssuerDataProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .signKey("signKey")
                 .build())
         .licenseName("licenseName")
         .productName("productName")
         .validity(ValidityDateFormatProperty.builder()
                 .begin("begin")
                 .end("end")
                 .build())
         // the properties below are optional
         .beneficiary("beneficiary")
         .licenseMetadata(List.of(MetadataProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .productSku("productSku")
         .status("status")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLicense

      protected CfnLicense(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLicense

      protected CfnLicense(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLicense

      @Stability(Stable) public CfnLicense(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLicenseProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLicenseArn

      @Stability(Stable) @NotNull public String getAttrLicenseArn()
      The Amazon Resource Name (ARN) of the license.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The license version.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLicenseRef

      @Stability(Stable) @NotNull public LicenseReference getLicenseRef()
      A reference to a License resource.
      Specified by:
      getLicenseRef in interface ILicenseRef

    • getConsumptionConfiguration

      @Stability(Stable) @NotNull public Object getConsumptionConfiguration()
      Configuration for consumption of the license.

      Returns union: either IResolvable or CfnLicense.ConsumptionConfigurationProperty

    • setConsumptionConfiguration

      @Stability(Stable) public void setConsumptionConfiguration(@NotNull IResolvable value)
      Configuration for consumption of the license.

    • setConsumptionConfiguration

      @Stability(Stable) public void setConsumptionConfiguration(@NotNull CfnLicense.ConsumptionConfigurationProperty value)
      Configuration for consumption of the license.

    • getEntitlements

      @Stability(Stable) @NotNull public Object getEntitlements()
      License entitlements.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLicense.EntitlementProperty>

    • setEntitlements

      @Stability(Stable) public void setEntitlements(@NotNull IResolvable value)
      License entitlements.

    • setEntitlements

      @Stability(Stable) public void setEntitlements(@NotNull List<Object> value)
      License entitlements.

    • getHomeRegion

      @Stability(Stable) @NotNull public String getHomeRegion()
      Home Region of the license.

    • setHomeRegion

      @Stability(Stable) public void setHomeRegion(@NotNull String value)
      Home Region of the license.

    • getIssuer

      @Stability(Stable) @NotNull public Object getIssuer()
      License issuer.

      Returns union: either IResolvable or CfnLicense.IssuerDataProperty

    • setIssuer

      @Stability(Stable) public void setIssuer(@NotNull IResolvable value)
      License issuer.

    • setIssuer

      @Stability(Stable) public void setIssuer(@NotNull CfnLicense.IssuerDataProperty value)
      License issuer.

    • getLicenseName

      @Stability(Stable) @NotNull public String getLicenseName()
      License name.

    • setLicenseName

      @Stability(Stable) public void setLicenseName(@NotNull String value)
      License name.

    • getProductName

      @Stability(Stable) @NotNull public String getProductName()
      Product name.

    • setProductName

      @Stability(Stable) public void setProductName(@NotNull String value)
      Product name.

    • getValidity

      @Stability(Stable) @NotNull public Object getValidity()
      Date and time range during which the license is valid, in ISO8601-UTC format.

      Returns union: either IResolvable or CfnLicense.ValidityDateFormatProperty

    • setValidity

      @Stability(Stable) public void setValidity(@NotNull IResolvable value)
      Date and time range during which the license is valid, in ISO8601-UTC format.

    • setValidity

      @Stability(Stable) public void setValidity(@NotNull CfnLicense.ValidityDateFormatProperty value)
      Date and time range during which the license is valid, in ISO8601-UTC format.

    • getBeneficiary

      @Stability(Stable) @Nullable public String getBeneficiary()
      License beneficiary.

    • setBeneficiary

      @Stability(Stable) public void setBeneficiary(@Nullable String value)
      License beneficiary.

    • getLicenseMetadata

      @Stability(Stable) @Nullable public Object getLicenseMetadata()
      License metadata.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnLicense.MetadataProperty>

    • setLicenseMetadata

      @Stability(Stable) public void setLicenseMetadata(@Nullable IResolvable value)
      License metadata.

    • setLicenseMetadata

      @Stability(Stable) public void setLicenseMetadata(@Nullable List<Object> value)
      License metadata.

    • getProductSku

      @Stability(Stable) @Nullable public String getProductSku()
      Product SKU.

    • setProductSku

      @Stability(Stable) public void setProductSku(@Nullable String value)
      Product SKU.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      License status.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      License status.