Show / Hide Table of Contents

Class CfnGuardHookPropsMixin

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Inheritance
object
Mixin
CfnGuardHookPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.CloudFormation
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnGuardHookPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnGuardHookPropsMixin Inherits Mixin Implements IMixin
Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardHookPropsMixin = new CfnGuardHookPropsMixin(new CfnGuardHookMixinProps {
                 Alias = "alias",
                 ExecutionRole = "executionRole",
                 FailureMode = "failureMode",
                 HookStatus = "hookStatus",
                 LogBucket = "logBucket",
                 Options = new OptionsProperty {
                     InputParams = new S3LocationProperty {
                         Uri = "uri",
                         VersionId = "versionId"
                     }
                 },
                 RuleLocation = new S3LocationProperty {
                     Uri = "uri",
                     VersionId = "versionId"
                 },
                 StackFilters = new StackFiltersProperty {
                     FilteringCriteria = "filteringCriteria",
                     StackNames = new StackNamesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     },
                     StackRoles = new StackRolesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     }
                 },
                 TargetFilters = new TargetFiltersProperty {
                     Actions = new [] { "actions" },
                     InvocationPoints = new [] { "invocationPoints" },
                     TargetNames = new [] { "targetNames" },
                     Targets = new [] { new HookTargetProperty {
                         Action = "action",
                         InvocationPoint = "invocationPoint",
                         TargetName = "targetName"
                     } }
                 },
                 TargetOperations = new [] { "targetOperations" }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnGuardHookPropsMixin(ICfnGuardHookMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::CloudFormation::GuardHook.

Properties

CFN_PROPERTY_KEYS

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Props

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Strategy

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

Supports(IConstruct)

Check if this mixin supports the given construct.

Constructors

CfnGuardHookPropsMixin(ICfnGuardHookMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::CloudFormation::GuardHook.

public CfnGuardHookPropsMixin(ICfnGuardHookMixinProps props, ICfnPropertyMixinOptions? options = null)
Parameters
props ICfnGuardHookMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

protected static string[] CFN_PROPERTY_KEYS { get; }
Property Value

string[]

Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardHookPropsMixin = new CfnGuardHookPropsMixin(new CfnGuardHookMixinProps {
                 Alias = "alias",
                 ExecutionRole = "executionRole",
                 FailureMode = "failureMode",
                 HookStatus = "hookStatus",
                 LogBucket = "logBucket",
                 Options = new OptionsProperty {
                     InputParams = new S3LocationProperty {
                         Uri = "uri",
                         VersionId = "versionId"
                     }
                 },
                 RuleLocation = new S3LocationProperty {
                     Uri = "uri",
                     VersionId = "versionId"
                 },
                 StackFilters = new StackFiltersProperty {
                     FilteringCriteria = "filteringCriteria",
                     StackNames = new StackNamesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     },
                     StackRoles = new StackRolesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     }
                 },
                 TargetFilters = new TargetFiltersProperty {
                     Actions = new [] { "actions" },
                     InvocationPoints = new [] { "invocationPoints" },
                     TargetNames = new [] { "targetNames" },
                     Targets = new [] { new HookTargetProperty {
                         Action = "action",
                         InvocationPoint = "invocationPoint",
                         TargetName = "targetName"
                     } }
                 },
                 TargetOperations = new [] { "targetOperations" }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

protected virtual ICfnGuardHookMixinProps Props { get; }
Property Value

ICfnGuardHookMixinProps

Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardHookPropsMixin = new CfnGuardHookPropsMixin(new CfnGuardHookMixinProps {
                 Alias = "alias",
                 ExecutionRole = "executionRole",
                 FailureMode = "failureMode",
                 HookStatus = "hookStatus",
                 LogBucket = "logBucket",
                 Options = new OptionsProperty {
                     InputParams = new S3LocationProperty {
                         Uri = "uri",
                         VersionId = "versionId"
                     }
                 },
                 RuleLocation = new S3LocationProperty {
                     Uri = "uri",
                     VersionId = "versionId"
                 },
                 StackFilters = new StackFiltersProperty {
                     FilteringCriteria = "filteringCriteria",
                     StackNames = new StackNamesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     },
                     StackRoles = new StackRolesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     }
                 },
                 TargetFilters = new TargetFiltersProperty {
                     Actions = new [] { "actions" },
                     InvocationPoints = new [] { "invocationPoints" },
                     TargetNames = new [] { "targetNames" },
                     Targets = new [] { new HookTargetProperty {
                         Action = "action",
                         InvocationPoint = "invocationPoint",
                         TargetName = "targetName"
                     } }
                 },
                 TargetOperations = new [] { "targetOperations" }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

protected virtual IMergeStrategy Strategy { get; }
Property Value

IMergeStrategy

Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnGuardHookPropsMixin = new CfnGuardHookPropsMixin(new CfnGuardHookMixinProps {
                 Alias = "alias",
                 ExecutionRole = "executionRole",
                 FailureMode = "failureMode",
                 HookStatus = "hookStatus",
                 LogBucket = "logBucket",
                 Options = new OptionsProperty {
                     InputParams = new S3LocationProperty {
                         Uri = "uri",
                         VersionId = "versionId"
                     }
                 },
                 RuleLocation = new S3LocationProperty {
                     Uri = "uri",
                     VersionId = "versionId"
                 },
                 StackFilters = new StackFiltersProperty {
                     FilteringCriteria = "filteringCriteria",
                     StackNames = new StackNamesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     },
                     StackRoles = new StackRolesProperty {
                         Exclude = new [] { "exclude" },
                         Include = new [] { "include" }
                     }
                 },
                 TargetFilters = new TargetFiltersProperty {
                     Actions = new [] { "actions" },
                     InvocationPoints = new [] { "invocationPoints" },
                     TargetNames = new [] { "targetNames" },
                     Targets = new [] { new HookTargetProperty {
                         Action = "action",
                         InvocationPoint = "invocationPoint",
                         TargetName = "targetName"
                     } }
                 },
                 TargetOperations = new [] { "targetOperations" }
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)
Parameters
construct IConstruct
Overrides
Mixin.ApplyTo(IConstruct)
Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)
Parameters
construct IConstruct
Returns

bool

Overrides
Mixin.Supports(IConstruct)
Remarks

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

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

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

CloudformationResource: AWS::CloudFormation::GuardHook

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin
Back to top Generated by DocFX