CfnGeneratedTemplatePropsMixin

class aws_cdk.cfn_property_mixins.aws_cloudformation.CfnGeneratedTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a generated template from existing resources using the CloudFormation IaC Generator.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-generatedtemplate.html

CloudformationResource:

AWS::CloudFormation::GeneratedTemplate

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.cfn_property_mixins import aws_cloudformation as cloudformation
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_generated_template_props_mixin = cloudformation.CfnGeneratedTemplatePropsMixin(cloudformation.CfnGeneratedTemplateMixinProps(
    generated_template_name="generatedTemplateName",
    template_configuration=cloudformation.CfnGeneratedTemplatePropsMixin.TemplateConfigurationProperty(
        deletion_policy="deletionPolicy",
        update_replace_policy="updateReplacePolicy"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::CloudFormation::GeneratedTemplate.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['generatedTemplateName', 'templateConfiguration']

Static Methods

classmethod is_mixin(x)

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.

TemplateConfigurationProperty

class CfnGeneratedTemplatePropsMixin.TemplateConfigurationProperty(*, deletion_policy=None, update_replace_policy=None)

Bases: object

The configuration details of the generated template.

Parameters:

  • deletion_policy (Optional[str]) – The DeletionPolicy assigned to resources in the generated template.

  • update_replace_policy (Optional[str]) – The UpdateReplacePolicy assigned to resources in the generated template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateconfiguration.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.cfn_property_mixins import aws_cloudformation as cloudformation

template_configuration_property = cloudformation.CfnGeneratedTemplatePropsMixin.TemplateConfigurationProperty(
    deletion_policy="deletionPolicy",
    update_replace_policy="updateReplacePolicy"
)

Attributes

deletion_policy

The DeletionPolicy assigned to resources in the generated template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateconfiguration.html#cfn-cloudformation-generatedtemplate-templateconfiguration-deletionpolicy

update_replace_policy

The UpdateReplacePolicy assigned to resources in the generated template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateconfiguration.html#cfn-cloudformation-generatedtemplate-templateconfiguration-updatereplacepolicy

TemplateProgressProperty

class CfnGeneratedTemplatePropsMixin.TemplateProgressProperty(*, resources_failed=None, resources_pending=None, resources_processing=None, resources_succeeded=None)

Bases: object

A summary of the progress of the template generation.

Parameters:

  • resources_failed (Union[int, float, None]) – The number of resources that failed the template generation.

  • resources_pending (Union[int, float, None]) – The number of resources that are still pending the template generation.

  • resources_processing (Union[int, float, None]) – The number of resources that are in-process for the template generation.

  • resources_succeeded (Union[int, float, None]) – The number of resources that succeeded the template generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateprogress.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.cfn_property_mixins import aws_cloudformation as cloudformation

template_progress_property = cloudformation.CfnGeneratedTemplatePropsMixin.TemplateProgressProperty(
    resources_failed=123,
    resources_pending=123,
    resources_processing=123,
    resources_succeeded=123
)

Attributes

resources_failed

The number of resources that failed the template generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateprogress.html#cfn-cloudformation-generatedtemplate-templateprogress-resourcesfailed

resources_pending

The number of resources that are still pending the template generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateprogress.html#cfn-cloudformation-generatedtemplate-templateprogress-resourcespending

resources_processing

The number of resources that are in-process for the template generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateprogress.html#cfn-cloudformation-generatedtemplate-templateprogress-resourcesprocessing

resources_succeeded

The number of resources that succeeded the template generation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-generatedtemplate-templateprogress.html#cfn-cloudformation-generatedtemplate-templateprogress-resourcessucceeded