CfnHookTypeConfigProps

class aws_cdk.CfnHookTypeConfigProps(*, configuration, configuration_alias=None, type_arn=None, type_name=None)

Bases: object

Properties for defining a CfnHookTypeConfig.

Parameters:

configuration (str) – Specifies the activated Hook type configuration, in this AWS account and AWS Region . You must specify either TypeName and Configuration or TypeArn and Configuration .
configuration_alias (Optional[str]) – An alias by which to refer to this configuration data. Defaults to default alias. Hook types currently support default configuration alias. Default: - “default”
type_arn (Optional[str]) – The Amazon Resource Number (ARN) for the Hook to set Configuration for. You must specify either TypeName and Configuration or TypeArn and Configuration .
type_name (Optional[str]) – The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook . You must specify either TypeName and Configuration or TypeArn and Configuration .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.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_type_config_props = cdk.CfnHookTypeConfigProps(
    configuration="configuration",

    # the properties below are optional
    configuration_alias="configurationAlias",
    type_arn="typeArn",
    type_name="typeName"
)

Attributes

configuration

Specifies the activated Hook type configuration, in this AWS account and AWS Region .

You must specify either TypeName and Configuration or TypeArn and Configuration .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration

configuration_alias

An alias by which to refer to this configuration data.

Defaults to default alias. Hook types currently support default configuration alias.

Default:

“default”

See:

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

type_arn

The Amazon Resource Number (ARN) for the Hook to set Configuration for.

You must specify either TypeName and Configuration or TypeArn and Configuration .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typearn

type_name

The unique name for your Hook.

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

You must specify either TypeName and Configuration or TypeArn and Configuration .

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