CfnHookVersionPropsMixin

class aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnHookVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::CloudFormation::HookVersion resource publishes new or first version of a Hook to the CloudFormation registry.

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

This resource type is not compatible with Guard and Lambda Hooks.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html
CloudformationResource:: AWS::CloudFormation::HookVersion
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_cloudformation import mixins as cloudformation_mixins

cfn_hook_version_props_mixin = cloudformation_mixins.CfnHookVersionPropsMixin(cloudformation_mixins.CfnHookVersionMixinProps(
    execution_role_arn="executionRoleArn",
    logging_config=cloudformation_mixins.CfnHookVersionPropsMixin.LoggingConfigProperty(
        log_group_name="logGroupName",
        log_role_arn="logRoleArn"
    ),
    schema_handler_package="schemaHandlerPackage",
    type_name="typeName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnHookVersionMixinProps, 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 = ['executionRoleArn', 'loggingConfig', 'schemaHandlerPackage', 'typeName']

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

LoggingConfigProperty

class CfnHookVersionPropsMixin.LoggingConfigProperty(*, log_group_name=None, log_role_arn=None)

Bases: object

The LoggingConfig property type specifies logging configuration information for an extension.

Parameters:

log_group_name (Optional[str]) – The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking the extension’s handlers.
log_role_arn (Optional[str]) – The Amazon Resource Name (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-hookversion-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.mixins_preview.aws_cloudformation import mixins as cloudformation_mixins

logging_config_property = cloudformation_mixins.CfnHookVersionPropsMixin.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 extension’s handlers.

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

log_role_arn

The Amazon Resource Name (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-hookversion-loggingconfig.html#cfn-cloudformation-hookversion-loggingconfig-logrolearn