CfnLicensePropsMixin

class aws_cdk.mixins_preview.aws_licensemanager.mixins.CfnLicensePropsMixin(props, *, strategy=None)

Bases: Mixin

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 License Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html
CloudformationResource:: AWS::LicenseManager::License
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

cfn_license_props_mixin = licensemanager_mixins.CfnLicensePropsMixin(licensemanager_mixins.CfnLicenseMixinProps(
    beneficiary="beneficiary",
    consumption_configuration=licensemanager_mixins.CfnLicensePropsMixin.ConsumptionConfigurationProperty(
        borrow_configuration=licensemanager_mixins.CfnLicensePropsMixin.BorrowConfigurationProperty(
            allow_early_check_in=False,
            max_time_to_live_in_minutes=123
        ),
        provisional_configuration=licensemanager_mixins.CfnLicensePropsMixin.ProvisionalConfigurationProperty(
            max_time_to_live_in_minutes=123
        ),
        renew_type="renewType"
    ),
    entitlements=[licensemanager_mixins.CfnLicensePropsMixin.EntitlementProperty(
        allow_check_in=False,
        max_count=123,
        name="name",
        overage=False,
        unit="unit",
        value="value"
    )],
    home_region="homeRegion",
    issuer=licensemanager_mixins.CfnLicensePropsMixin.IssuerDataProperty(
        name="name",
        sign_key="signKey"
    ),
    license_metadata=[licensemanager_mixins.CfnLicensePropsMixin.MetadataProperty(
        name="name",
        value="value"
    )],
    license_name="licenseName",
    product_name="productName",
    product_sku="productSku",
    status="status",
    validity=licensemanager_mixins.CfnLicensePropsMixin.ValidityDateFormatProperty(
        begin="begin",
        end="end"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::LicenseManager::License.

Parameters:

props (Union[CfnLicenseMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['beneficiary', 'consumptionConfiguration', 'entitlements', 'homeRegion', 'issuer', 'licenseMetadata', 'licenseName', 'productName', 'productSku', 'status', 'validity']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BorrowConfigurationProperty

class CfnLicensePropsMixin.BorrowConfigurationProperty(*, allow_early_check_in=None, max_time_to_live_in_minutes=None)

Bases: object

Details about a borrow configuration.

Parameters:

allow_early_check_in (Union[bool, IResolvable, None]) – Indicates whether early check-ins are allowed.
max_time_to_live_in_minutes (Union[int, float, None]) – Maximum time for the borrow configuration, in minutes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-borrowconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

borrow_configuration_property = licensemanager_mixins.CfnLicensePropsMixin.BorrowConfigurationProperty(
    allow_early_check_in=False,
    max_time_to_live_in_minutes=123
)

Attributes

allow_early_check_in

Indicates whether early check-ins are allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-borrowconfiguration.html#cfn-licensemanager-license-borrowconfiguration-allowearlycheckin

max_time_to_live_in_minutes

Maximum time for the borrow configuration, in minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-borrowconfiguration.html#cfn-licensemanager-license-borrowconfiguration-maxtimetoliveinminutes

ConsumptionConfigurationProperty

class CfnLicensePropsMixin.ConsumptionConfigurationProperty(*, borrow_configuration=None, provisional_configuration=None, renew_type=None)

Bases: object

Details about a consumption configuration.

Parameters:

borrow_configuration (Union[IResolvable, BorrowConfigurationProperty, Dict[str, Any], None]) – Details about a borrow configuration.
provisional_configuration (Union[IResolvable, ProvisionalConfigurationProperty, Dict[str, Any], None]) – Details about a provisional configuration.
renew_type (Optional[str]) – Renewal frequency.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

consumption_configuration_property = licensemanager_mixins.CfnLicensePropsMixin.ConsumptionConfigurationProperty(
    borrow_configuration=licensemanager_mixins.CfnLicensePropsMixin.BorrowConfigurationProperty(
        allow_early_check_in=False,
        max_time_to_live_in_minutes=123
    ),
    provisional_configuration=licensemanager_mixins.CfnLicensePropsMixin.ProvisionalConfigurationProperty(
        max_time_to_live_in_minutes=123
    ),
    renew_type="renewType"
)

Attributes

borrow_configuration

Details about a borrow configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-borrowconfiguration

provisional_configuration

Details about a provisional configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-provisionalconfiguration

renew_type

Renewal frequency.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-renewtype

EntitlementProperty

class CfnLicensePropsMixin.EntitlementProperty(*, allow_check_in=None, max_count=None, name=None, overage=None, unit=None, value=None)

Bases: object

Describes a resource entitled for use with a license.

Parameters:

allow_check_in (Union[bool, IResolvable, None]) – Indicates whether check-ins are allowed.
max_count (Union[int, float, None]) – Maximum entitlement count. Use if the unit is not None.
name (Optional[str]) – Entitlement name.
overage (Union[bool, IResolvable, None]) – Indicates whether overages are allowed.
unit (Optional[str]) – Entitlement unit.
value (Optional[str]) – Entitlement resource. Use only if the unit is None.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

entitlement_property = licensemanager_mixins.CfnLicensePropsMixin.EntitlementProperty(
    allow_check_in=False,
    max_count=123,
    name="name",
    overage=False,
    unit="unit",
    value="value"
)

Attributes

allow_check_in

Indicates whether check-ins are allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-allowcheckin

max_count

Maximum entitlement count.

Use if the unit is not None.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-maxcount

name

Entitlement name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-name

overage

Indicates whether overages are allowed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-overage

unit

Entitlement unit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-unit

value

Entitlement resource.

Use only if the unit is None.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-value

IssuerDataProperty

class CfnLicensePropsMixin.IssuerDataProperty(*, name=None, sign_key=None)

Bases: object

Details associated with the issuer of a license.

Parameters:

name (Optional[str]) – Issuer name.
sign_key (Optional[str]) – Asymmetric KMS key from AWS Key Management Service . The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-issuerdata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

issuer_data_property = licensemanager_mixins.CfnLicensePropsMixin.IssuerDataProperty(
    name="name",
    sign_key="signKey"
)

Attributes

name

Issuer name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-issuerdata.html#cfn-licensemanager-license-issuerdata-name

sign_key

Asymmetric KMS key from AWS Key Management Service .

The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-issuerdata.html#cfn-licensemanager-license-issuerdata-signkey

MetadataProperty

class CfnLicensePropsMixin.MetadataProperty(*, name=None, value=None)

Bases: object

Describes key/value pairs.

Parameters:

name (Optional[str]) – The key name.
value (Optional[str]) – The value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-metadata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

metadata_property = licensemanager_mixins.CfnLicensePropsMixin.MetadataProperty(
    name="name",
    value="value"
)

Attributes

name

The key name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-metadata.html#cfn-licensemanager-license-metadata-name

value

The value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-metadata.html#cfn-licensemanager-license-metadata-value

ProvisionalConfigurationProperty

class CfnLicensePropsMixin.ProvisionalConfigurationProperty(*, max_time_to_live_in_minutes=None)

Bases: object

Details about a provisional configuration.

Parameters:: max_time_to_live_in_minutes (Union[int, float, None]) – Maximum time for the provisional configuration, in minutes.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-provisionalconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

provisional_configuration_property = licensemanager_mixins.CfnLicensePropsMixin.ProvisionalConfigurationProperty(
    max_time_to_live_in_minutes=123
)

Attributes

max_time_to_live_in_minutes

Maximum time for the provisional configuration, in minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-provisionalconfiguration.html#cfn-licensemanager-license-provisionalconfiguration-maxtimetoliveinminutes

ValidityDateFormatProperty

class CfnLicensePropsMixin.ValidityDateFormatProperty(*, begin=None, end=None)

Bases: object

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

Parameters:

begin (Optional[str]) – Start of the time range.
end (Optional[str]) – End of the time range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-validitydateformat.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_licensemanager import mixins as licensemanager_mixins

validity_date_format_property = licensemanager_mixins.CfnLicensePropsMixin.ValidityDateFormatProperty(
    begin="begin",
    end="end"
)

Attributes

begin

Start of the time range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-validitydateformat.html#cfn-licensemanager-license-validitydateformat-begin

end

End of the time range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-validitydateformat.html#cfn-licensemanager-license-validitydateformat-end