Package software.amazon.awscdk.services.cloudformation

Class CfnHookTypeConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudformation.CfnHookTypeConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.506Z") @Stability(Stable) public class CfnHookTypeConfig extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFormation::HookTypeConfig.

The HookTypeConfig resource specifies the configuration of a hook.

Example: 

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

  • 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 Construct scope, @NotNull String id, @NotNull CfnHookTypeConfigProps props)
      Create a new AWS::CloudFormation::HookTypeConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • getConfiguration

      @Stability(Stable) @NotNull public 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 .

    • setConfiguration

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

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

    • getConfigurationAlias

      @Stability(Stable) @Nullable public String getConfigurationAlias()
      Specifies the activated hook type configuration, in this AWS account and AWS Region .

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

    • setConfigurationAlias

      @Stability(Stable) public void setConfigurationAlias(@Nullable String value)
      Specifies the activated hook type configuration, in this AWS account and AWS Region .

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

    • getTypeArn

      @Stability(Stable) @Nullable public 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 .

    • setTypeArn

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

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

    • getTypeName

      @Stability(Stable) @Nullable public 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 .

    • setTypeName

      @Stability(Stable) public void setTypeName(@Nullable String value)
      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 .