Skip to content

Commit

Permalink
docs(codebuild): clarify BuildEnvironmentVariable value property (#…
Browse files Browse the repository at this point in the history
…12539)

Relates to #12478


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
blimmer authored Jan 15, 2021
1 parent 4ba0644 commit ea67c54
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/@aws-cdk/aws-codebuild/lib/project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1778,8 +1778,10 @@ export interface BuildEnvironmentVariable {
readonly type?: BuildEnvironmentVariableType;

/**
* The value of the environment variable (or the name of the parameter in
* the SSM parameter store.)
* The value of the environment variable.
* For plain-text variables (the default), this is the literal value of variable.
* For SSM parameter variables, pass the name of the parameter here (`parameterName` property of `IParameter`).
* For SecretsManager variables secrets, pass the secret name here (`secretName` property of `ISecret`).
*/
readonly value: any;
}
Expand Down

0 comments on commit ea67c54

Please sign in to comment.