CfnLicense

class aws_cdk.aws_licensemanager.CfnLicense(scope, id, *, consumption_configuration, entitlements, home_region, issuer, license_name, product_name, validity, beneficiary=None, license_metadata=None, product_sku=None, status=None)

Bases: aws_cdk.core.CfnResource

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 .

CloudformationResource

AWS::LicenseManager::License

Link

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

ExampleMetadata

fixture=_generated

Example:

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

cfn_license = licensemanager.CfnLicense(self, "MyCfnLicense",
    consumption_configuration=licensemanager.CfnLicense.ConsumptionConfigurationProperty(
        borrow_configuration=licensemanager.CfnLicense.BorrowConfigurationProperty(
            allow_early_check_in=False,
            max_time_to_live_in_minutes=123
        ),
        provisional_configuration=licensemanager.CfnLicense.ProvisionalConfigurationProperty(
            max_time_to_live_in_minutes=123
        ),
        renew_type="renewType"
    ),
    entitlements=[licensemanager.CfnLicense.EntitlementProperty(
        name="name",
        unit="unit",

        # the properties below are optional
        allow_check_in=False,
        max_count=123,
        overage=False,
        value="value"
    )],
    home_region="homeRegion",
    issuer=licensemanager.CfnLicense.IssuerDataProperty(
        name="name",

        # the properties below are optional
        sign_key="signKey"
    ),
    license_name="licenseName",
    product_name="productName",
    validity=licensemanager.CfnLicense.ValidityDateFormatProperty(
        begin="begin",
        end="end"
    ),

    # the properties below are optional
    beneficiary="beneficiary",
    license_metadata=[licensemanager.CfnLicense.MetadataProperty(
        name="name",
        value="value"
    )],
    product_sku="productSku",
    status="status"
)

Create a new AWS::LicenseManager::License.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::LicenseManager::License'
attr_license_arn

The Amazon Resource Name (ARN) of the license.

CloudformationAttribute

LicenseArn

Return type

str

attr_version

The license version.

CloudformationAttribute

Version

Return type

str

beneficiary

License beneficiary.

Link

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

consumption_configuration

Configuration for consumption of the license.

Link

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

Return type

Union[ConsumptionConfigurationProperty, IResolvable]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

entitlements

License entitlements.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, EntitlementProperty]]]

home_region

Home Region of the license.

Link

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

Return type

str

issuer

License issuer.

Link

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

Return type

Union[IResolvable, IssuerDataProperty]

license_metadata

License metadata.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, MetadataProperty]], None]

license_name

License name.

Link

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

Return type

str

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

product_name

Product name.

Link

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

Return type

str

product_sku

Product SKU.

Link

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

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

status

License status.

Link

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

Return type

Optional[str]

validity

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

Link

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

Return type

Union[IResolvable, ValidityDateFormatProperty]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

BorrowConfigurationProperty

class CfnLicense.BorrowConfigurationProperty(*, allow_early_check_in, max_time_to_live_in_minutes)

Bases: object

Details about a borrow configuration.

Parameters
  • allow_early_check_in (Union[bool, IResolvable]) – Indicates whether early check-ins are allowed.

  • max_time_to_live_in_minutes (Union[int, float]) – Maximum time for the borrow configuration, in minutes.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

borrow_configuration_property = licensemanager.CfnLicense.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.

Link

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

Return type

Union[bool, IResolvable]

max_time_to_live_in_minutes

Maximum time for the borrow configuration, in minutes.

Link

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

Return type

Union[int, float]

ConsumptionConfigurationProperty

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

Bases: object

Details about a consumption configuration.

Parameters
Link

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.
import aws_cdk.aws_licensemanager as licensemanager

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

Attributes

borrow_configuration

Details about a borrow configuration.

Link

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

Return type

Union[IResolvable, BorrowConfigurationProperty, None]

provisional_configuration

Details about a provisional configuration.

Link

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

Return type

Union[IResolvable, ProvisionalConfigurationProperty, None]

renew_type

Renewal frequency.

Link

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

Return type

Optional[str]

EntitlementProperty

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

Bases: object

Describes a resource entitled for use with a license.

Parameters
  • name (str) – Entitlement name.

  • unit (str) – Entitlement unit.

  • 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.

  • overage (Union[bool, IResolvable, None]) – Indicates whether overages are allowed.

  • value (Optional[str]) – Entitlement resource. Use only if the unit is None.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

entitlement_property = licensemanager.CfnLicense.EntitlementProperty(
    name="name",
    unit="unit",

    # the properties below are optional
    allow_check_in=False,
    max_count=123,
    overage=False,
    value="value"
)

Attributes

allow_check_in

Indicates whether check-ins are allowed.

Link

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

Return type

Union[bool, IResolvable, None]

max_count

Maximum entitlement count.

Use if the unit is not None.

Link

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

Return type

Union[int, float, None]

name

Entitlement name.

Link

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

Return type

str

overage

Indicates whether overages are allowed.

Link

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

Return type

Union[bool, IResolvable, None]

unit

Entitlement unit.

Link

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

Return type

str

value

Entitlement resource.

Use only if the unit is None.

Link

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

Return type

Optional[str]

IssuerDataProperty

class CfnLicense.IssuerDataProperty(*, name, sign_key=None)

Bases: object

Details associated with the issuer of a license.

Parameters
  • name (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.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

issuer_data_property = licensemanager.CfnLicense.IssuerDataProperty(
    name="name",

    # the properties below are optional
    sign_key="signKey"
)

Attributes

name

Issuer name.

Link

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

Return type

str

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.

Link

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

Return type

Optional[str]

MetadataProperty

class CfnLicense.MetadataProperty(*, name, value)

Bases: object

Describes key/value pairs.

Parameters
  • name (str) – The key name.

  • value (str) – The value.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

metadata_property = licensemanager.CfnLicense.MetadataProperty(
    name="name",
    value="value"
)

Attributes

name

The key name.

Link

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

Return type

str

value

The value.

Link

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

Return type

str

ProvisionalConfigurationProperty

class CfnLicense.ProvisionalConfigurationProperty(*, max_time_to_live_in_minutes)

Bases: object

Details about a provisional configuration.

Parameters

max_time_to_live_in_minutes (Union[int, float]) – Maximum time for the provisional configuration, in minutes.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

provisional_configuration_property = licensemanager.CfnLicense.ProvisionalConfigurationProperty(
    max_time_to_live_in_minutes=123
)

Attributes

max_time_to_live_in_minutes

Maximum time for the provisional configuration, in minutes.

Link

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

Return type

Union[int, float]

ValidityDateFormatProperty

class CfnLicense.ValidityDateFormatProperty(*, begin, end)

Bases: object

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

Parameters
  • begin (str) – Start of the time range.

  • end (str) – End of the time range.

Link

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.
import aws_cdk.aws_licensemanager as licensemanager

validity_date_format_property = licensemanager.CfnLicense.ValidityDateFormatProperty(
    begin="begin",
    end="end"
)

Attributes

begin

Start of the time range.

Link

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

Return type

str

end

End of the time range.

Link

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

Return type

str