CfnResourceVersionPropsMixin

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

Bases: Mixin

The AWS::CloudFormation::ResourceVersion resource registers a resource version with the CloudFormation registry.

Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:

  • Validating the resource schema.

  • Determining which handlers, if any, have been specified for the resource.

  • Making the resource available for use in your account.

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.

See:

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

CloudformationResource:

AWS::CloudFormation::ResourceVersion

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_resource_version_props_mixin = cloudformation.CfnResourceVersionPropsMixin(cloudformation.CfnResourceVersionMixinProps(
    execution_role_arn="executionRoleArn",
    logging_config=cloudformation.CfnResourceVersionPropsMixin.LoggingConfigProperty(
        log_group_name="logGroupName",
        log_role_arn="logRoleArn"
    ),
    schema_handler_package="schemaHandlerPackage",
    type_name="typeName"
),
    strategy=merge_strategy
)

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

Parameters:
  • props (Union[CfnResourceVersionMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

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 = ['executionRoleArn', 'loggingConfig', 'schemaHandlerPackage', 'typeName']

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.

LoggingConfigProperty

class CfnResourceVersionPropsMixin.LoggingConfigProperty(*, log_group_name=None, log_role_arn=None)

Bases: object

Logging configuration information for a resource.

Parameters:
  • log_group_name (Optional[str]) – The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type’s handlers.

  • log_role_arn (Optional[str]) – The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.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

logging_config_property = cloudformation.CfnResourceVersionPropsMixin.LoggingConfigProperty(
    log_group_name="logGroupName",
    log_role_arn="logRoleArn"
)

Attributes

log_group_name

The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type’s handlers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-loggroupname

log_role_arn

The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-resourceversion-loggingconfig.html#cfn-cloudformation-resourceversion-loggingconfig-logrolearn