Skip to main content
A construct which represents a resource.

​
Initializers 

import cdktn

cdktn.Resource(
  scope: Construct,
  id: str
)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstrNo description.

​
scopeRequired

  • Type: constructs.Construct

​
idRequired

  • Type: str

​
Methods

NameDescription
to_stringReturns a string representation of this construct.
withApplies one or more mixins to this construct.

​
to_string 

def to_string() -> str
Returns a string representation of this construct.

​
with 

def with(
  mixins: *IMixin
) -> IConstruct
Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

​
mixinsRequired

  • Type: *constructs.IMixin
The mixins to apply.

​
Static Functions

NameDescription
is_constructChecks if x is a construct.

​
is_construct 

import cdktn

cdktn.Resource.is_construct(
  x: typing.Any
)
Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

​
xRequired

  • Type: typing.Any
Any object.

​
Properties

NameTypeDescription
nodeconstructs.NodeThe tree node.
stackTerraformStackThe stack in which this resource is defined.

​
nodeRequired

  • Deprecated: - Please use Construct from the constructs package instead.
node: Node
  • Type: constructs.Node
The tree node.

​
stackRequired

  • Deprecated: - Please use Construct from the constructs package instead.
stack: TerraformStack
The stack in which this resource is defined.