Class CfnResource
Represents a CloudFormation resource.
Inheritance
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class CfnResource : CfnRefElement, IConstruct, IDependableSyntax (vb)
Public Class CfnResource
Inherits CfnRefElement
Implements IConstruct, IDependableRemarks
Stability: Stable
Synopsis
Constructors
| CfnResource(Construct, String, ICfnResourceProps) | Creates a resource construct. |
| CfnResource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnResource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| CfnOptions | Options for this resource, such as condition, update policy etc. |
| CfnProperties | |
| CfnResourceType | AWS resource type. |
| UpdatedProperites | Return properties modified after initiation. |
Methods
| AddDeletionOverride(String) | Syntactic sugar for |
| AddDependsOn(CfnResource) | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| AddOverride(String, Object) | Adds an override to the synthesized CloudFormation resource. |
| AddPropertyDeletionOverride(String) | Adds an override that deletes the value of a property from the resource definition. |
| AddPropertyOverride(String, Object) | Adds an override to a resource property. |
| ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions) | Sets the deletion policy of the resource based on the removal policy specified. |
| GetAtt(String) | Returns a token for an runtime attribute of this resource. |
| IsCfnResource(IConstruct) | Check whether the given construct is a CfnResource. |
| RenderProperties(IDictionary<String, Object>) | |
| ToString() | Returns a string representation of this construct. |
| ValidateProperties(Object) |
Constructors
CfnResource(Construct, String, ICfnResourceProps)
Creates a resource construct.
public CfnResource(Construct scope, string id, ICfnResourceProps props)Parameters
- scope Construct
- id System.String
- props ICfnResourceProps
Remarks
Stability: Stable
CfnResource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnResource(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnResource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnResource(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CfnOptions
Options for this resource, such as condition, update policy etc.
public virtual ICfnResourceOptions CfnOptions { get; }Property Value
Remarks
Stability: Stable
CfnProperties
protected virtual IDictionary<string, object> CfnProperties { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Stability: Stable
CfnResourceType
AWS resource type.
public virtual string CfnResourceType { get; }Property Value
System.String
Remarks
Stability: Stable
UpdatedProperites
Return properties modified after initiation.
protected virtual IDictionary<string, object> UpdatedProperites { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Stability: Stable
Methods
AddDeletionOverride(String)
Syntactic sugar for addOverride(path, undefined).
public virtual void AddDeletionOverride(string path)Parameters
- path System.String
The path of the value to delete.
Remarks
Stability: Stable
AddDependsOn(CfnResource)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
public virtual void AddDependsOn(CfnResource target)Parameters
- target CfnResource
Remarks
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
Stability: Stable
AddOverride(String, Object)
Adds an override to the synthesized CloudFormation resource.
public virtual void AddOverride(string path, object value)Parameters
- path System.String
- The path of the property, you can use dot notation to override values in complex types.
- value System.Object
- The value.
Remarks
To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
For example,
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
AddOverride("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", new [] { "myattribute" });
AddOverride("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE");would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}Stability: Stable
AddPropertyDeletionOverride(String)
Adds an override that deletes the value of a property from the resource definition.
public virtual void AddPropertyDeletionOverride(string propertyPath)Parameters
- propertyPath System.String
The path to the property.
Remarks
Stability: Stable
AddPropertyOverride(String, Object)
Adds an override to a resource property.
public virtual void AddPropertyOverride(string propertyPath, object value)Parameters
- propertyPath System.String
The path of the property.
- value System.Object
The value.
Remarks
Syntactic sugar for addOverride("Properties.<...>", value).
Stability: Stable
ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
Sets the deletion policy of the resource based on the removal policy specified.
public virtual void ApplyRemovalPolicy(Nullable<RemovalPolicy> policy = null, IRemovalPolicyOptions options = null)Parameters
- policy System.Nullable<RemovalPolicy>
- options IRemovalPolicyOptions
Remarks
Stability: Stable
GetAtt(String)
Returns a token for an runtime attribute of this resource.
public virtual Reference GetAtt(string attributeName)Parameters
- attributeName System.String
The name of the attribute.
Returns
Remarks
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
Stability: Stable
IsCfnResource(IConstruct)
Check whether the given construct is a CfnResource.
public static bool IsCfnResource(IConstruct construct)Parameters
- construct IConstruct
Returns
System.Boolean
Remarks
Stability: Stable
RenderProperties(IDictionary<String, Object>)
protected virtual 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>
Remarks
Stability: Stable
ToString()
Returns a string representation of this construct.
public override string ToString()Returns
System.String
a string representation of this resource
Overrides
Remarks
Stability: Stable
ValidateProperties(Object)
protected virtual void ValidateProperties(object properties)Parameters
- properties System.Object
Remarks
Stability: Stable