CfnHook

class aws_cdk.CfnHook(scope, id, *, type, properties=None)

Bases: CfnElement

Represents a CloudFormation resource.

ExampleMetadata: infused

Example:

# cfn_template: cfn_inc.CfnInclude

# mutating the hook
# my_role: iam.Role

hook = cfn_template.get_hook("MyOutput")
code_deploy_hook = hook
code_deploy_hook.service_role = my_role.role_arn

Creates a new Hook object.

Parameters

scope (Construct) –
id (str) –
type (str) – The type of the hook (for example, “AWS::CodeDeploy::BlueGreen”).
properties (Optional[Mapping[str, Any]]) – The properties of the hook. Default: - no properties

Methods

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters: new_logical_id (str) – The new logical ID to use for this stack element.
Return type: None

to_string()

Returns a string representation of this construct.

Return type: str

Attributes

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

type: The type of the hook (for example, “AWS::CodeDeploy::BlueGreen”).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_construct(x)

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.

Parameters: x (Any) – Any object.
Return type: bool
Returns: true if x is an object created from a class which extends Construct.