Package software.amazon.awscdk

Interface CfnHookTypeConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnHookTypeConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:30.857Z")
@Stability(Stable)
public interface CfnHookTypeConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnHookTypeConfig.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnHookTypeConfigProps cfnHookTypeConfigProps = CfnHookTypeConfigProps.builder()
         .configuration("configuration")
         // the properties below are optional
         .configurationAlias("configurationAlias")
         .typeArn("typeArn")
         .typeName("typeName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnHookTypeConfigProps.Builder	A builder for CfnHookTypeConfigProps
static final class	CfnHookTypeConfigProps.Jsii$Proxy	An implementation for CfnHookTypeConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnHookTypeConfigProps.Builder	builder()
String	getConfiguration()	Specifies the activated Hook type configuration, in this AWS account and AWS Region .
default String	getConfigurationAlias()	An alias by which to refer to this configuration data.
default String	getTypeArn()	The Amazon Resource Number (ARN) for the Hook to set Configuration for.
default String	getTypeName()	The unique name for your Hook.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfiguration

@Stability(Stable)
@NotNull
String getConfiguration()

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

getConfigurationAlias

@Stability(Stable)
@Nullable
default String getConfigurationAlias()

An alias by which to refer to this configuration data.

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

Default: - "default"

See Also:

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

getTypeArn

@Stability(Stable)
@Nullable
default String getTypeArn()

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

getTypeName

@Stability(Stable)
@Nullable
default String getTypeName()

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

builder

@Stability(Stable)
static CfnHookTypeConfigProps.Builder builder()

Returns:

a CfnHookTypeConfigProps.Builder of CfnHookTypeConfigProps