Package software.amazon.awscdk

Class CfnHookTypeConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnHookTypeConfig
All Implemented Interfaces:
IEnvironmentAware, IHookTypeConfigRef, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:56.686Z") @Stability(Stable) public class CfnHookTypeConfig extends CfnResource implements IInspectable, IHookTypeConfigRef
The AWS::CloudFormation::HookTypeConfig resource specifies the configuration of an activated Hook.

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the AWS CloudFormation User Guide .

Example: 

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

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnHookTypeConfig

      protected CfnHookTypeConfig(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnHookTypeConfig

      protected CfnHookTypeConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnHookTypeConfig

      @Stability(Stable) public CfnHookTypeConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHookTypeConfigProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrConfigurationArn

      @Stability(Stable) @NotNull public String getAttrConfigurationArn()
      The Amazon Resource Number (ARN) of the activated Hook type configuration in this account and Region.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getHookTypeConfigRef

      @Stability(Stable) @NotNull public HookTypeConfigReference getHookTypeConfigRef()
      A reference to a HookTypeConfig resource.
      Specified by:
      getHookTypeConfigRef in interface IHookTypeConfigRef

    • getConfiguration

      @Stability(Stable) @NotNull public String getConfiguration()
      Specifies the activated Hook type configuration, in this AWS account and AWS Region .

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull String value)
      Specifies the activated Hook type configuration, in this AWS account and AWS Region .

    • getConfigurationAlias

      @Stability(Stable) @Nullable public String getConfigurationAlias()
      An alias by which to refer to this configuration data.

    • setConfigurationAlias

      @Stability(Stable) public void setConfigurationAlias(@Nullable String value)
      An alias by which to refer to this configuration data.

    • getTypeArn

      @Stability(Stable) @Nullable public String getTypeArn()
      The Amazon Resource Number (ARN) for the Hook to set Configuration for.

    • setTypeArn

      @Stability(Stable) public void setTypeArn(@Nullable String value)
      The Amazon Resource Number (ARN) for the Hook to set Configuration for.

    • getTypeName

      @Stability(Stable) @Nullable public String getTypeName()
      The unique name for your Hook.

    • setTypeName

      @Stability(Stable) public void setTypeName(@Nullable String value)
      The unique name for your Hook.