Class CfnResourceSignal

When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.

Inheritance

object

CfnResourceSignal

Implements

ICfnResourceSignal

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnResourceSignal : ICfnResourceSignal

Syntax (vb)

Public Class CfnResourceSignal Implements ICfnResourceSignal

Remarks

ExampleMetadata: infused

Examples

CfnResource resource;


            resource.CfnOptions.CreationPolicy = new CfnCreationPolicy {
                ResourceSignal = new CfnResourceSignal {
                    Count = 3,
                    Timeout = "PR15M"
                }
            };

Synopsis

Constructors

CfnResourceSignal()

When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.

Properties

Count	The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE.
Timeout	The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property.

Constructors

CfnResourceSignal()

When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.

public CfnResourceSignal()

Remarks

ExampleMetadata: infused

Examples

CfnResource resource;


            resource.CfnOptions.CreationPolicy = new CfnCreationPolicy {
                ResourceSignal = new CfnResourceSignal {
                    Count = 3,
                    Timeout = "PR15M"
                }
            };

Properties

Count

The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE.

public double? Count { get; set; }

Property Value

double?

Remarks

If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period expires, the resource creation fails and AWS CloudFormation rolls the stack back.

Timeout

The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property.

public string? Timeout { get; set; }

Property Value

string

Remarks

The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner than the time you specify but can occur shortly thereafter. The maximum time that you can specify is 12 hours.

Implements

ICfnResourceSignal