Class CfnLambdaHook

The AWS::CloudFormation::LambdaHook resource creates and activates a Lambda Hook.

Inheritance

CfnLambdaHook

Implements

IConstruct

IDependable

Inherited Members

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLambdaHook : CfnResource, IInspectable, ILambdaHookRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnLambdaHook Inherits CfnResource Implements IInspectable, ILambdaHookRef, IConstruct, IDependable, IEnvironmentAware

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;

             var cfnLambdaHook = new CfnLambdaHook(this, "MyCfnLambdaHook", new CfnLambdaHookProps {
                 Alias = "alias",
                 ExecutionRole = "executionRole",
                 FailureMode = "failureMode",
                 HookStatus = "hookStatus",
                 LambdaFunction = "lambdaFunction",
                 TargetOperations = new [] { "targetOperations" },

                 // the properties below are optional
                 StackFilters = new StackFiltersProperty {
                     FilteringCriteria = "filteringCriteria",

                     // the properties below are optional
                     StackNames = new StackNamesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     },
                     StackRoles = new StackRolesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     }
                 },
                 TargetFilters = new TargetFiltersProperty {
                     Targets = new [] { new HookTargetProperty {
                         Action = "action",
                         InvocationPoint = "invocationPoint",
                         TargetName = "targetName"
                     } },

                     // the properties below are optional
                     Actions = new [] { "actions" },
                     InvocationPoints = new [] { "invocationPoints" },
                     TargetNames = new [] { "targetNames" }
                 }
             });

Synopsis

Constructors

Properties

Alias	The type name alias for the Hook.
AttrHookArn	Returns the ARN of a Lambda Hook.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::CloudFormation::LambdaHook` resource creates and activates a Lambda Hook.
ExecutionRole	The IAM role that the Hook assumes to invoke your Lambda function.
FailureMode	Specifies how the Hook responds when the Lambda function invoked by the Hook returns a `FAILED` response.
HookStatus	Specifies if the Hook is `ENABLED` or `DISABLED` .
LambdaFunction	Specifies the Lambda function for the Hook.
LambdaHookRef	A reference to a LambdaHook resource.
StackFilters	Specifies the stack level filters for the Hook.
TargetFilters	Specifies the target filters for the Hook.
TargetOperations	Specifies the list of operations the Hook is run against.

Methods

Constructors

CfnLambdaHook(Construct, string, ICfnLambdaHookProps)

Create a new AWS::CloudFormation::LambdaHook.

public CfnLambdaHook(Construct scope, string id, ICfnLambdaHookProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnLambdaHookProps: Resource properties.

Properties

Alias

The type name alias for the Hook.

public virtual string Alias { get; set; }

Property Value

string

AttrHookArn

Returns the ARN of a Lambda Hook.

public virtual string AttrHookArn { get; }

Property Value

string

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

The AWS::CloudFormation::LambdaHook resource creates and activates a Lambda Hook.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

ExecutionRole

The IAM role that the Hook assumes to invoke your Lambda function.

public virtual string ExecutionRole { get; set; }

Property Value

string

FailureMode

Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.

public virtual string FailureMode { get; set; }

Property Value

string

HookStatus

Specifies if the Hook is ENABLED or DISABLED .

public virtual string HookStatus { get; set; }

Property Value

string

LambdaFunction

Specifies the Lambda function for the Hook.

public virtual string LambdaFunction { get; set; }

Property Value

string

LambdaHookRef

A reference to a LambdaHook resource.

public virtual ILambdaHookReference LambdaHookRef { get; }

Property Value

ILambdaHookReference

StackFilters

Specifies the stack level filters for the Hook.

public virtual object? StackFilters { get; set; }

Property Value

object

TargetFilters

Specifies the target filters for the Hook.

public virtual object? TargetFilters { get; set; }

Property Value

object

TargetOperations

Specifies the list of operations the Hook is run against.

public virtual string[] TargetOperations { get; set; }

Property Value

string[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

IsCfnLambdaHook(object)

Checks whether the given object is a CfnLambdaHook.

public static bool IsCfnLambdaHook(object x)

Parameters

x object

Returns

bool

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::LambdaHook resource creates and activates a Lambda Hook.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

Implements

Constructs.IConstruct

Constructs.IDependable