aws-cdk-lib.CfnHookTypeConfigProps

CfnHookTypeConfigProps Struct

Properties for defining a CfnHookTypeConfig.

CfnHookTypeConfigProps

used as props by

• CfnHookTypeConfig

Source

Generated code

Type last changed

v2.88.0 · 20 Jul 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnHookTypeConfigProps: cdk.CfnHookTypeConfigProps = {
  configuration: 'configuration',

  // the properties below are optional
  configurationAlias: 'configurationAlias',
  typeArn: 'typeArn',
  typeName: 'typeName',
};

Properties

configurationstringconfigurationstrconfigurationStringConfigurationstringConfiguration*stringrequired#

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

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

configurationAlias?optionalstringconfiguration_alias?optionalstrconfigurationAlias?optionalStringConfigurationAlias?optionalstringConfigurationAlias?optional*string= "default"#

An alias by which to refer to this configuration data.

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

typeArn?optionalstringtype_arn?optionalstrtypeArn?optionalStringTypeArn?optionalstringTypeArn?optional*string#

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

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

typeName?optionalstringtype_name?optionalstrtypeName?optionalStringTypeName?optionalstringTypeName?optional*string#

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 .