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: CfnResource

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html
CloudformationResource:: AWS::LicenseManager::License
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 import 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"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
consumption_configuration (Union[IResolvable, ConsumptionConfigurationProperty, Dict[str, Any]]) – Configuration for consumption of the license.
entitlements (Union[IResolvable, Sequence[Union[IResolvable, EntitlementProperty, Dict[str, Any]]]]) – License entitlements.
home_region (str) – Home Region of the license.
issuer (Union[IResolvable, IssuerDataProperty, Dict[str, Any]]) – License issuer.
license_name (str) – License name.
product_name (str) – Product name.
validity (Union[IResolvable, ValidityDateFormatProperty, Dict[str, Any]]) – Date and time range during which the license is valid, in ISO8601-UTC format.
beneficiary (Optional[str]) – License beneficiary.
license_metadata (Union[IResolvable, Sequence[Union[IResolvable, MetadataProperty, Dict[str, Any]]], None]) – License metadata.
product_sku (Optional[str]) – Product SKU.
status (Optional[str]) – License status.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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.

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"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

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

attr_version

The license version.

CloudformationAttribute:: Version

beneficiary: License beneficiary.

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

cfn_resource_type: AWS resource type.

consumption_configuration: Configuration for consumption of the license.

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.

entitlements: License entitlements.

home_region: Home Region of the license.

issuer: License issuer.

license_metadata: License metadata.

license_name: License name.

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

Returns:

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

node: The tree node.

product_name: Product name.

product_sku: Product SKU.

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 }).

stack

The stack in which this element is defined.

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

status: License status.

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

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

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.

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

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 CfnLicense.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 import 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.

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

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

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

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

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

    # the properties below are optional
    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 CfnLicense.MetadataProperty(*, name, value)

Bases: object

Describes key/value pairs.

Parameters:

name (str) – The key name.
value (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 import aws_licensemanager as licensemanager

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

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

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.

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

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