Class CfnCustomResource

The AWS::CloudFormation::CustomResource resource creates a custom resource.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCustomResource

Implements

IInspectable

ICustomResourceRef

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 CfnCustomResource : CfnResource, IInspectable, ICustomResourceRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnCustomResource Inherits CfnResource Implements IInspectable, ICustomResourceRef, IConstruct, IDependable, IEnvironmentAware

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

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 cfnCustomResource = new CfnCustomResource(this, "MyCfnCustomResource", new CfnCustomResourceProps {
                 ServiceToken = "serviceToken",

                 // the properties below are optional
                 ServiceTimeout = 123
             });

Synopsis

Constructors

CfnCustomResource(Construct, string, ICfnCustomResourceProps)

Create a new AWS::CloudFormation::CustomResource.

Properties

AttrId	The AWS::CloudFormation::CustomResource resource creates a custom resource.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::CloudFormation::CustomResource resource creates a custom resource.
CustomResourceRef	A reference to a CustomResource resource.
ServiceTimeout	The maximum time, in seconds, that can elapse before a custom resource operation times out.
ServiceToken	The service token, such as an Amazon topic ARN or Lambda function ARN.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnCustomResource(object)	Checks whether the given object is a CfnCustomResource.
RenderProperties(IDictionary<string, object>)	The AWS::CloudFormation::CustomResource resource creates a custom resource.

Constructors

CfnCustomResource(Construct, string, ICfnCustomResourceProps)

Create a new AWS::CloudFormation::CustomResource.

public CfnCustomResource(Construct scope, string id, ICfnCustomResourceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnCustomResourceProps

Resource properties.

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

Properties

AttrId

The AWS::CloudFormation::CustomResource resource creates a custom 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

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::CustomResource resource creates a custom resource.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

CustomResourceRef

A reference to a CustomResource resource.

public virtual ICustomResourceReference CustomResourceRef { get; }

Property Value

ICustomResourceReference

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

ServiceTimeout

The maximum time, in seconds, that can elapse before a custom resource operation times out.

public virtual double? ServiceTimeout { get; set; }

Property Value

double?

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

ServiceToken

The service token, such as an Amazon topic ARN or Lambda function ARN.

public virtual string ServiceToken { get; set; }

Property Value

string

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

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

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

IsCfnCustomResource(object)

Checks whether the given object is a CfnCustomResource.

public static bool IsCfnCustomResource(object x)

Parameters

x object

Returns

bool

Remarks

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::CustomResource resource creates a custom resource.

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

Custom resources provide a way for you to write custom provisioning logic into your CloudFormation templates and have CloudFormation run it anytime you create, update (if you changed the custom resource), or delete a stack.

For more information, see Create custom provisioning logic with custom resources in the CloudFormation User Guide .

If you use AWS PrivateLink , custom resources in the VPC must have access to CloudFormation -specific Amazon S3 buckets. Custom resources must send 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> .

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

CloudformationResource: AWS::CloudFormation::CustomResource

ExampleMetadata: fixture=_generated

Implements

IInspectable

ICustomResourceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware