interface CfnHookTypeConfigProps

Language	Type name
.NET	Amazon.CDK.AWS.CloudFormation.CfnHookTypeConfigProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudformation#CfnHookTypeConfigProps
Java	software.amazon.awscdk.services.cloudformation.CfnHookTypeConfigProps
Python	aws_cdk.aws_cloudformation.CfnHookTypeConfigProps
TypeScript	aws-cdk-lib » aws_cloudformation » CfnHookTypeConfigProps

Properties for defining a CfnHookTypeConfig.

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

Example

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

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

Properties

Name	Type	Description
configuration	string	Specifies the activated Hook type configuration, in this AWS account and AWS Region .
configurationAlias?	string	An alias by which to refer to this configuration data.
typeArn?	string	The Amazon Resource Number (ARN) for the Hook to set Configuration for.
typeName?	string	The unique name for your Hook.

---

configuration

Type: string

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-configuration

---

configurationAlias?

Type: string (optional, default: "default")

An alias by which to refer to this configuration data.

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

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

---

typeArn?

Type: string (optional)

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

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

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

---

typeName?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-hooktypeconfig.html#cfn-cloudformation-hooktypeconfig-typename