CfnHookVersionProps

class aws_cdk.CfnHookVersionProps(*, schema_handler_package, type_name, execution_role_arn=None, logging_config=None)

Bases: object

Properties for defining a CfnHookVersion.

Parameters:

  • schema_handler_package (str) – A URL to the Amazon S3 bucket containing the Hook project package that contains the necessary files for the Hook you want to register. For information on generating a schema handler package, see Modeling custom CloudFormation Hooks in the AWS CloudFormation Hooks User Guide . .. epigraph:: To register the Hook, you must have s3:GetObject permissions to access the S3 objects.

  • type_name (str) – The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook . .. epigraph:: The following organization namespaces are reserved and can’t be used in your hook type names: - Alexa - AMZN - Amazon - ASK - AWS - Custom - Dev

  • execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

  • logging_config (Union[IResolvable, LoggingConfigProperty, Dict[str, Any], None]) – Contains logging configuration information for an extension.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.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 as cdk

cfn_hook_version_props = cdk.CfnHookVersionProps(
    schema_handler_package="schemaHandlerPackage",
    type_name="typeName",

    # the properties below are optional
    execution_role_arn="executionRoleArn",
    logging_config=cdk.CfnHookVersion.LoggingConfigProperty(
        log_group_name="logGroupName",
        log_role_arn="logRoleArn"
    )
)

Attributes

execution_role_arn

The Amazon Resource Name (ARN) of the task execution role that grants the Hook permission.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-executionrolearn

logging_config

Contains logging configuration information for an extension.

See:

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

schema_handler_package

A URL to the Amazon S3 bucket containing the Hook project package that contains the necessary files for the Hook you want to register.

For information on generating a schema handler package, see Modeling custom CloudFormation Hooks in the AWS CloudFormation Hooks User Guide . .. epigraph:

To register the Hook, you must have ``s3:GetObject`` permissions to access the S3 objects.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-schemahandlerpackage

type_name

The unique name for your hook.

Specifies a three-part namespace for your hook, with a recommended pattern of Organization::Service::Hook . .. epigraph:

The following organization namespaces are reserved and can't be used in your hook type names:

- ``Alexa``
- ``AMZN``
- ``Amazon``
- ``ASK``
- ``AWS``
- ``Custom``
- ``Dev``
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hookversion.html#cfn-cloudformation-hookversion-typename