CfnHookVersionProps
- class aws_cdk.aws_cloudformation.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 for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development . .. epigraph:: The user registering the resource must be able to access the package in the S3 bucket. That’s, the user must have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .type_name (
str
) – The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern ofOrganization::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:
- 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_cloudformation as cloudformation cfn_hook_version_props = cloudformation.CfnHookVersionProps( schema_handler_package="schemaHandlerPackage", type_name="typeName", # the properties below are optional execution_role_arn="executionRoleArn", logging_config=cloudformation.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.
- logging_config
Contains logging configuration information for an extension.
- 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 for the resource you want to register, see submit in the CloudFormation CLI User Guide for Extension Development . .. epigraph:
The user registering the resource must be able to access the package in the S3 bucket. That's, the user must have `GetObject <https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html>`_ permissions for the schema handler package. For more information, see `Actions, Resources, and Condition Keys for Amazon S3 <https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html>`_ in the *AWS Identity and Access Management User Guide* .
- 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``