interface VariableDeclarationProperty

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.CfnPipeline.VariableDeclarationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnPipeline_VariableDeclarationProperty
Java	software.amazon.awscdk.services.codepipeline.CfnPipeline.VariableDeclarationProperty
Python	aws_cdk.aws_codepipeline.CfnPipeline.VariableDeclarationProperty
TypeScript	aws-cdk-lib » aws_codepipeline » CfnPipeline » VariableDeclarationProperty

A variable declared at the pipeline level.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';
const variableDeclarationProperty: codepipeline.CfnPipeline.VariableDeclarationProperty = {
  name: 'name',

  // the properties below are optional
  defaultValue: 'defaultValue',
  description: 'description',
};

Properties

Name	Type	Description
name	string	The name of a pipeline-level variable.
defaultValue?	string	The value of a pipeline-level variable.
description?	string	The description of a pipeline-level variable.

---

name

Type: string

The name of a pipeline-level variable.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-name

---

defaultValue?

Type: string (optional)

The value of a pipeline-level variable.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-defaultvalue

---

description?

Type: string (optional)

The description of a pipeline-level variable.

It's used to add additional context about the variable, and not being used at time when pipeline executes.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-variabledeclaration.html#cfn-codepipeline-pipeline-variabledeclaration-description