Package software.amazon.awscdk.services.licensemanager

Interface CfnLicenseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLicenseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:08.791Z")
@Stability(Stable)
public interface CfnLicenseProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.licensemanager.*;
 CfnLicenseProps cfnLicenseProps = CfnLicenseProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLicenseProps.Builder	A builder for CfnLicenseProps
static final class	CfnLicenseProps.Jsii$Proxy	An implementation for CfnLicenseProps

Method Summary

Modifier and Type	Method	Description
static CfnLicenseProps.Builder	builder()
default String	getBeneficiary()	License beneficiary.
Object	getConsumptionConfiguration()	Configuration for consumption of the license.
Object	getEntitlements()	License entitlements.
String	getHomeRegion()	Home Region of the license.
Object	getIssuer()	License issuer.
default Object	getLicenseMetadata()	License metadata.
String	getLicenseName()	License name.
String	getProductName()	Product name.
default String	getProductSku()	Product SKU.
default String	getStatus()	License status.
Object	getValidity()	Date and time range during which the license is valid, in ISO8601-UTC format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConsumptionConfiguration

@Stability(Stable)
@NotNull
Object getConsumptionConfiguration()

Configuration for consumption of the license.

Returns union: either IResolvable or CfnLicense.ConsumptionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-consumptionconfiguration

getEntitlements

@Stability(Stable)
@NotNull
Object getEntitlements()

License entitlements.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-entitlements

getHomeRegion

@Stability(Stable)
@NotNull
String getHomeRegion()

Home Region of the license.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-homeregion

getIssuer

@Stability(Stable)
@NotNull
Object getIssuer()

License issuer.

Returns union: either IResolvable or CfnLicense.IssuerDataProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-issuer

getLicenseName

@Stability(Stable)
@NotNull
String getLicenseName()

License name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensename

getProductName

@Stability(Stable)
@NotNull
String getProductName()

Product name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productname

getValidity

@Stability(Stable)
@NotNull
Object getValidity()

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

Returns union: either IResolvable or CfnLicense.ValidityDateFormatProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-validity

getBeneficiary

@Stability(Stable)
@Nullable
default String getBeneficiary()

License beneficiary.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-beneficiary

getLicenseMetadata

@Stability(Stable)
@Nullable
default Object getLicenseMetadata()

License metadata.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensemetadata

getProductSku

@Stability(Stable)
@Nullable
default String getProductSku()

Product SKU.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productsku

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

License status.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-status

builder

@Stability(Stable)
static CfnLicenseProps.Builder builder()

Returns:

a CfnLicenseProps.Builder of CfnLicenseProps