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:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-04T00:39:34.628Z")
@Stability(Stable)
public class CfnLicense
extends CfnResource
implements IInspectable
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Details about a borrow configuration.static final class
A fluent builder forCfnLicense
.static interface
Details about a consumption configuration.static interface
Describes a resource entitled for use with a license.static interface
Details associated with the issuer of a license.static interface
Describes key/value pairs.static interface
Details about a provisional configuration.static interface
Date and time range during which the license is valid, in ISO8601-UTC format.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnLicense
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLicense
(software.amazon.jsii.JsiiObjectRef objRef) CfnLicense
(software.constructs.Construct scope, String id, CfnLicenseProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the license.The license version.License beneficiary.Configuration for consumption of the license.License entitlements.Home Region of the license.License issuer.License metadata.License name.Product name.Product SKU.License status.Date and time range during which the license is valid, in ISO8601-UTC format.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setBeneficiary
(String value) License beneficiary.void
Configuration for consumption of the license.void
Configuration for consumption of the license.void
setEntitlements
(List<Object> value) License entitlements.void
setEntitlements
(IResolvable value) License entitlements.void
setHomeRegion
(String value) Home Region of the license.void
setIssuer
(IResolvable value) License issuer.void
License issuer.void
setLicenseMetadata
(List<Object> value) License metadata.void
setLicenseMetadata
(IResolvable value) License metadata.void
setLicenseName
(String value) License name.void
setProductName
(String value) Product name.void
setProductSku
(String value) Product SKU.void
License status.void
setValidity
(IResolvable value) Date and time range during which the license is valid, in ISO8601-UTC format.void
Date and time range during which the license is valid, in ISO8601-UTC format.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrLicenseArn
The Amazon Resource Name (ARN) of the license. -
getAttrVersion
The license version. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getConsumptionConfiguration
Configuration for consumption of the license. -
setConsumptionConfiguration
Configuration for consumption of the license. -
setConsumptionConfiguration
@Stability(Stable) public void setConsumptionConfiguration(@NotNull CfnLicense.ConsumptionConfigurationProperty value) Configuration for consumption of the license. -
getEntitlements
License entitlements. -
setEntitlements
License entitlements. -
setEntitlements
License entitlements. -
getHomeRegion
Home Region of the license. -
setHomeRegion
Home Region of the license. -
getIssuer
License issuer. -
setIssuer
License issuer. -
setIssuer
License issuer. -
getLicenseName
License name. -
setLicenseName
License name. -
getProductName
Product name. -
setProductName
Product name. -
getValidity
Date and time range during which the license is valid, in ISO8601-UTC format. -
setValidity
Date and time range during which the license is valid, in ISO8601-UTC format. -
setValidity
Date and time range during which the license is valid, in ISO8601-UTC format. -
getBeneficiary
License beneficiary. -
setBeneficiary
License beneficiary. -
getLicenseMetadata
License metadata. -
setLicenseMetadata
License metadata. -
setLicenseMetadata
License metadata. -
getProductSku
Product SKU. -
setProductSku
Product SKU. -
getStatus
License status. -
setStatus
License status.
-