Class CfnLambdaHook

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnLambdaHook

Implements

IInspectable

ILambdaHookRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

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

CfnLambdaHook(Construct, string, ICfnLambdaHookProps)

Create a new AWS::CloudFormation::LambdaHook.

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

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnLambdaHook(object)	Checks whether the given object is a CfnLambdaHook.
RenderProperties(IDictionary<string, object>)	The AWS::CloudFormation::LambdaHook resource creates and activates a Lambda Hook.

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.

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

Properties

Alias

The type name alias for the Hook.

public virtual string Alias { get; set; }

Property Value

string

Remarks

This alias must be unique per account and Region.

AttrHookArn

Returns the ARN of a Lambda Hook.

public virtual string AttrHookArn { get; }

Property Value

string

Remarks

CloudformationAttribute: HookArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

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

CfnResource.CfnProperties

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

ExecutionRole

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

public virtual string ExecutionRole { get; set; }

Property Value

string

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

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

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

HookStatus

Specifies if the Hook is ENABLED or DISABLED .

public virtual string HookStatus { get; set; }

Property Value

string

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

LambdaFunction

Specifies the Lambda function for the Hook.

public virtual string LambdaFunction { get; set; }

Property Value

string

Remarks

You can use:.

LambdaHookRef

A reference to a LambdaHook resource.

public virtual ILambdaHookReference LambdaHookRef { get; }

Property Value

ILambdaHookReference

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

StackFilters

Specifies the stack level filters for the Hook.

public virtual object? StackFilters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLambdaHook.IStackFiltersProperty

TargetFilters

Specifies the target filters for the Hook.

public virtual object? TargetFilters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLambdaHook.ITargetFiltersProperty

TargetOperations

Specifies the list of operations the Hook is run against.

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

Property Value

string[]

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

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.

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

IsCfnLambdaHook(object)

Checks whether the given object is a CfnLambdaHook.

public static bool IsCfnLambdaHook(object x)

Parameters

x object

Returns

bool

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

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

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You can use a Lambda Hook to evaluate your resources before allowing stack operations. This resource forwards requests for resource evaluation to a Lambda function.

For more information, see Lambda Hooks in the CloudFormation Hooks User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

CloudformationResource: AWS::CloudFormation::LambdaHook

ExampleMetadata: fixture=_generated

Implements

IInspectable

ILambdaHookRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware