Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

AWS.HookDefinition.Bash

PDF
RSS
Focus mode
AWS.HookDefinition.Bash - AWS Telco Network Builder
SyntaxPropertiesExample

Defines an AWS HookDefinition in bash.

Syntax

tosca.nodes.AWS.HookDefinition.Bash:
  properties:
    implementation: String
    environment_variables: List
    execution_role: String

Properties

implementation

The relative path to the hook definition. The format must be: ./hooks/script_name.sh

Required: Yes

Type: String

environment_variables

The environment variables for the hook bash script. Use the following format: envName=envValue with the following regex: ^[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+=[a-zA-Z0-9]+[a-zA-Z0-9\-\_]*[a-zA-Z0-9]+$

Ensure that the envName=envValue value meets the following criteria:

  • Do not use spaces.

  • Start envName with a letter (A-Z or a-z) or number (0-9).

  • Do not start the environment variable name with the following AWS TNB reserved keywords (case insensitive):

    • CODEBUILD

    • TNB

    • HOME

    • AWS

  • You can use any number of letters (A-Z or a-z), numbers (0-9), and special characters - and _ for envName and envValue.

Example: A123-45xYz=Example_789

Required: No

Type: List

execution_role

The role for hook execution.

Required: Yes

Type: String

Example

SampleHookScript:
  type: tosca.nodes.AWS.HookDefinition.Bash
  properties:
    implementation: "./hooks/myhook.sh"
    environment_variables:
      - "variable01=value01"
      - "variable02=value02"
    execution_role: "arn:aws:iam::${AWS::TNB::AccountId}:role/SampleHookPermission"

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.