Class Resource

A construct which represents an AWS resource.

Inheritance

System.Object

Construct

Resource

DnsValidatedCertificate

LambdaDeploymentGroup

ServerApplication

ServerDeploymentConfig

ServerDeploymentGroup

SubnetNetworkAclAssociation

CrossAccountDestination

ClusterParameterGroup

SecretTargetAttachment

Implements

IResource

IConstruct

IDependable

Inherited Members

Construct.IsConstruct(Object)

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.ToString()

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public abstract class Resource : Construct, IResource, IConstruct, IDependable

Syntax (vb)

Public MustInherit Class Resource
    Inherits Construct
    Implements IResource, IConstruct, IDependable

Remarks

stability: Stable

Synopsis

Constructors

Resource(Construct, String, IResourceProps)
Resource(ByRefValue)
Resource(DeputyBase.DeputyProps)

Properties

PhysicalName	Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
Stack	The stack in which this resource is defined.

Methods

GeneratePhysicalName()
GetResourceArnAttribute(String, IArnComponents)	Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
GetResourceNameAttribute(String)	Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).

Constructors

Resource(Construct, String, IResourceProps)

protected Resource(Construct scope, string id, IResourceProps props = null)

Parameters

scope Construct
id System.String
props IResourceProps

Remarks

stability: Stable

Resource(ByRefValue)

protected Resource(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

Resource(DeputyBase.DeputyProps)

protected Resource(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

Properties

PhysicalName

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

protected virtual string PhysicalName { get; }

Property Value

System.String

Remarks

This value will resolve to one of the following:

a concrete value (e.g. "my-awesome-bucket")
undefined, when a name should be generated by CloudFormation
a concrete name generated automatically during synthesis, in cross-environment scenarios. stability: Experimental

Stack

The stack in which this resource is defined.

public virtual Stack Stack { get; }

Property Value

Stack

Remarks

stability: Stable

Methods

GeneratePhysicalName()

protected virtual string GeneratePhysicalName()

Returns

System.String

Remarks

stability: Stable

GetResourceArnAttribute(String, IArnComponents)

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

protected virtual string GetResourceArnAttribute(string arnAttr, IArnComponents arnComponents)

Parameters

arnAttr System.String: The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.
arnComponents IArnComponents: The format of the ARN of this resource.

Returns

System.String

Remarks

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents. stability: Experimental

GetResourceNameAttribute(String)

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

protected virtual string GetResourceNameAttribute(string nameAttr)

Parameters

nameAttr System.String: The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

Returns

System.String

Remarks

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name. stability: Experimental

Implements

IResource

IConstruct

IDependable