Skip to content

Commit 753bf4e

Browse files
author
awstools
committed
feat(client-codepipeline): Add support for Secrets Manager and Plaintext environment variable types in Commands action
1 parent dc4edaa commit 753bf4e

File tree

7 files changed

+105
-45
lines changed

7 files changed

+105
-45
lines changed

‎clients/client-codepipeline/src/commands/CreatePipelineCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
112112
* { // EnvironmentVariable
113113
* name: "STRING_VALUE", // required
114114
* value: "STRING_VALUE", // required
115+
* type: "PLAINTEXT" || "SECRETS_MANAGER",
115116
* },
116117
* ],
117118
* },
@@ -368,6 +369,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met
368369
* // { // EnvironmentVariable
369370
* // name: "STRING_VALUE", // required
370371
* // value: "STRING_VALUE", // required
372+
* // type: "PLAINTEXT" || "SECRETS_MANAGER",
371373
* // },
372374
* // ],
373375
* // },

‎clients/client-codepipeline/src/commands/GetPipelineCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ export interface GetPipelineCommandOutput extends GetPipelineOutput, __MetadataB
114114
* // { // EnvironmentVariable
115115
* // name: "STRING_VALUE", // required
116116
* // value: "STRING_VALUE", // required
117+
* // type: "PLAINTEXT" || "SECRETS_MANAGER",
117118
* // },
118119
* // ],
119120
* // },

‎clients/client-codepipeline/src/commands/ListRuleTypesCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface ListRuleTypesCommandOutput extends ListRuleTypesOutput, __Metad
2929

3030
/**
3131
* <p>Lists the rules for the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
32-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
32+
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
33+
* stage conditions work?</a>.For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

‎clients/client-codepipeline/src/commands/OverrideStageConditionCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface OverrideStageConditionCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Used to override a stage condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
32-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
32+
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
33+
* stage conditions work?</a>.</p>
3334
* @example
3435
* Use a bare-bones client and the command you need to make an API call.
3536
* ```javascript

‎clients/client-codepipeline/src/commands/UpdatePipelineCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
109109
* { // EnvironmentVariable
110110
* name: "STRING_VALUE", // required
111111
* value: "STRING_VALUE", // required
112+
* type: "PLAINTEXT" || "SECRETS_MANAGER",
112113
* },
113114
* ],
114115
* },
@@ -359,6 +360,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met
359360
* // { // EnvironmentVariable
360361
* // name: "STRING_VALUE", // required
361362
* // value: "STRING_VALUE", // required
363+
* // type: "PLAINTEXT" || "SECRETS_MANAGER",
362364
* // },
363365
* // ],
364366
* // },

‎clients/client-codepipeline/src/models/models_0.ts

Lines changed: 61 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,20 @@ export interface ActionTypeId {
375375
version: string | undefined;
376376
}
377377

378+
/**
379+
* @public
380+
* @enum
381+
*/
382+
export const EnvironmentVariableType = {
383+
PLAINTEXT: "PLAINTEXT",
384+
SECRETS_MANAGER: "SECRETS_MANAGER",
385+
} as const;
386+
387+
/**
388+
* @public
389+
*/
390+
export type EnvironmentVariableType = (typeof EnvironmentVariableType)[keyof typeof EnvironmentVariableType];
391+
378392
/**
379393
* <p>The environment variables for the action.</p>
380394
* @public
@@ -391,6 +405,14 @@ export interface EnvironmentVariable {
391405
* @public
392406
*/
393407
value: string | undefined;
408+
409+
/**
410+
* <p>Specifies the type of use for the environment variable value. The value can be either
411+
* <code>PLAINTEXT</code> or <code>SECRETS_MANAGER</code>. If the value is <code>SECRETS_MANAGER</code>, provide the Secrets
412+
* reference in the EnvironmentVariable value.</p>
413+
* @public
414+
*/
415+
type?: EnvironmentVariableType | undefined;
394416
}
395417

