Class CfnCustomResource
A CloudFormation AWS::CloudFormation::CustomResource
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.AWS.CloudFormation.dll
Syntax (csharp)
public class CfnCustomResource : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCustomResource
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
In a CloudFormation template, you use the AWS::CloudFormation::CustomResource
or Custom:: String
resource type to specify custom resources.
Custom resources provide a way for you to write custom provisioning logic in CloudFormation template and have CloudFormation run it during a stack operation, such as when you create, update or delete a stack. For more information, see Custom resources .
If you use the VPC endpoints feature, custom resources in the VPC must have access to CloudFormation -specific Amazon Simple Storage Service ( 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 Setting up VPC endpoints for AWS CloudFormation .
CloudformationResource: AWS::CloudFormation::CustomResource
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html
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.AWS.CloudFormation;
var cfnCustomResource = new CfnCustomResource(this, "MyCfnCustomResource", new CfnCustomResourceProps {
ServiceToken = "serviceToken"
});
Synopsis
Constructors
CfnCustomResource(Construct, String, ICfnCustomResourceProps) | Create a new |
CfnCustomResource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCustomResource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ServiceToken | Only one property is defined by AWS for a custom resource: |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnCustomResourceProps
- resource properties.
CfnCustomResource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCustomResource(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCustomResource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCustomResource(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ServiceToken
Only one property is defined by AWS for a custom resource:
ServiceToken
.
public virtual string ServiceToken { get; set; }
Property Value
System.String
Remarks
All other properties are defined by the service provider.
The service token that was given to the template developer by the service provider to access the service, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region in which you are creating the stack.
Updates aren't supported.
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>