class Variable
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodePipeline.Variable |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#Variable |
![]() | software.amazon.awscdk.services.codepipeline.Variable |
![]() | aws_cdk.aws_codepipeline.Variable |
![]() | aws-cdk-lib » aws_codepipeline » Variable |
Pipeline-Level variable.
Example
declare const sourceAction: codepipeline_actions.S3SourceAction;
declare const sourceOutput: codepipeline.Artifact;
declare const deployBucket: s3.Bucket;
// Pipeline-level variable
const variable = new codepipeline.Variable({
variableName: 'bucket-var',
description: 'description',
defaultValue: 'sample',
});
new codepipeline.Pipeline(this, 'Pipeline', {
pipelineType: codepipeline.PipelineType.V2,
variables: [variable],
stages: [
{
stageName: 'Source',
actions: [sourceAction],
},
{
stageName: 'Deploy',
actions: [
new codepipeline_actions.S3DeployAction({
actionName: 'DeployAction',
// can reference the variables
objectKey: `${variable.reference()}.txt`,
input: sourceOutput,
bucket: deployBucket,
}),
],
},
],
});
Initializer
new Variable(props: VariableProps)
Parameters
- props
Variable
Props
Properties
Name | Type | Description |
---|---|---|
variable | string | The name of a pipeline-level variable. |
variableName
Type:
string
The name of a pipeline-level variable.
Methods
Name | Description |
---|---|
reference() | Reference the variable name at Pipeline actions. |
reference()
public reference(): string
Returns
string
Reference the variable name at Pipeline actions.