396418
/**
@@ -1854,10 +1876,8 @@ export type RuleOwner = (typeof RuleOwner)[keyof typeof RuleOwner];
18541876

18551877
/**
18561878
* <p>The ID for the rule type, which is made up of the combined values for category, owner,
1857-
* provider, and version. For more
1858-
* information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
1859-
* For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1860-
* reference</a>.</p>
1879+
* provider, and version. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1880+
* conditions</a>. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
18611881
* @public
18621882
*/
18631883
export interface RuleTypeId {
@@ -1876,7 +1896,8 @@ export interface RuleTypeId {
18761896
owner?: RuleOwner | undefined;
18771897

18781898
/**
1879-
* <p>The rule provider, such as the <code>DeploymentWindow</code> rule. For a list of rule provider names, see the rules listed in the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1899+
* <p>The rule provider, such as the <code>DeploymentWindow</code> rule. For a list of rule
1900+
* provider names, see the rules listed in the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
18801901
* reference</a>.</p>
18811902
* @public
18821903
*/
@@ -1892,10 +1913,10 @@ export interface RuleTypeId {
18921913
/**
18931914
* <p>Represents information about the rule to be created for an associated condition. An
18941915
* example would be creating a new rule for an entry condition, such as a rule that checks
1895-
* for a test result before allowing the run to enter the deployment stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1896-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.
1897-
* For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1898-
* reference</a>.</p>
1916+
* for a test result before allowing the run to enter the deployment stage. For more
1917+
* information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
1918+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
1919+
* stage conditions work?</a>. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
18991920
* @public
19001921
*/
19011922
export interface RuleDeclaration {
@@ -1958,10 +1979,9 @@ export interface RuleDeclaration {
19581979

19591980
/**
19601981
* <p>The condition for the stage. A condition is made up of the rules and the result for
1961-
* the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1962-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>..
1963-
* For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1964-
* reference</a>.</p>
1982+
* the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
1983+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
1984+
* stage conditions work?</a>.. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
19651985
* @public
19661986
*/
19671987
export interface Condition {
@@ -1980,8 +2000,10 @@ export interface Condition {
19802000
}
19812001

19822002
/**
1983-
* <p>The conditions for making checks for entry to a stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1984-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>. </p>
2003+
* <p>The conditions for making checks for entry to a stage. For more information about
2004+
* conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
2005+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
2006+
* stage conditions work?</a>. </p>
19852007
* @public
19862008
*/
19872009
export interface BeforeEntryConditions {
@@ -2262,8 +2284,9 @@ export interface RetryConfiguration {
22622284

22632285
/**
22642286
* <p>The configuration that specifies the result, such as rollback, to occur upon stage
2265-
* failure. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
2266-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>. </p>
2287+
* failure. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
2288+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
2289+
* stage conditions work?</a>. </p>
22672290
* @public
22682291
*/
22692292
export interface FailureConditions {
@@ -2282,16 +2305,20 @@ export interface FailureConditions {
22822305
retryConfiguration?: RetryConfiguration | undefined;
22832306

22842307
/**
2285-
* <p>The conditions that are configured as failure conditions. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
2286-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
2308+
* <p>The conditions that are configured as failure conditions. For more information about
2309+
* conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
2310+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
2311+
* stage conditions work?</a>.</p>
22872312
* @public
22882313
*/
22892314
conditions?: Condition[] | undefined;
22902315
}
22912316

22922317
/**
2293-
* <p>The conditions for making checks that, if met, succeed a stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
2294-
* conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
2318+
* <p>The conditions for making checks that, if met, succeed a stage. For more information
2319+
* about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>
2320+
* and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do
2321+
* stage conditions work?</a>.</p>
22952322
* @public
22962323
*/
22972324
export interface SuccessConditions {
@@ -3358,12 +3385,17 @@ export interface PipelineMetadata {
33583385

33593386
/**
33603387
* <p>The date and time that polling for source changes (periodic checks) was stopped for
3361-
* the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use
3362-
* event-based change detection. For example, for a pipeline with a CodeCommit
3363-
* source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To
3364-
* learn more, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html">Migrate polling
3365-
* pipelines to use event-based change detection</a> in the CodePipeline
3366-
* User Guide.</p>
3388+
* the pipeline, in timestamp format. </p>
3389+
* <important>
3390+
* <p>Pipelines that are inactive for longer than 30 days will have polling disabled for
3391+
* the pipeline. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#metadata.pollingDisabledAt">pollingDisabledAt</a> in the pipeline structure reference. For the steps to
3392+
* migrate your pipeline from polling to event-based change detection, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html">Migrate polling
3393+
* pipelines to use event-based change detection</a>.</p>
3394+
* </important>
3395+
* <p>You can migrate (update) a polling pipeline to use event-based change detection. For
3396+
* example, for a pipeline with a CodeCommit source, we recommend you migrate
3397+
* (update) your pipeline to use CloudWatch Events. To learn more, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html">Migrate polling
3398+
* pipelines to use event-based change detection</a> in the <i>CodePipeline User Guide</i>.</p>
33673399
* @public
33683400
*/
33693401
pollingDisabledAt?: Date | undefined;
@@ -4826,10 +4858,8 @@ export interface ListRuleExecutionsInput {
48264858
export interface RuleExecutionInput {
48274859
/**
48284860
* <p>The ID for the rule type, which is made up of the combined values for category, owner,
4829-
* provider, and version. For more
4830-
* information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
4831-
* For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
4832-
* reference</a>.</p>
4861+
* provider, and version. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
4862+
* conditions</a>. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
48334863
* @public
48344864
*/
48354865
ruleTypeId?: RuleTypeId | undefined;

0 commit comments

Comments
 (0)