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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.625Z")
 @Stability(value=Stable)
public class CfnLicense
extends CfnResource
implements IInspectable

A CloudFormation `AWS::LicenseManager::License`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnLicense.BorrowConfigurationProperty Details about a borrow configuration.
static class	CfnLicense.Builder A fluent builder for CfnLicense.
static interface	CfnLicense.ConsumptionConfigurationProperty Details about a consumption configuration.
static interface	CfnLicense.EntitlementProperty Describes a resource entitled for use with a license.
static interface	CfnLicense.IssuerDataProperty Details associated with the issuer of a license.
static interface	CfnLicense.MetadataProperty Describes key/value pairs.
static interface	CfnLicense.ProvisionalConfigurationProperty Details about a provisional configuration.
static interface	CfnLicense.ValidityDateFormatProperty 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLicense(software.constructs.Construct scope, String id, CfnLicenseProps props) Create a new `AWS::LicenseManager::License`.
protected	CfnLicense(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLicense(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrLicenseArn() The Amazon Resource Name (ARN) of the license.
String	getAttrVersion() The license version.
String	getBeneficiary() License beneficiary.
protected Map<String,Object>	getCfnProperties()
Object	getConsumptionConfiguration() Configuration for consumption of the license.
Object	getEntitlements() License entitlements.
String	getHomeRegion() Home Region of the license.
Object	getIssuer() License issuer.
Object	getLicenseMetadata() License metadata.
String	getLicenseName() License name.
String	getProductName() Product name.
String	getProductSku() Product SKU.
String	getStatus() License status.
Object	getValidity() 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.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBeneficiary(String value) License beneficiary.
void	setConsumptionConfiguration(CfnLicense.ConsumptionConfigurationProperty value) Configuration for consumption of the license.
void	setConsumptionConfiguration(IResolvable value) Configuration for consumption of the license.
void	setEntitlements(IResolvable value) License entitlements.
void	setEntitlements(List<Object> value) License entitlements.
void	setHomeRegion(String value) Home Region of the license.
void	setIssuer(CfnLicense.IssuerDataProperty value) License issuer.
void	setIssuer(IResolvable value) License issuer.
void	setLicenseMetadata(IResolvable value) License metadata.
void	setLicenseMetadata(List<Object> value) License metadata.
void	setLicenseName(String value) License name.
void	setProductName(String value) Product name.
void	setProductSku(String value) Product SKU.
void	setStatus(String value) License status.
void	setValidity(CfnLicense.ValidityDateFormatProperty value) Date and time range during which the license is valid, in ISO8601-UTC format.
void	setValidity(IResolvable value) Date and time range during which the license is valid, in ISO8601-UTC format.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLicense

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

CfnLicense

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

CfnLicense

@Stability(value=Stable)
public CfnLicense(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnLicenseProps props)

Create a new `AWS::LicenseManager::License`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrLicenseArn()

The Amazon Resource Name (ARN) of the license.

getAttrVersion

@Stability(value=Stable)
 @NotNull
public String getAttrVersion()

The license version.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConsumptionConfiguration

@Stability(value=Stable)
 @NotNull
public Object getConsumptionConfiguration()

Configuration for consumption of the license.

setConsumptionConfiguration

@Stability(value=Stable)
public void setConsumptionConfiguration(@NotNull
                                                                 CfnLicense.ConsumptionConfigurationProperty value)

Configuration for consumption of the license.

setConsumptionConfiguration

@Stability(value=Stable)
public void setConsumptionConfiguration(@NotNull
                                                                 IResolvable value)

Configuration for consumption of the license.

getEntitlements

@Stability(value=Stable)
 @NotNull
public Object getEntitlements()

License entitlements.

setEntitlements

@Stability(value=Stable)
public void setEntitlements(@NotNull
                                                     IResolvable value)

License entitlements.

setEntitlements

@Stability(value=Stable)
public void setEntitlements(@NotNull
                                                     List<Object> value)

License entitlements.

getHomeRegion

@Stability(value=Stable)
 @NotNull
public String getHomeRegion()

Home Region of the license.

setHomeRegion

@Stability(value=Stable)
public void setHomeRegion(@NotNull
                                                   String value)

Home Region of the license.

getIssuer

@Stability(value=Stable)
 @NotNull
public Object getIssuer()

License issuer.

setIssuer

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

License issuer.

setIssuer

@Stability(value=Stable)
public void setIssuer(@NotNull
                                               IResolvable value)

License issuer.

getLicenseName

@Stability(value=Stable)
 @NotNull
public String getLicenseName()

License name.

setLicenseName

@Stability(value=Stable)
public void setLicenseName(@NotNull
                                                    String value)

License name.

getProductName

@Stability(value=Stable)
 @NotNull
public String getProductName()

Product name.

setProductName

@Stability(value=Stable)
public void setProductName(@NotNull
                                                    String value)

Product name.

getValidity

@Stability(value=Stable)
 @NotNull
public Object getValidity()

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

setValidity

@Stability(value=Stable)
public void setValidity(@NotNull
                                                 CfnLicense.ValidityDateFormatProperty value)

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

setValidity

@Stability(value=Stable)
public void setValidity(@NotNull
                                                 IResolvable value)

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

getBeneficiary

@Stability(value=Stable)
 @Nullable
public String getBeneficiary()

License beneficiary.

setBeneficiary

@Stability(value=Stable)
public void setBeneficiary(@Nullable
                                                    String value)

License beneficiary.

getLicenseMetadata

@Stability(value=Stable)
 @Nullable
public Object getLicenseMetadata()

License metadata.

setLicenseMetadata

@Stability(value=Stable)
public void setLicenseMetadata(@Nullable
                                                        IResolvable value)

License metadata.

setLicenseMetadata

@Stability(value=Stable)
public void setLicenseMetadata(@Nullable
                                                        List<Object> value)

License metadata.

getProductSku

@Stability(value=Stable)
 @Nullable
public String getProductSku()

Product SKU.

setProductSku

@Stability(value=Stable)
public void setProductSku(@Nullable
                                                   String value)

Product SKU.

getStatus

@Stability(value=Stable)
 @Nullable
public String getStatus()

License status.

setStatus

@Stability(value=Stable)
public void setStatus(@Nullable
                                               String value)

License status.