Class CfnWaitCondition

The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWaitCondition

Implements

IInspectable

IWaitConditionRef

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 CfnWaitCondition : CfnResource, IInspectable, IWaitConditionRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnWaitCondition Inherits CfnResource Implements IInspectable, IWaitConditionRef, IConstruct, IDependable, IEnvironmentAware

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

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 cfnWaitCondition = new CfnWaitCondition(this, "MyCfnWaitCondition", new CfnWaitConditionProps {
                 Count = 123,
                 Handle = "handle",
                 Timeout = "timeout"
             });

Synopsis

Constructors

CfnWaitCondition(Construct, string, ICfnWaitConditionProps?)

Create a new AWS::CloudFormation::WaitCondition.

Properties

AttrData	The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.
AttrId	Returns a unique identifier for the resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.
Count	The number of success signals that CloudFormation must receive before it continues the stack creation process.
Handle	A reference to the wait condition handle used to signal this wait condition.
Timeout	The length of time (in seconds) to wait for the number of signals that the Count property specifies.
WaitConditionRef	A reference to a WaitCondition resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWaitCondition(object)	Checks whether the given object is a CfnWaitCondition.
RenderProperties(IDictionary<string, object>)	The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

Constructors

CfnWaitCondition(Construct, string, ICfnWaitConditionProps?)

Create a new AWS::CloudFormation::WaitCondition.

public CfnWaitCondition(Construct scope, string id, ICfnWaitConditionProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnWaitConditionProps

Resource properties.

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

Properties

AttrData

The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

public virtual IResolvable AttrData { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Data

AttrId

Returns a unique identifier for the resource.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

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

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

Count

The number of success signals that CloudFormation must receive before it continues the stack creation process.

public virtual double? Count { get; set; }

Property Value

double?

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

Handle

A reference to the wait condition handle used to signal this wait condition.

public virtual string? Handle { get; set; }

Property Value

string

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

Timeout

The length of time (in seconds) to wait for the number of signals that the Count property specifies.

public virtual string? Timeout { get; set; }

Property Value

string

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

WaitConditionRef

A reference to a WaitCondition resource.

public virtual IWaitConditionReference WaitConditionRef { get; }

Property Value

IWaitConditionReference

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

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

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

IsCfnWaitCondition(object)

Checks whether the given object is a CfnWaitCondition.

public static bool IsCfnWaitCondition(object x)

Parameters

x object

Returns

bool

Remarks

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::WaitCondition resource provides a way to coordinate stack resource creation with configuration actions that are external to the stack creation or to track the status of a configuration process.

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

In these situations, we recommend that you associate a CreationPolicy attribute with the wait condition instead of using a wait condition handle. For more information and an example, see CreationPolicy attribute in the CloudFormation User Guide . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.

If you use AWS PrivateLink , resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon S3 buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/vpc-interface-endpoints.html">Access CloudFormation using an interface endpoint ( AWS PrivateLink )</a> in the <em>CloudFormation User Guide</em> . > For Amazon EC2 and Auto Scaling resources, we recommend that you use a <code>CreationPolicy</code> attribute instead of wait conditions. Add a <code>CreationPolicy</code> attribute to those resources, and use the <code>cfn-signal</code> helper script to signal when an instance creation process has completed successfully.

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

CloudformationResource: AWS::CloudFormation::WaitCondition

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWaitConditionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware