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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.164Z")
 @Stability(value=Stable)
public class CfnLicense
extends CfnResource
implements IInspectable

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

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 Example:
static class	CfnLicense.Builder A fluent builder for CfnLicense.
static interface	CfnLicense.ConsumptionConfigurationProperty Example:
static interface	CfnLicense.EntitlementProperty Example:
static interface	CfnLicense.IssuerDataProperty Example:
static interface	CfnLicense.MetadataProperty Example:
static interface	CfnLicense.ProvisionalConfigurationProperty Example:
static interface	CfnLicense.ValidityDateFormatProperty Example:

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()
String	getAttrVersion()
String	getBeneficiary() `AWS::LicenseManager::License.Beneficiary`.
protected Map<String,Object>	getCfnProperties()
Object	getConsumptionConfiguration() `AWS::LicenseManager::License.ConsumptionConfiguration`.
Object	getEntitlements() `AWS::LicenseManager::License.Entitlements`.
String	getHomeRegion() `AWS::LicenseManager::License.HomeRegion`.
Object	getIssuer() `AWS::LicenseManager::License.Issuer`.
Object	getLicenseMetadata() `AWS::LicenseManager::License.LicenseMetadata`.
String	getLicenseName() `AWS::LicenseManager::License.LicenseName`.
String	getProductName() `AWS::LicenseManager::License.ProductName`.
String	getProductSku() `AWS::LicenseManager::License.ProductSKU`.
String	getStatus() `AWS::LicenseManager::License.Status`.
Object	getValidity() `AWS::LicenseManager::License.Validity`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBeneficiary(String value) `AWS::LicenseManager::License.Beneficiary`.
void	setConsumptionConfiguration(CfnLicense.ConsumptionConfigurationProperty value) `AWS::LicenseManager::License.ConsumptionConfiguration`.
void	setConsumptionConfiguration(IResolvable value) `AWS::LicenseManager::License.ConsumptionConfiguration`.
void	setEntitlements(IResolvable value) `AWS::LicenseManager::License.Entitlements`.
void	setEntitlements(List<Object> value) `AWS::LicenseManager::License.Entitlements`.
void	setHomeRegion(String value) `AWS::LicenseManager::License.HomeRegion`.
void	setIssuer(CfnLicense.IssuerDataProperty value) `AWS::LicenseManager::License.Issuer`.
void	setIssuer(IResolvable value) `AWS::LicenseManager::License.Issuer`.
void	setLicenseMetadata(IResolvable value) `AWS::LicenseManager::License.LicenseMetadata`.
void	setLicenseMetadata(List<Object> value) `AWS::LicenseManager::License.LicenseMetadata`.
void	setLicenseName(String value) `AWS::LicenseManager::License.LicenseName`.
void	setProductName(String value) `AWS::LicenseManager::License.ProductName`.
void	setProductSku(String value) `AWS::LicenseManager::License.ProductSKU`.
void	setStatus(String value) `AWS::LicenseManager::License.Status`.
void	setValidity(CfnLicense.ValidityDateFormatProperty value) `AWS::LicenseManager::License.Validity`.
void	setValidity(IResolvable value) `AWS::LicenseManager::License.Validity`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

getAttrVersion

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

getBeneficiary

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

`AWS::LicenseManager::License.Beneficiary`.

setBeneficiary

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

`AWS::LicenseManager::License.Beneficiary`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getConsumptionConfiguration

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

`AWS::LicenseManager::License.ConsumptionConfiguration`.

setConsumptionConfiguration

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

`AWS::LicenseManager::License.ConsumptionConfiguration`.

setConsumptionConfiguration

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

`AWS::LicenseManager::License.ConsumptionConfiguration`.

getEntitlements

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

`AWS::LicenseManager::License.Entitlements`.

setEntitlements

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

`AWS::LicenseManager::License.Entitlements`.

setEntitlements

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

`AWS::LicenseManager::License.Entitlements`.

getHomeRegion

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

`AWS::LicenseManager::License.HomeRegion`.

setHomeRegion

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

`AWS::LicenseManager::License.HomeRegion`.

getIssuer

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

`AWS::LicenseManager::License.Issuer`.

setIssuer

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

`AWS::LicenseManager::License.Issuer`.

setIssuer

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

`AWS::LicenseManager::License.Issuer`.

getLicenseMetadata

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

`AWS::LicenseManager::License.LicenseMetadata`.

setLicenseMetadata

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

`AWS::LicenseManager::License.LicenseMetadata`.

setLicenseMetadata

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

`AWS::LicenseManager::License.LicenseMetadata`.

getLicenseName

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

`AWS::LicenseManager::License.LicenseName`.

setLicenseName

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

`AWS::LicenseManager::License.LicenseName`.

getProductName

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

`AWS::LicenseManager::License.ProductName`.

setProductName

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

`AWS::LicenseManager::License.ProductName`.

getProductSku

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

`AWS::LicenseManager::License.ProductSKU`.

setProductSku

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

`AWS::LicenseManager::License.ProductSKU`.

getStatus

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

`AWS::LicenseManager::License.Status`.

setStatus

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

`AWS::LicenseManager::License.Status`.

getValidity

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

`AWS::LicenseManager::License.Validity`.

setValidity

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

`AWS::LicenseManager::License.Validity`.

setValidity

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

`AWS::LicenseManager::License.Validity`.