Package software.amazon.awscdk

Class CfnHook

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnHook
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
CfnCodeDeployBlueGreenHook
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-11T23:26:27.408Z") @Stability(Stable) public class CfnHook extends CfnElement
Represents a CloudFormation resource.

Example: 

 CfnInclude cfnTemplate;
 // mutating the hook
 Role myRole;
 CfnHook hook = cfnTemplate.getHook("MyOutput");
 CfnCodeDeployBlueGreenHook codeDeployHook = (CfnCodeDeployBlueGreenHook)hook;
 codeDeployHook.getServiceRole() = myRole.getRoleArn();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnHook.Builder
    A fluent builder for CfnHook.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CfnHook(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnHook(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    CfnHook(software.constructs.Construct scope, String id, CfnHookProps props)
    Creates a new Hook object.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getType()
    The type of the hook (for example, "AWS::CodeDeploy::BlueGreen").
    protected Map<String,Object>
    renderProperties()
     
    protected Map<String,Object>
    renderProperties(Map<String,Object> props)
     

    Methods inherited from class software.amazon.awscdk.CfnElement

    getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • CfnHook

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

    • CfnHook

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

    • CfnHook

      @Stability(Stable) public CfnHook(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnHookProps props)
      Creates a new Hook object.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • renderProperties

      @Stability(Stable) @Nullable protected Map<String,Object> renderProperties(@Nullable Map<String,Object> props)
      Parameters:
      props -

    • renderProperties

      @Stability(Stable) @Nullable protected Map<String,Object> renderProperties()

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the hook (for example, "AWS::CodeDeploy::BlueGreen").