@aws-sdk/client-proton 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +802 -0
- package/package.json +5 -5
|
@@ -5,6 +5,7 @@ import { ProtonServiceException as __BaseException } from "./ProtonServiceExcept
|
|
|
5
5
|
*/
|
|
6
6
|
export interface AcceptEnvironmentAccountConnectionInput {
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
8
9
|
* <p>The ID of the environment account connection.</p>
|
|
9
10
|
*/
|
|
10
11
|
id: string | undefined;
|
|
@@ -28,42 +29,52 @@ export type EnvironmentAccountConnectionStatus = (typeof EnvironmentAccountConne
|
|
|
28
29
|
*/
|
|
29
30
|
export interface EnvironmentAccountConnection {
|
|
30
31
|
/**
|
|
32
|
+
* @public
|
|
31
33
|
* <p>The ID of the environment account connection.</p>
|
|
32
34
|
*/
|
|
33
35
|
id: string | undefined;
|
|
34
36
|
/**
|
|
37
|
+
* @public
|
|
35
38
|
* <p>The Amazon Resource Name (ARN) of the environment account connection.</p>
|
|
36
39
|
*/
|
|
37
40
|
arn: string | undefined;
|
|
38
41
|
/**
|
|
42
|
+
* @public
|
|
39
43
|
* <p>The ID of the management account that's connected to the environment account connection.</p>
|
|
40
44
|
*/
|
|
41
45
|
managementAccountId: string | undefined;
|
|
42
46
|
/**
|
|
47
|
+
* @public
|
|
43
48
|
* <p>The environment account that's connected to the environment account connection.</p>
|
|
44
49
|
*/
|
|
45
50
|
environmentAccountId: string | undefined;
|
|
46
51
|
/**
|
|
52
|
+
* @public
|
|
47
53
|
* <p>The IAM service role that's associated with the environment account connection.</p>
|
|
48
54
|
*/
|
|
49
55
|
roleArn: string | undefined;
|
|
50
56
|
/**
|
|
57
|
+
* @public
|
|
51
58
|
* <p>The name of the environment that's associated with the environment account connection.</p>
|
|
52
59
|
*/
|
|
53
60
|
environmentName: string | undefined;
|
|
54
61
|
/**
|
|
62
|
+
* @public
|
|
55
63
|
* <p>The time when the environment account connection request was made.</p>
|
|
56
64
|
*/
|
|
57
65
|
requestedAt: Date | undefined;
|
|
58
66
|
/**
|
|
67
|
+
* @public
|
|
59
68
|
* <p>The time when the environment account connection was last modified.</p>
|
|
60
69
|
*/
|
|
61
70
|
lastModifiedAt: Date | undefined;
|
|
62
71
|
/**
|
|
72
|
+
* @public
|
|
63
73
|
* <p>The status of the environment account connection.</p>
|
|
64
74
|
*/
|
|
65
75
|
status: EnvironmentAccountConnectionStatus | string | undefined;
|
|
66
76
|
/**
|
|
77
|
+
* @public
|
|
67
78
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
68
79
|
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
69
80
|
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
@@ -74,6 +85,7 @@ export interface EnvironmentAccountConnection {
|
|
|
74
85
|
*/
|
|
75
86
|
componentRoleArn?: string;
|
|
76
87
|
/**
|
|
88
|
+
* @public
|
|
77
89
|
* <p>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources
|
|
78
90
|
* using CodeBuild-based provisioning in the associated environment account.</p>
|
|
79
91
|
*/
|
|
@@ -84,6 +96,7 @@ export interface EnvironmentAccountConnection {
|
|
|
84
96
|
*/
|
|
85
97
|
export interface AcceptEnvironmentAccountConnectionOutput {
|
|
86
98
|
/**
|
|
99
|
+
* @public
|
|
87
100
|
* <p>The environment account connection data that's returned by Proton.</p>
|
|
88
101
|
*/
|
|
89
102
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
@@ -183,18 +196,22 @@ export type RepositoryProvider = (typeof RepositoryProvider)[keyof typeof Reposi
|
|
|
183
196
|
*/
|
|
184
197
|
export interface RepositoryBranch {
|
|
185
198
|
/**
|
|
199
|
+
* @public
|
|
186
200
|
* <p>The Amazon Resource Name (ARN) of the linked repository.</p>
|
|
187
201
|
*/
|
|
188
202
|
arn: string | undefined;
|
|
189
203
|
/**
|
|
204
|
+
* @public
|
|
190
205
|
* <p>The repository provider.</p>
|
|
191
206
|
*/
|
|
192
207
|
provider: RepositoryProvider | string | undefined;
|
|
193
208
|
/**
|
|
209
|
+
* @public
|
|
194
210
|
* <p>The repository name.</p>
|
|
195
211
|
*/
|
|
196
212
|
name: string | undefined;
|
|
197
213
|
/**
|
|
214
|
+
* @public
|
|
198
215
|
* <p>The repository branch.</p>
|
|
199
216
|
*/
|
|
200
217
|
branch: string | undefined;
|
|
@@ -205,16 +222,19 @@ export interface RepositoryBranch {
|
|
|
205
222
|
*/
|
|
206
223
|
export interface AccountSettings {
|
|
207
224
|
/**
|
|
225
|
+
* @public
|
|
208
226
|
* <p>The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by
|
|
209
227
|
* customer-owned automation for self-managed provisioning.</p>
|
|
210
228
|
*/
|
|
211
229
|
pipelineServiceRoleArn?: string;
|
|
212
230
|
/**
|
|
231
|
+
* @public
|
|
213
232
|
* <p>The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include
|
|
214
233
|
* pipelines. A linked repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
215
234
|
*/
|
|
216
235
|
pipelineProvisioningRepository?: RepositoryBranch;
|
|
217
236
|
/**
|
|
237
|
+
* @public
|
|
218
238
|
* <p>The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based
|
|
219
239
|
* provisioning.</p>
|
|
220
240
|
*/
|
|
@@ -230,6 +250,7 @@ export interface GetAccountSettingsInput {
|
|
|
230
250
|
*/
|
|
231
251
|
export interface GetAccountSettingsOutput {
|
|
232
252
|
/**
|
|
253
|
+
* @public
|
|
233
254
|
* <p>The Proton pipeline service role detail data that's returned by Proton.</p>
|
|
234
255
|
*/
|
|
235
256
|
accountSettings?: AccountSettings;
|
|
@@ -240,14 +261,17 @@ export interface GetAccountSettingsOutput {
|
|
|
240
261
|
*/
|
|
241
262
|
export interface RepositoryBranchInput {
|
|
242
263
|
/**
|
|
264
|
+
* @public
|
|
243
265
|
* <p>The repository provider.</p>
|
|
244
266
|
*/
|
|
245
267
|
provider: RepositoryProvider | string | undefined;
|
|
246
268
|
/**
|
|
269
|
+
* @public
|
|
247
270
|
* <p>The repository name.</p>
|
|
248
271
|
*/
|
|
249
272
|
name: string | undefined;
|
|
250
273
|
/**
|
|
274
|
+
* @public
|
|
251
275
|
* <p>The repository branch.</p>
|
|
252
276
|
*/
|
|
253
277
|
branch: string | undefined;
|
|
@@ -257,12 +281,14 @@ export interface RepositoryBranchInput {
|
|
|
257
281
|
*/
|
|
258
282
|
export interface UpdateAccountSettingsInput {
|
|
259
283
|
/**
|
|
284
|
+
* @public
|
|
260
285
|
* <p>The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed
|
|
261
286
|
* provisioning, and by customer-owned automation for self-managed provisioning.</p>
|
|
262
287
|
* <p>To remove a previously configured ARN, specify an empty string.</p>
|
|
263
288
|
*/
|
|
264
289
|
pipelineServiceRoleArn?: string;
|
|
265
290
|
/**
|
|
291
|
+
* @public
|
|
266
292
|
* <p>A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that
|
|
267
293
|
* include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
268
294
|
* <p>To remove a previously configured repository, set <code>deletePipelineProvisioningRepository</code> to <code>true</code>, and don't set
|
|
@@ -270,11 +296,13 @@ export interface UpdateAccountSettingsInput {
|
|
|
270
296
|
*/
|
|
271
297
|
pipelineProvisioningRepository?: RepositoryBranchInput;
|
|
272
298
|
/**
|
|
299
|
+
* @public
|
|
273
300
|
* <p>Set to <code>true</code> to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the
|
|
274
301
|
* configured pipeline repository.</p>
|
|
275
302
|
*/
|
|
276
303
|
deletePipelineProvisioningRepository?: boolean;
|
|
277
304
|
/**
|
|
305
|
+
* @public
|
|
278
306
|
* <p>The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based
|
|
279
307
|
* provisioning.</p>
|
|
280
308
|
*/
|
|
@@ -285,6 +313,7 @@ export interface UpdateAccountSettingsInput {
|
|
|
285
313
|
*/
|
|
286
314
|
export interface UpdateAccountSettingsOutput {
|
|
287
315
|
/**
|
|
316
|
+
* @public
|
|
288
317
|
* <p>The Proton pipeline service role and repository data shared across the Amazon Web Services account.</p>
|
|
289
318
|
*/
|
|
290
319
|
accountSettings: AccountSettings | undefined;
|
|
@@ -294,6 +323,7 @@ export interface UpdateAccountSettingsOutput {
|
|
|
294
323
|
*/
|
|
295
324
|
export interface CancelComponentDeploymentInput {
|
|
296
325
|
/**
|
|
326
|
+
* @public
|
|
297
327
|
* <p>The name of the component with the deployment to cancel.</p>
|
|
298
328
|
*/
|
|
299
329
|
componentName: string | undefined;
|
|
@@ -325,66 +355,82 @@ export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof Deployment
|
|
|
325
355
|
*/
|
|
326
356
|
export interface Component {
|
|
327
357
|
/**
|
|
358
|
+
* @public
|
|
328
359
|
* <p>The name of the component.</p>
|
|
329
360
|
*/
|
|
330
361
|
name: string | undefined;
|
|
331
362
|
/**
|
|
363
|
+
* @public
|
|
332
364
|
* <p>A description of the component.</p>
|
|
333
365
|
*/
|
|
334
366
|
description?: string;
|
|
335
367
|
/**
|
|
368
|
+
* @public
|
|
336
369
|
* <p>The Amazon Resource Name (ARN) of the component.</p>
|
|
337
370
|
*/
|
|
338
371
|
arn: string | undefined;
|
|
339
372
|
/**
|
|
373
|
+
* @public
|
|
340
374
|
* <p>The name of the Proton environment that this component is associated with.</p>
|
|
341
375
|
*/
|
|
342
376
|
environmentName: string | undefined;
|
|
343
377
|
/**
|
|
378
|
+
* @public
|
|
344
379
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>
|
|
345
380
|
*/
|
|
346
381
|
serviceName?: string;
|
|
347
382
|
/**
|
|
383
|
+
* @public
|
|
348
384
|
* <p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>
|
|
349
385
|
*/
|
|
350
386
|
serviceInstanceName?: string;
|
|
351
387
|
/**
|
|
388
|
+
* @public
|
|
352
389
|
* <p>The time when the component was created.</p>
|
|
353
390
|
*/
|
|
354
391
|
createdAt: Date | undefined;
|
|
355
392
|
/**
|
|
393
|
+
* @public
|
|
356
394
|
* <p>The time when the component was last modified.</p>
|
|
357
395
|
*/
|
|
358
396
|
lastModifiedAt: Date | undefined;
|
|
359
397
|
/**
|
|
398
|
+
* @public
|
|
360
399
|
* <p>The time when a deployment of the component was last attempted.</p>
|
|
361
400
|
*/
|
|
362
401
|
lastDeploymentAttemptedAt?: Date;
|
|
363
402
|
/**
|
|
403
|
+
* @public
|
|
364
404
|
* <p>The time when the component was last deployed successfully.</p>
|
|
365
405
|
*/
|
|
366
406
|
lastDeploymentSucceededAt?: Date;
|
|
367
407
|
/**
|
|
408
|
+
* @public
|
|
368
409
|
* <p>The component deployment status.</p>
|
|
369
410
|
*/
|
|
370
411
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
371
412
|
/**
|
|
413
|
+
* @public
|
|
372
414
|
* <p>The message associated with the component deployment status.</p>
|
|
373
415
|
*/
|
|
374
416
|
deploymentStatusMessage?: string;
|
|
375
417
|
/**
|
|
418
|
+
* @public
|
|
376
419
|
* <p>The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.</p>
|
|
377
420
|
*/
|
|
378
421
|
serviceSpec?: string;
|
|
379
422
|
/**
|
|
423
|
+
* @public
|
|
380
424
|
* <p>The last token the client requested.</p>
|
|
381
425
|
*/
|
|
382
426
|
lastClientRequestToken?: string;
|
|
383
427
|
/**
|
|
428
|
+
* @public
|
|
384
429
|
* <p>The ID of the last attempted deployment of this component.</p>
|
|
385
430
|
*/
|
|
386
431
|
lastAttemptedDeploymentId?: string;
|
|
387
432
|
/**
|
|
433
|
+
* @public
|
|
388
434
|
* <p>The ID of the last successful deployment of this component.</p>
|
|
389
435
|
*/
|
|
390
436
|
lastSucceededDeploymentId?: string;
|
|
@@ -394,6 +440,7 @@ export interface Component {
|
|
|
394
440
|
*/
|
|
395
441
|
export interface CancelComponentDeploymentOutput {
|
|
396
442
|
/**
|
|
443
|
+
* @public
|
|
397
444
|
* <p>The detailed data of the component with the deployment that is being canceled.</p>
|
|
398
445
|
*/
|
|
399
446
|
component: Component | undefined;
|
|
@@ -403,6 +450,7 @@ export interface CancelComponentDeploymentOutput {
|
|
|
403
450
|
*/
|
|
404
451
|
export interface CancelEnvironmentDeploymentInput {
|
|
405
452
|
/**
|
|
453
|
+
* @public
|
|
406
454
|
* <p>The name of the environment with the deployment to cancel.</p>
|
|
407
455
|
*/
|
|
408
456
|
environmentName: string | undefined;
|
|
@@ -424,76 +472,94 @@ export type Provisioning = (typeof Provisioning)[keyof typeof Provisioning];
|
|
|
424
472
|
*/
|
|
425
473
|
export interface Environment {
|
|
426
474
|
/**
|
|
475
|
+
* @public
|
|
427
476
|
* <p>The name of the environment.</p>
|
|
428
477
|
*/
|
|
429
478
|
name: string | undefined;
|
|
430
479
|
/**
|
|
480
|
+
* @public
|
|
431
481
|
* <p>The description of the environment.</p>
|
|
432
482
|
*/
|
|
433
483
|
description?: string;
|
|
434
484
|
/**
|
|
485
|
+
* @public
|
|
435
486
|
* <p>The time when the environment was created.</p>
|
|
436
487
|
*/
|
|
437
488
|
createdAt: Date | undefined;
|
|
438
489
|
/**
|
|
490
|
+
* @public
|
|
439
491
|
* <p>The time when a deployment of the environment was last attempted.</p>
|
|
440
492
|
*/
|
|
441
493
|
lastDeploymentAttemptedAt: Date | undefined;
|
|
442
494
|
/**
|
|
495
|
+
* @public
|
|
443
496
|
* <p>The time when the environment was last deployed successfully.</p>
|
|
444
497
|
*/
|
|
445
498
|
lastDeploymentSucceededAt: Date | undefined;
|
|
446
499
|
/**
|
|
500
|
+
* @public
|
|
447
501
|
* <p>The Amazon Resource Name (ARN) of the environment.</p>
|
|
448
502
|
*/
|
|
449
503
|
arn: string | undefined;
|
|
450
504
|
/**
|
|
505
|
+
* @public
|
|
451
506
|
* <p>The Amazon Resource Name (ARN) of the environment template.</p>
|
|
452
507
|
*/
|
|
453
508
|
templateName: string | undefined;
|
|
454
509
|
/**
|
|
510
|
+
* @public
|
|
455
511
|
* <p>The major version of the environment template.</p>
|
|
456
512
|
*/
|
|
457
513
|
templateMajorVersion: string | undefined;
|
|
458
514
|
/**
|
|
515
|
+
* @public
|
|
459
516
|
* <p>The minor version of the environment template.</p>
|
|
460
517
|
*/
|
|
461
518
|
templateMinorVersion: string | undefined;
|
|
462
519
|
/**
|
|
520
|
+
* @public
|
|
463
521
|
* <p>The environment deployment status.</p>
|
|
464
522
|
*/
|
|
465
523
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
466
524
|
/**
|
|
525
|
+
* @public
|
|
467
526
|
* <p>An environment deployment status message.</p>
|
|
468
527
|
*/
|
|
469
528
|
deploymentStatusMessage?: string;
|
|
470
529
|
/**
|
|
530
|
+
* @public
|
|
471
531
|
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</p>
|
|
472
532
|
*/
|
|
473
533
|
protonServiceRoleArn?: string;
|
|
474
534
|
/**
|
|
535
|
+
* @public
|
|
475
536
|
* <p>The ID of the environment account connection that's used to provision infrastructure resources in an environment account.</p>
|
|
476
537
|
*/
|
|
477
538
|
environmentAccountConnectionId?: string;
|
|
478
539
|
/**
|
|
540
|
+
* @public
|
|
479
541
|
* <p>The ID of the environment account that the environment infrastructure resources are provisioned in.</p>
|
|
480
542
|
*/
|
|
481
543
|
environmentAccountId?: string;
|
|
482
544
|
/**
|
|
545
|
+
* @public
|
|
483
546
|
* <p>The environment spec.</p>
|
|
484
547
|
*/
|
|
485
548
|
spec?: string;
|
|
486
549
|
/**
|
|
550
|
+
* @public
|
|
487
551
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
488
552
|
*/
|
|
489
553
|
provisioning?: Provisioning | string;
|
|
490
554
|
/**
|
|
555
|
+
* @public
|
|
491
556
|
* <p>The linked repository that you use to host your rendered infrastructure templates for self-managed
|
|
492
557
|
* provisioning. A linked repository is a repository that has been registered with Proton. For more information, see
|
|
493
558
|
* <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html">CreateRepository</a>.</p>
|
|
494
559
|
*/
|
|
495
560
|
provisioningRepository?: RepositoryBranch;
|
|
496
561
|
/**
|
|
562
|
+
* @public
|
|
497
563
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
498
564
|
* determines the scope of infrastructure that a component can provision.</p>
|
|
499
565
|
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
@@ -503,15 +569,18 @@ export interface Environment {
|
|
|
503
569
|
*/
|
|
504
570
|
componentRoleArn?: string;
|
|
505
571
|
/**
|
|
572
|
+
* @public
|
|
506
573
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your
|
|
507
574
|
* behalf.</p>
|
|
508
575
|
*/
|
|
509
576
|
codebuildRoleArn?: string;
|
|
510
577
|
/**
|
|
578
|
+
* @public
|
|
511
579
|
* <p>The ID of the last attempted deployment of this environment.</p>
|
|
512
580
|
*/
|
|
513
581
|
lastAttemptedDeploymentId?: string;
|
|
514
582
|
/**
|
|
583
|
+
* @public
|
|
515
584
|
* <p>The ID of the last successful deployment of this environment.</p>
|
|
516
585
|
*/
|
|
517
586
|
lastSucceededDeploymentId?: string;
|
|
@@ -521,6 +590,7 @@ export interface Environment {
|
|
|
521
590
|
*/
|
|
522
591
|
export interface CancelEnvironmentDeploymentOutput {
|
|
523
592
|
/**
|
|
593
|
+
* @public
|
|
524
594
|
* <p>The environment summary data that's returned by Proton.</p>
|
|
525
595
|
*/
|
|
526
596
|
environment: Environment | undefined;
|
|
@@ -530,10 +600,12 @@ export interface CancelEnvironmentDeploymentOutput {
|
|
|
530
600
|
*/
|
|
531
601
|
export interface CancelServiceInstanceDeploymentInput {
|
|
532
602
|
/**
|
|
603
|
+
* @public
|
|
533
604
|
* <p>The name of the service instance with the deployment to cancel.</p>
|
|
534
605
|
*/
|
|
535
606
|
serviceInstanceName: string | undefined;
|
|
536
607
|
/**
|
|
608
|
+
* @public
|
|
537
609
|
* <p>The name of the service with the service instance deployment to cancel.</p>
|
|
538
610
|
*/
|
|
539
611
|
serviceName: string | undefined;
|
|
@@ -544,68 +616,84 @@ export interface CancelServiceInstanceDeploymentInput {
|
|
|
544
616
|
*/
|
|
545
617
|
export interface ServiceInstance {
|
|
546
618
|
/**
|
|
619
|
+
* @public
|
|
547
620
|
* <p>The name of the service instance.</p>
|
|
548
621
|
*/
|
|
549
622
|
name: string | undefined;
|
|
550
623
|
/**
|
|
624
|
+
* @public
|
|
551
625
|
* <p>The Amazon Resource Name (ARN) of the service instance.</p>
|
|
552
626
|
*/
|
|
553
627
|
arn: string | undefined;
|
|
554
628
|
/**
|
|
629
|
+
* @public
|
|
555
630
|
* <p>The time when the service instance was created.</p>
|
|
556
631
|
*/
|
|
557
632
|
createdAt: Date | undefined;
|
|
558
633
|
/**
|
|
634
|
+
* @public
|
|
559
635
|
* <p>The time when a deployment of the service instance was last attempted.</p>
|
|
560
636
|
*/
|
|
561
637
|
lastDeploymentAttemptedAt: Date | undefined;
|
|
562
638
|
/**
|
|
639
|
+
* @public
|
|
563
640
|
* <p>The time when the service instance was last deployed successfully.</p>
|
|
564
641
|
*/
|
|
565
642
|
lastDeploymentSucceededAt: Date | undefined;
|
|
566
643
|
/**
|
|
644
|
+
* @public
|
|
567
645
|
* <p>The name of the service that the service instance belongs to.</p>
|
|
568
646
|
*/
|
|
569
647
|
serviceName: string | undefined;
|
|
570
648
|
/**
|
|
649
|
+
* @public
|
|
571
650
|
* <p>The name of the environment that the service instance was deployed into.</p>
|
|
572
651
|
*/
|
|
573
652
|
environmentName: string | undefined;
|
|
574
653
|
/**
|
|
654
|
+
* @public
|
|
575
655
|
* <p>The name of the service template that was used to create the service instance.</p>
|
|
576
656
|
*/
|
|
577
657
|
templateName: string | undefined;
|
|
578
658
|
/**
|
|
659
|
+
* @public
|
|
579
660
|
* <p>The major version of the service template that was used to create the service
|
|
580
661
|
* instance.</p>
|
|
581
662
|
*/
|
|
582
663
|
templateMajorVersion: string | undefined;
|
|
583
664
|
/**
|
|
665
|
+
* @public
|
|
584
666
|
* <p>The minor version of the service template that was used to create the service
|
|
585
667
|
* instance.</p>
|
|
586
668
|
*/
|
|
587
669
|
templateMinorVersion: string | undefined;
|
|
588
670
|
/**
|
|
671
|
+
* @public
|
|
589
672
|
* <p>The service instance deployment status.</p>
|
|
590
673
|
*/
|
|
591
674
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
592
675
|
/**
|
|
676
|
+
* @public
|
|
593
677
|
* <p>The message associated with the service instance deployment status.</p>
|
|
594
678
|
*/
|
|
595
679
|
deploymentStatusMessage?: string;
|
|
596
680
|
/**
|
|
681
|
+
* @public
|
|
597
682
|
* <p>The service spec that was used to create the service instance.</p>
|
|
598
683
|
*/
|
|
599
684
|
spec?: string;
|
|
600
685
|
/**
|
|
686
|
+
* @public
|
|
601
687
|
* <p>The last client request token received.</p>
|
|
602
688
|
*/
|
|
603
689
|
lastClientRequestToken?: string;
|
|
604
690
|
/**
|
|
691
|
+
* @public
|
|
605
692
|
* <p>The ID of the last attempted deployment of this service instance.</p>
|
|
606
693
|
*/
|
|
607
694
|
lastAttemptedDeploymentId?: string;
|
|
608
695
|
/**
|
|
696
|
+
* @public
|
|
609
697
|
* <p>The ID of the last successful deployment of this service instance.</p>
|
|
610
698
|
*/
|
|
611
699
|
lastSucceededDeploymentId?: string;
|
|
@@ -615,6 +703,7 @@ export interface ServiceInstance {
|
|
|
615
703
|
*/
|
|
616
704
|
export interface CancelServiceInstanceDeploymentOutput {
|
|
617
705
|
/**
|
|
706
|
+
* @public
|
|
618
707
|
* <p>The service instance summary data that's returned by Proton.</p>
|
|
619
708
|
*/
|
|
620
709
|
serviceInstance: ServiceInstance | undefined;
|
|
@@ -624,6 +713,7 @@ export interface CancelServiceInstanceDeploymentOutput {
|
|
|
624
713
|
*/
|
|
625
714
|
export interface CancelServicePipelineDeploymentInput {
|
|
626
715
|
/**
|
|
716
|
+
* @public
|
|
627
717
|
* <p>The name of the service with the service pipeline deployment to cancel.</p>
|
|
628
718
|
*/
|
|
629
719
|
serviceName: string | undefined;
|
|
@@ -634,52 +724,64 @@ export interface CancelServicePipelineDeploymentInput {
|
|
|
634
724
|
*/
|
|
635
725
|
export interface ServicePipeline {
|
|
636
726
|
/**
|
|
727
|
+
* @public
|
|
637
728
|
* <p>The Amazon Resource Name (ARN) of the service pipeline.</p>
|
|
638
729
|
*/
|
|
639
730
|
arn: string | undefined;
|
|
640
731
|
/**
|
|
732
|
+
* @public
|
|
641
733
|
* <p>The time when the service pipeline was created.</p>
|
|
642
734
|
*/
|
|
643
735
|
createdAt: Date | undefined;
|
|
644
736
|
/**
|
|
737
|
+
* @public
|
|
645
738
|
* <p>The time when a deployment of the service pipeline was last attempted.</p>
|
|
646
739
|
*/
|
|
647
740
|
lastDeploymentAttemptedAt: Date | undefined;
|
|
648
741
|
/**
|
|
742
|
+
* @public
|
|
649
743
|
* <p>The time when the service pipeline was last deployed successfully.</p>
|
|
650
744
|
*/
|
|
651
745
|
lastDeploymentSucceededAt: Date | undefined;
|
|
652
746
|
/**
|
|
747
|
+
* @public
|
|
653
748
|
* <p>The name of the service template that was used to create the service pipeline.</p>
|
|
654
749
|
*/
|
|
655
750
|
templateName: string | undefined;
|
|
656
751
|
/**
|
|
752
|
+
* @public
|
|
657
753
|
* <p>The major version of the service template that was used to create the service
|
|
658
754
|
* pipeline.</p>
|
|
659
755
|
*/
|
|
660
756
|
templateMajorVersion: string | undefined;
|
|
661
757
|
/**
|
|
758
|
+
* @public
|
|
662
759
|
* <p>The minor version of the service template that was used to create the service
|
|
663
760
|
* pipeline.</p>
|
|
664
761
|
*/
|
|
665
762
|
templateMinorVersion: string | undefined;
|
|
666
763
|
/**
|
|
764
|
+
* @public
|
|
667
765
|
* <p>The deployment status of the service pipeline.</p>
|
|
668
766
|
*/
|
|
669
767
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
670
768
|
/**
|
|
769
|
+
* @public
|
|
671
770
|
* <p>A service pipeline deployment status message.</p>
|
|
672
771
|
*/
|
|
673
772
|
deploymentStatusMessage?: string;
|
|
674
773
|
/**
|
|
774
|
+
* @public
|
|
675
775
|
* <p>The service spec that was used to create the service pipeline.</p>
|
|
676
776
|
*/
|
|
677
777
|
spec?: string;
|
|
678
778
|
/**
|
|
779
|
+
* @public
|
|
679
780
|
* <p>The ID of the last attempted deployment of this service pipeline.</p>
|
|
680
781
|
*/
|
|
681
782
|
lastAttemptedDeploymentId?: string;
|
|
682
783
|
/**
|
|
784
|
+
* @public
|
|
683
785
|
* <p>The ID of the last successful deployment of this service pipeline.</p>
|
|
684
786
|
*/
|
|
685
787
|
lastSucceededDeploymentId?: string;
|
|
@@ -689,6 +791,7 @@ export interface ServicePipeline {
|
|
|
689
791
|
*/
|
|
690
792
|
export interface CancelServicePipelineDeploymentOutput {
|
|
691
793
|
/**
|
|
794
|
+
* @public
|
|
692
795
|
* <p>The service pipeline detail data that's returned by Proton.</p>
|
|
693
796
|
*/
|
|
694
797
|
pipeline: ServicePipeline | undefined;
|
|
@@ -698,14 +801,17 @@ export interface CancelServicePipelineDeploymentOutput {
|
|
|
698
801
|
*/
|
|
699
802
|
export interface ListComponentOutputsInput {
|
|
700
803
|
/**
|
|
804
|
+
* @public
|
|
701
805
|
* <p>The name of the component whose outputs you want.</p>
|
|
702
806
|
*/
|
|
703
807
|
componentName: string | undefined;
|
|
704
808
|
/**
|
|
809
|
+
* @public
|
|
705
810
|
* <p>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>
|
|
706
811
|
*/
|
|
707
812
|
nextToken?: string;
|
|
708
813
|
/**
|
|
814
|
+
* @public
|
|
709
815
|
* <p>The ID of the deployment whose outputs you want.</p>
|
|
710
816
|
*/
|
|
711
817
|
deploymentId?: string;
|
|
@@ -716,10 +822,12 @@ export interface ListComponentOutputsInput {
|
|
|
716
822
|
*/
|
|
717
823
|
export interface Output {
|
|
718
824
|
/**
|
|
825
|
+
* @public
|
|
719
826
|
* <p>The output key.</p>
|
|
720
827
|
*/
|
|
721
828
|
key?: string;
|
|
722
829
|
/**
|
|
830
|
+
* @public
|
|
723
831
|
* <p>The output value.</p>
|
|
724
832
|
*/
|
|
725
833
|
valueString?: string;
|
|
@@ -729,10 +837,12 @@ export interface Output {
|
|
|
729
837
|
*/
|
|
730
838
|
export interface ListComponentOutputsOutput {
|
|
731
839
|
/**
|
|
840
|
+
* @public
|
|
732
841
|
* <p>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</p>
|
|
733
842
|
*/
|
|
734
843
|
nextToken?: string;
|
|
735
844
|
/**
|
|
845
|
+
* @public
|
|
736
846
|
* <p>An array of component Infrastructure as Code (IaC) outputs.</p>
|
|
737
847
|
*/
|
|
738
848
|
outputs: Output[] | undefined;
|
|
@@ -742,10 +852,12 @@ export interface ListComponentOutputsOutput {
|
|
|
742
852
|
*/
|
|
743
853
|
export interface ListComponentProvisionedResourcesInput {
|
|
744
854
|
/**
|
|
855
|
+
* @public
|
|
745
856
|
* <p>The name of the component whose provisioned resources you want.</p>
|
|
746
857
|
*/
|
|
747
858
|
componentName: string | undefined;
|
|
748
859
|
/**
|
|
860
|
+
* @public
|
|
749
861
|
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources
|
|
750
862
|
* that was previously requested.</p>
|
|
751
863
|
*/
|
|
@@ -769,14 +881,17 @@ export type ProvisionedResourceEngine = (typeof ProvisionedResourceEngine)[keyof
|
|
|
769
881
|
*/
|
|
770
882
|
export interface ProvisionedResource {
|
|
771
883
|
/**
|
|
884
|
+
* @public
|
|
772
885
|
* <p>The provisioned resource name.</p>
|
|
773
886
|
*/
|
|
774
887
|
name?: string;
|
|
775
888
|
/**
|
|
889
|
+
* @public
|
|
776
890
|
* <p>The provisioned resource identifier.</p>
|
|
777
891
|
*/
|
|
778
892
|
identifier?: string;
|
|
779
893
|
/**
|
|
894
|
+
* @public
|
|
780
895
|
* <p>The resource provisioning engine. At this time, <code>CLOUDFORMATION</code> can be used for Amazon Web Services-managed provisioning, and <code>TERRAFORM</code> can
|
|
781
896
|
* be used for self-managed provisioning.</p>
|
|
782
897
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton User Guide</i>.</p>
|
|
@@ -788,11 +903,13 @@ export interface ProvisionedResource {
|
|
|
788
903
|
*/
|
|
789
904
|
export interface ListComponentProvisionedResourcesOutput {
|
|
790
905
|
/**
|
|
906
|
+
* @public
|
|
791
907
|
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of
|
|
792
908
|
* provisioned resources.</p>
|
|
793
909
|
*/
|
|
794
910
|
nextToken?: string;
|
|
795
911
|
/**
|
|
912
|
+
* @public
|
|
796
913
|
* <p>An array of provisioned resources for a component.</p>
|
|
797
914
|
*/
|
|
798
915
|
provisionedResources: ProvisionedResource[] | undefined;
|
|
@@ -803,10 +920,12 @@ export interface ListComponentProvisionedResourcesOutput {
|
|
|
803
920
|
*/
|
|
804
921
|
export interface Tag {
|
|
805
922
|
/**
|
|
923
|
+
* @public
|
|
806
924
|
* <p>The key of the resource tag.</p>
|
|
807
925
|
*/
|
|
808
926
|
key: string | undefined;
|
|
809
927
|
/**
|
|
928
|
+
* @public
|
|
810
929
|
* <p>The value of the resource tag.</p>
|
|
811
930
|
*/
|
|
812
931
|
value: string | undefined;
|
|
@@ -816,29 +935,35 @@ export interface Tag {
|
|
|
816
935
|
*/
|
|
817
936
|
export interface CreateComponentInput {
|
|
818
937
|
/**
|
|
938
|
+
* @public
|
|
819
939
|
* <p>The customer-provided name of the component.</p>
|
|
820
940
|
*/
|
|
821
941
|
name: string | undefined;
|
|
822
942
|
/**
|
|
943
|
+
* @public
|
|
823
944
|
* <p>An optional customer-provided description of the component.</p>
|
|
824
945
|
*/
|
|
825
946
|
description?: string;
|
|
826
947
|
/**
|
|
948
|
+
* @public
|
|
827
949
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. If you don't specify this, the component isn't attached to any
|
|
828
950
|
* service instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>
|
|
829
951
|
*/
|
|
830
952
|
serviceName?: string;
|
|
831
953
|
/**
|
|
954
|
+
* @public
|
|
832
955
|
* <p>The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service
|
|
833
956
|
* instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>
|
|
834
957
|
*/
|
|
835
958
|
serviceInstanceName?: string;
|
|
836
959
|
/**
|
|
960
|
+
* @public
|
|
837
961
|
* <p>The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify
|
|
838
962
|
* <code>serviceInstanceName</code> and <code>serviceName</code>.</p>
|
|
839
963
|
*/
|
|
840
964
|
environmentName?: string;
|
|
841
965
|
/**
|
|
966
|
+
* @public
|
|
842
967
|
* <p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p>
|
|
843
968
|
* <note>
|
|
844
969
|
* <p>Components support a single IaC file, even if you use Terraform as your template language.</p>
|
|
@@ -846,22 +971,26 @@ export interface CreateComponentInput {
|
|
|
846
971
|
*/
|
|
847
972
|
templateFile: string | undefined;
|
|
848
973
|
/**
|
|
974
|
+
* @public
|
|
849
975
|
* <p>A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom
|
|
850
976
|
* component provisions.</p>
|
|
851
977
|
*/
|
|
852
978
|
manifest: string | undefined;
|
|
853
979
|
/**
|
|
980
|
+
* @public
|
|
854
981
|
* <p>The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service
|
|
855
982
|
* instance.</p>
|
|
856
983
|
*/
|
|
857
984
|
serviceSpec?: string;
|
|
858
985
|
/**
|
|
986
|
+
* @public
|
|
859
987
|
* <p>An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.</p>
|
|
860
988
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
861
989
|
* <i>Proton User Guide</i>.</p>
|
|
862
990
|
*/
|
|
863
991
|
tags?: Tag[];
|
|
864
992
|
/**
|
|
993
|
+
* @public
|
|
865
994
|
* <p>The client token for the created component.</p>
|
|
866
995
|
*/
|
|
867
996
|
clientToken?: string;
|
|
@@ -871,6 +1000,7 @@ export interface CreateComponentInput {
|
|
|
871
1000
|
*/
|
|
872
1001
|
export interface CreateComponentOutput {
|
|
873
1002
|
/**
|
|
1003
|
+
* @public
|
|
874
1004
|
* <p>The detailed data of the created component.</p>
|
|
875
1005
|
*/
|
|
876
1006
|
component: Component | undefined;
|
|
@@ -893,6 +1023,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
893
1023
|
*/
|
|
894
1024
|
export interface DeleteComponentInput {
|
|
895
1025
|
/**
|
|
1026
|
+
* @public
|
|
896
1027
|
* <p>The name of the component to delete.</p>
|
|
897
1028
|
*/
|
|
898
1029
|
name: string | undefined;
|
|
@@ -902,6 +1033,7 @@ export interface DeleteComponentInput {
|
|
|
902
1033
|
*/
|
|
903
1034
|
export interface DeleteComponentOutput {
|
|
904
1035
|
/**
|
|
1036
|
+
* @public
|
|
905
1037
|
* <p>The detailed data of the component being deleted.</p>
|
|
906
1038
|
*/
|
|
907
1039
|
component?: Component;
|
|
@@ -911,6 +1043,7 @@ export interface DeleteComponentOutput {
|
|
|
911
1043
|
*/
|
|
912
1044
|
export interface GetComponentInput {
|
|
913
1045
|
/**
|
|
1046
|
+
* @public
|
|
914
1047
|
* <p>The name of the component that you want to get the detailed data for.</p>
|
|
915
1048
|
*/
|
|
916
1049
|
name: string | undefined;
|
|
@@ -920,6 +1053,7 @@ export interface GetComponentInput {
|
|
|
920
1053
|
*/
|
|
921
1054
|
export interface GetComponentOutput {
|
|
922
1055
|
/**
|
|
1056
|
+
* @public
|
|
923
1057
|
* <p>The detailed data of the requested component.</p>
|
|
924
1058
|
*/
|
|
925
1059
|
component?: Component;
|
|
@@ -929,24 +1063,29 @@ export interface GetComponentOutput {
|
|
|
929
1063
|
*/
|
|
930
1064
|
export interface ListComponentsInput {
|
|
931
1065
|
/**
|
|
1066
|
+
* @public
|
|
932
1067
|
* <p>A token that indicates the location of the next component in the array of components, after the list of components that was previously
|
|
933
1068
|
* requested.</p>
|
|
934
1069
|
*/
|
|
935
1070
|
nextToken?: string;
|
|
936
1071
|
/**
|
|
1072
|
+
* @public
|
|
937
1073
|
* <p>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances
|
|
938
1074
|
* running in it.</p>
|
|
939
1075
|
*/
|
|
940
1076
|
environmentName?: string;
|
|
941
1077
|
/**
|
|
1078
|
+
* @public
|
|
942
1079
|
* <p>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</p>
|
|
943
1080
|
*/
|
|
944
1081
|
serviceName?: string;
|
|
945
1082
|
/**
|
|
1083
|
+
* @public
|
|
946
1084
|
* <p>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</p>
|
|
947
1085
|
*/
|
|
948
1086
|
serviceInstanceName?: string;
|
|
949
1087
|
/**
|
|
1088
|
+
* @public
|
|
950
1089
|
* <p>The maximum number of components to list.</p>
|
|
951
1090
|
*/
|
|
952
1091
|
maxResults?: number;
|
|
@@ -960,54 +1099,67 @@ export interface ListComponentsInput {
|
|
|
960
1099
|
*/
|
|
961
1100
|
export interface ComponentSummary {
|
|
962
1101
|
/**
|
|
1102
|
+
* @public
|
|
963
1103
|
* <p>The name of the component.</p>
|
|
964
1104
|
*/
|
|
965
1105
|
name: string | undefined;
|
|
966
1106
|
/**
|
|
1107
|
+
* @public
|
|
967
1108
|
* <p>The Amazon Resource Name (ARN) of the component.</p>
|
|
968
1109
|
*/
|
|
969
1110
|
arn: string | undefined;
|
|
970
1111
|
/**
|
|
1112
|
+
* @public
|
|
971
1113
|
* <p>The name of the Proton environment that this component is associated with.</p>
|
|
972
1114
|
*/
|
|
973
1115
|
environmentName: string | undefined;
|
|
974
1116
|
/**
|
|
1117
|
+
* @public
|
|
975
1118
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>
|
|
976
1119
|
*/
|
|
977
1120
|
serviceName?: string;
|
|
978
1121
|
/**
|
|
1122
|
+
* @public
|
|
979
1123
|
* <p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>
|
|
980
1124
|
*/
|
|
981
1125
|
serviceInstanceName?: string;
|
|
982
1126
|
/**
|
|
1127
|
+
* @public
|
|
983
1128
|
* <p>The time when the component was created.</p>
|
|
984
1129
|
*/
|
|
985
1130
|
createdAt: Date | undefined;
|
|
986
1131
|
/**
|
|
1132
|
+
* @public
|
|
987
1133
|
* <p>The time when the component was last modified.</p>
|
|
988
1134
|
*/
|
|
989
1135
|
lastModifiedAt: Date | undefined;
|
|
990
1136
|
/**
|
|
1137
|
+
* @public
|
|
991
1138
|
* <p>The time when a deployment of the component was last attempted.</p>
|
|
992
1139
|
*/
|
|
993
1140
|
lastDeploymentAttemptedAt?: Date;
|
|
994
1141
|
/**
|
|
1142
|
+
* @public
|
|
995
1143
|
* <p>The time when the component was last deployed successfully.</p>
|
|
996
1144
|
*/
|
|
997
1145
|
lastDeploymentSucceededAt?: Date;
|
|
998
1146
|
/**
|
|
1147
|
+
* @public
|
|
999
1148
|
* <p>The component deployment status.</p>
|
|
1000
1149
|
*/
|
|
1001
1150
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
1002
1151
|
/**
|
|
1152
|
+
* @public
|
|
1003
1153
|
* <p>The message associated with the component deployment status.</p>
|
|
1004
1154
|
*/
|
|
1005
1155
|
deploymentStatusMessage?: string;
|
|
1006
1156
|
/**
|
|
1157
|
+
* @public
|
|
1007
1158
|
* <p>The ID of the last attempted deployment of this component.</p>
|
|
1008
1159
|
*/
|
|
1009
1160
|
lastAttemptedDeploymentId?: string;
|
|
1010
1161
|
/**
|
|
1162
|
+
* @public
|
|
1011
1163
|
* <p>The ID of the last successful deployment of this component.</p>
|
|
1012
1164
|
*/
|
|
1013
1165
|
lastSucceededDeploymentId?: string;
|
|
@@ -1017,10 +1169,12 @@ export interface ComponentSummary {
|
|
|
1017
1169
|
*/
|
|
1018
1170
|
export interface ListComponentsOutput {
|
|
1019
1171
|
/**
|
|
1172
|
+
* @public
|
|
1020
1173
|
* <p>A token that indicates the location of the next component in the array of components, after the current requested list of components.</p>
|
|
1021
1174
|
*/
|
|
1022
1175
|
nextToken?: string;
|
|
1023
1176
|
/**
|
|
1177
|
+
* @public
|
|
1024
1178
|
* <p>An array of components with summary data.</p>
|
|
1025
1179
|
*/
|
|
1026
1180
|
components: ComponentSummary[] | undefined;
|
|
@@ -1042,10 +1196,12 @@ export type ComponentDeploymentUpdateType = (typeof ComponentDeploymentUpdateTyp
|
|
|
1042
1196
|
*/
|
|
1043
1197
|
export interface UpdateComponentInput {
|
|
1044
1198
|
/**
|
|
1199
|
+
* @public
|
|
1045
1200
|
* <p>The name of the component to update.</p>
|
|
1046
1201
|
*/
|
|
1047
1202
|
name: string | undefined;
|
|
1048
1203
|
/**
|
|
1204
|
+
* @public
|
|
1049
1205
|
* <p>The deployment type. It defines the mode for updating a component, as follows:</p>
|
|
1050
1206
|
* <dl>
|
|
1051
1207
|
* <dt/>
|
|
@@ -1068,27 +1224,32 @@ export interface UpdateComponentInput {
|
|
|
1068
1224
|
*/
|
|
1069
1225
|
deploymentType: ComponentDeploymentUpdateType | string | undefined;
|
|
1070
1226
|
/**
|
|
1227
|
+
* @public
|
|
1071
1228
|
* <p>An optional customer-provided description of the component.</p>
|
|
1072
1229
|
*/
|
|
1073
1230
|
description?: string;
|
|
1074
1231
|
/**
|
|
1232
|
+
* @public
|
|
1075
1233
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Don't specify to keep the component's current service instance
|
|
1076
1234
|
* attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both
|
|
1077
1235
|
* <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>
|
|
1078
1236
|
*/
|
|
1079
1237
|
serviceName?: string;
|
|
1080
1238
|
/**
|
|
1239
|
+
* @public
|
|
1081
1240
|
* <p>The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment.
|
|
1082
1241
|
* Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both
|
|
1083
1242
|
* <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>
|
|
1084
1243
|
*/
|
|
1085
1244
|
serviceInstanceName?: string;
|
|
1086
1245
|
/**
|
|
1246
|
+
* @public
|
|
1087
1247
|
* <p>The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service
|
|
1088
1248
|
* instance.</p>
|
|
1089
1249
|
*/
|
|
1090
1250
|
serviceSpec?: string;
|
|
1091
1251
|
/**
|
|
1252
|
+
* @public
|
|
1092
1253
|
* <p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p>
|
|
1093
1254
|
* <note>
|
|
1094
1255
|
* <p>Components support a single IaC file, even if you use Terraform as your template language.</p>
|
|
@@ -1096,6 +1257,7 @@ export interface UpdateComponentInput {
|
|
|
1096
1257
|
*/
|
|
1097
1258
|
templateFile?: string;
|
|
1098
1259
|
/**
|
|
1260
|
+
* @public
|
|
1099
1261
|
* <p>The client token for the updated component.</p>
|
|
1100
1262
|
*/
|
|
1101
1263
|
clientToken?: string;
|
|
@@ -1105,6 +1267,7 @@ export interface UpdateComponentInput {
|
|
|
1105
1267
|
*/
|
|
1106
1268
|
export interface UpdateComponentOutput {
|
|
1107
1269
|
/**
|
|
1270
|
+
* @public
|
|
1108
1271
|
* <p>The detailed data of the updated component.</p>
|
|
1109
1272
|
*/
|
|
1110
1273
|
component: Component | undefined;
|
|
@@ -1114,6 +1277,7 @@ export interface UpdateComponentOutput {
|
|
|
1114
1277
|
*/
|
|
1115
1278
|
export interface DeleteDeploymentInput {
|
|
1116
1279
|
/**
|
|
1280
|
+
* @public
|
|
1117
1281
|
* <p>The ID of the deployment to delete.</p>
|
|
1118
1282
|
*/
|
|
1119
1283
|
id: string | undefined;
|
|
@@ -1124,18 +1288,22 @@ export interface DeleteDeploymentInput {
|
|
|
1124
1288
|
*/
|
|
1125
1289
|
export interface ComponentState {
|
|
1126
1290
|
/**
|
|
1291
|
+
* @public
|
|
1127
1292
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>
|
|
1128
1293
|
*/
|
|
1129
1294
|
serviceName?: string;
|
|
1130
1295
|
/**
|
|
1296
|
+
* @public
|
|
1131
1297
|
* <p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>
|
|
1132
1298
|
*/
|
|
1133
1299
|
serviceInstanceName?: string;
|
|
1134
1300
|
/**
|
|
1301
|
+
* @public
|
|
1135
1302
|
* <p>The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.</p>
|
|
1136
1303
|
*/
|
|
1137
1304
|
serviceSpec?: string;
|
|
1138
1305
|
/**
|
|
1306
|
+
* @public
|
|
1139
1307
|
* <p>The template file used.</p>
|
|
1140
1308
|
*/
|
|
1141
1309
|
templateFile?: string;
|
|
@@ -1146,18 +1314,22 @@ export interface ComponentState {
|
|
|
1146
1314
|
*/
|
|
1147
1315
|
export interface EnvironmentState {
|
|
1148
1316
|
/**
|
|
1317
|
+
* @public
|
|
1149
1318
|
* <p>The environment spec that was used to create the environment.</p>
|
|
1150
1319
|
*/
|
|
1151
1320
|
spec?: string;
|
|
1152
1321
|
/**
|
|
1322
|
+
* @public
|
|
1153
1323
|
* <p>The name of the environment template that was used to create the environment.</p>
|
|
1154
1324
|
*/
|
|
1155
1325
|
templateName: string | undefined;
|
|
1156
1326
|
/**
|
|
1327
|
+
* @public
|
|
1157
1328
|
* <p>The major version of the environment template that was used to create the environment.</p>
|
|
1158
1329
|
*/
|
|
1159
1330
|
templateMajorVersion: string | undefined;
|
|
1160
1331
|
/**
|
|
1332
|
+
* @public
|
|
1161
1333
|
* <p>The minor version of the environment template that was used to create the environment.</p>
|
|
1162
1334
|
*/
|
|
1163
1335
|
templateMinorVersion: string | undefined;
|
|
@@ -1168,32 +1340,39 @@ export interface EnvironmentState {
|
|
|
1168
1340
|
*/
|
|
1169
1341
|
export interface ServiceInstanceState {
|
|
1170
1342
|
/**
|
|
1343
|
+
* @public
|
|
1171
1344
|
* <p>The service spec that was used to create the service instance.</p>
|
|
1172
1345
|
*/
|
|
1173
1346
|
spec: string | undefined;
|
|
1174
1347
|
/**
|
|
1348
|
+
* @public
|
|
1175
1349
|
* <p>The name of the service template that was used to create the service instance.</p>
|
|
1176
1350
|
*/
|
|
1177
1351
|
templateName: string | undefined;
|
|
1178
1352
|
/**
|
|
1353
|
+
* @public
|
|
1179
1354
|
* <p>The major version of the service template that was used to create the service
|
|
1180
1355
|
* pipeline.</p>
|
|
1181
1356
|
*/
|
|
1182
1357
|
templateMajorVersion: string | undefined;
|
|
1183
1358
|
/**
|
|
1359
|
+
* @public
|
|
1184
1360
|
* <p>The minor version of the service template that was used to create the service
|
|
1185
1361
|
* pipeline.</p>
|
|
1186
1362
|
*/
|
|
1187
1363
|
templateMinorVersion: string | undefined;
|
|
1188
1364
|
/**
|
|
1365
|
+
* @public
|
|
1189
1366
|
* <p>The IDs for the last successful components deployed for this service instance.</p>
|
|
1190
1367
|
*/
|
|
1191
1368
|
lastSuccessfulComponentDeploymentIds?: string[];
|
|
1192
1369
|
/**
|
|
1370
|
+
* @public
|
|
1193
1371
|
* <p>The ID for the last successful environment deployed for this service instance.</p>
|
|
1194
1372
|
*/
|
|
1195
1373
|
lastSuccessfulEnvironmentDeploymentId?: string;
|
|
1196
1374
|
/**
|
|
1375
|
+
* @public
|
|
1197
1376
|
* <p>The ID for the last successful service pipeline deployed for this service instance.</p>
|
|
1198
1377
|
*/
|
|
1199
1378
|
lastSuccessfulServicePipelineDeploymentId?: string;
|
|
@@ -1204,19 +1383,23 @@ export interface ServiceInstanceState {
|
|
|
1204
1383
|
*/
|
|
1205
1384
|
export interface ServicePipelineState {
|
|
1206
1385
|
/**
|
|
1386
|
+
* @public
|
|
1207
1387
|
* <p>The service spec that was used to create the service pipeline.</p>
|
|
1208
1388
|
*/
|
|
1209
1389
|
spec?: string;
|
|
1210
1390
|
/**
|
|
1391
|
+
* @public
|
|
1211
1392
|
* <p>The name of the service template that was used to create the service pipeline.</p>
|
|
1212
1393
|
*/
|
|
1213
1394
|
templateName: string | undefined;
|
|
1214
1395
|
/**
|
|
1396
|
+
* @public
|
|
1215
1397
|
* <p>The major version of the service template that was used to create the service
|
|
1216
1398
|
* pipeline.</p>
|
|
1217
1399
|
*/
|
|
1218
1400
|
templateMajorVersion: string | undefined;
|
|
1219
1401
|
/**
|
|
1402
|
+
* @public
|
|
1220
1403
|
* <p>The minor version of the service template that was used to create the service
|
|
1221
1404
|
* pipeline.</p>
|
|
1222
1405
|
*/
|
|
@@ -1232,6 +1415,7 @@ export type DeploymentState = DeploymentState.ComponentMember | DeploymentState.
|
|
|
1232
1415
|
*/
|
|
1233
1416
|
export declare namespace DeploymentState {
|
|
1234
1417
|
/**
|
|
1418
|
+
* @public
|
|
1235
1419
|
* <p>The state of the service instance associated with the deployment.</p>
|
|
1236
1420
|
*/
|
|
1237
1421
|
interface ServiceInstanceMember {
|
|
@@ -1242,6 +1426,7 @@ export declare namespace DeploymentState {
|
|
|
1242
1426
|
$unknown?: never;
|
|
1243
1427
|
}
|
|
1244
1428
|
/**
|
|
1429
|
+
* @public
|
|
1245
1430
|
* <p>The state of the environment associated with the deployment.</p>
|
|
1246
1431
|
*/
|
|
1247
1432
|
interface EnvironmentMember {
|
|
@@ -1252,6 +1437,7 @@ export declare namespace DeploymentState {
|
|
|
1252
1437
|
$unknown?: never;
|
|
1253
1438
|
}
|
|
1254
1439
|
/**
|
|
1440
|
+
* @public
|
|
1255
1441
|
* <p>The state of the service pipeline associated with the deployment.</p>
|
|
1256
1442
|
*/
|
|
1257
1443
|
interface ServicePipelineMember {
|
|
@@ -1262,6 +1448,7 @@ export declare namespace DeploymentState {
|
|
|
1262
1448
|
$unknown?: never;
|
|
1263
1449
|
}
|
|
1264
1450
|
/**
|
|
1451
|
+
* @public
|
|
1265
1452
|
* <p>The state of the component associated with the deployment.</p>
|
|
1266
1453
|
*/
|
|
1267
1454
|
interface ComponentMember {
|
|
@@ -1271,6 +1458,9 @@ export declare namespace DeploymentState {
|
|
|
1271
1458
|
component: ComponentState;
|
|
1272
1459
|
$unknown?: never;
|
|
1273
1460
|
}
|
|
1461
|
+
/**
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1274
1464
|
interface $UnknownMember {
|
|
1275
1465
|
serviceInstance?: never;
|
|
1276
1466
|
environment?: never;
|
|
@@ -1307,74 +1497,92 @@ export type DeploymentTargetResourceType = (typeof DeploymentTargetResourceType)
|
|
|
1307
1497
|
*/
|
|
1308
1498
|
export interface Deployment {
|
|
1309
1499
|
/**
|
|
1500
|
+
* @public
|
|
1310
1501
|
* <p>The ID of the deployment.</p>
|
|
1311
1502
|
*/
|
|
1312
1503
|
id: string | undefined;
|
|
1313
1504
|
/**
|
|
1505
|
+
* @public
|
|
1314
1506
|
* <p>The Amazon Resource Name (ARN) of the deployment.</p>
|
|
1315
1507
|
*/
|
|
1316
1508
|
arn: string | undefined;
|
|
1317
1509
|
/**
|
|
1510
|
+
* @public
|
|
1318
1511
|
* <p>The Amazon Resource Name (ARN) of the target of the deployment.</p>
|
|
1319
1512
|
*/
|
|
1320
1513
|
targetArn: string | undefined;
|
|
1321
1514
|
/**
|
|
1515
|
+
* @public
|
|
1322
1516
|
* <p>The date and time the depoyment target was created.</p>
|
|
1323
1517
|
*/
|
|
1324
1518
|
targetResourceCreatedAt: Date | undefined;
|
|
1325
1519
|
/**
|
|
1520
|
+
* @public
|
|
1326
1521
|
* <p>The resource type of the deployment target. It can be an environment, service, service instance, or component.</p>
|
|
1327
1522
|
*/
|
|
1328
1523
|
targetResourceType: DeploymentTargetResourceType | string | undefined;
|
|
1329
1524
|
/**
|
|
1525
|
+
* @public
|
|
1330
1526
|
* <p>The name of the environment associated with this deployment.</p>
|
|
1331
1527
|
*/
|
|
1332
1528
|
environmentName: string | undefined;
|
|
1333
1529
|
/**
|
|
1530
|
+
* @public
|
|
1334
1531
|
* <p>The name of the service in this deployment.</p>
|
|
1335
1532
|
*/
|
|
1336
1533
|
serviceName?: string;
|
|
1337
1534
|
/**
|
|
1535
|
+
* @public
|
|
1338
1536
|
* <p>The name of the deployment's service instance.</p>
|
|
1339
1537
|
*/
|
|
1340
1538
|
serviceInstanceName?: string;
|
|
1341
1539
|
/**
|
|
1540
|
+
* @public
|
|
1342
1541
|
* <p>The name of the component associated with this deployment.</p>
|
|
1343
1542
|
*/
|
|
1344
1543
|
componentName?: string;
|
|
1345
1544
|
/**
|
|
1545
|
+
* @public
|
|
1346
1546
|
* <p>The status of the deployment.</p>
|
|
1347
1547
|
*/
|
|
1348
1548
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
1349
1549
|
/**
|
|
1550
|
+
* @public
|
|
1350
1551
|
* <p>The deployment status message.</p>
|
|
1351
1552
|
*/
|
|
1352
1553
|
deploymentStatusMessage?: string;
|
|
1353
1554
|
/**
|
|
1555
|
+
* @public
|
|
1354
1556
|
* <p>The date and time the deployment was created.</p>
|
|
1355
1557
|
*/
|
|
1356
1558
|
createdAt: Date | undefined;
|
|
1357
1559
|
/**
|
|
1560
|
+
* @public
|
|
1358
1561
|
* <p>The date and time the deployment was last modified.</p>
|
|
1359
1562
|
*/
|
|
1360
1563
|
lastModifiedAt: Date | undefined;
|
|
1361
1564
|
/**
|
|
1565
|
+
* @public
|
|
1362
1566
|
* <p>The date and time the deployment was completed.</p>
|
|
1363
1567
|
*/
|
|
1364
1568
|
completedAt?: Date;
|
|
1365
1569
|
/**
|
|
1570
|
+
* @public
|
|
1366
1571
|
* <p>The ID of the last attempted deployment.</p>
|
|
1367
1572
|
*/
|
|
1368
1573
|
lastAttemptedDeploymentId?: string;
|
|
1369
1574
|
/**
|
|
1575
|
+
* @public
|
|
1370
1576
|
* <p>The ID of the last successful deployment.</p>
|
|
1371
1577
|
*/
|
|
1372
1578
|
lastSucceededDeploymentId?: string;
|
|
1373
1579
|
/**
|
|
1580
|
+
* @public
|
|
1374
1581
|
* <p>The initial state of the target resource at the time of the deployment.</p>
|
|
1375
1582
|
*/
|
|
1376
1583
|
initialState?: DeploymentState;
|
|
1377
1584
|
/**
|
|
1585
|
+
* @public
|
|
1378
1586
|
* <p>The target state of the target resource at the time of the deployment.</p>
|
|
1379
1587
|
*/
|
|
1380
1588
|
targetState?: DeploymentState;
|
|
@@ -1384,6 +1592,7 @@ export interface Deployment {
|
|
|
1384
1592
|
*/
|
|
1385
1593
|
export interface DeleteDeploymentOutput {
|
|
1386
1594
|
/**
|
|
1595
|
+
* @public
|
|
1387
1596
|
* <p>The detailed data of the deployment being deleted.</p>
|
|
1388
1597
|
*/
|
|
1389
1598
|
deployment?: Deployment;
|
|
@@ -1393,23 +1602,28 @@ export interface DeleteDeploymentOutput {
|
|
|
1393
1602
|
*/
|
|
1394
1603
|
export interface GetDeploymentInput {
|
|
1395
1604
|
/**
|
|
1605
|
+
* @public
|
|
1396
1606
|
* <p>The ID of the deployment that you want to get the detailed data for.</p>
|
|
1397
1607
|
*/
|
|
1398
1608
|
id: string | undefined;
|
|
1399
1609
|
/**
|
|
1610
|
+
* @public
|
|
1400
1611
|
* <p>The name of a environment that you want to get the detailed data for.</p>
|
|
1401
1612
|
*/
|
|
1402
1613
|
environmentName?: string;
|
|
1403
1614
|
/**
|
|
1615
|
+
* @public
|
|
1404
1616
|
* <p>The name of the service associated with the given deployment ID.</p>
|
|
1405
1617
|
*/
|
|
1406
1618
|
serviceName?: string;
|
|
1407
1619
|
/**
|
|
1620
|
+
* @public
|
|
1408
1621
|
* <p>The name of the service instance associated with the given deployment ID. <code>serviceName</code> must be specified to identify the service
|
|
1409
1622
|
* instance.</p>
|
|
1410
1623
|
*/
|
|
1411
1624
|
serviceInstanceName?: string;
|
|
1412
1625
|
/**
|
|
1626
|
+
* @public
|
|
1413
1627
|
* <p>The name of a component that you want to get the detailed data for.</p>
|
|
1414
1628
|
*/
|
|
1415
1629
|
componentName?: string;
|
|
@@ -1419,6 +1633,7 @@ export interface GetDeploymentInput {
|
|
|
1419
1633
|
*/
|
|
1420
1634
|
export interface GetDeploymentOutput {
|
|
1421
1635
|
/**
|
|
1636
|
+
* @public
|
|
1422
1637
|
* <p>The detailed data of the requested deployment.</p>
|
|
1423
1638
|
*/
|
|
1424
1639
|
deployment?: Deployment;
|
|
@@ -1428,27 +1643,33 @@ export interface GetDeploymentOutput {
|
|
|
1428
1643
|
*/
|
|
1429
1644
|
export interface ListDeploymentsInput {
|
|
1430
1645
|
/**
|
|
1646
|
+
* @public
|
|
1431
1647
|
* <p>A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously
|
|
1432
1648
|
* requested.</p>
|
|
1433
1649
|
*/
|
|
1434
1650
|
nextToken?: string;
|
|
1435
1651
|
/**
|
|
1652
|
+
* @public
|
|
1436
1653
|
* <p>The name of an environment for result list filtering. Proton returns deployments associated with the environment.</p>
|
|
1437
1654
|
*/
|
|
1438
1655
|
environmentName?: string;
|
|
1439
1656
|
/**
|
|
1657
|
+
* @public
|
|
1440
1658
|
* <p>The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.</p>
|
|
1441
1659
|
*/
|
|
1442
1660
|
serviceName?: string;
|
|
1443
1661
|
/**
|
|
1662
|
+
* @public
|
|
1444
1663
|
* <p>The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.</p>
|
|
1445
1664
|
*/
|
|
1446
1665
|
serviceInstanceName?: string;
|
|
1447
1666
|
/**
|
|
1667
|
+
* @public
|
|
1448
1668
|
* <p>The name of a component for result list filtering. Proton returns deployments associated with that component.</p>
|
|
1449
1669
|
*/
|
|
1450
1670
|
componentName?: string;
|
|
1451
1671
|
/**
|
|
1672
|
+
* @public
|
|
1452
1673
|
* <p>The maximum number of deployments to list.</p>
|
|
1453
1674
|
*/
|
|
1454
1675
|
maxResults?: number;
|
|
@@ -1459,62 +1680,77 @@ export interface ListDeploymentsInput {
|
|
|
1459
1680
|
*/
|
|
1460
1681
|
export interface DeploymentSummary {
|
|
1461
1682
|
/**
|
|
1683
|
+
* @public
|
|
1462
1684
|
* <p>The ID of the deployment.</p>
|
|
1463
1685
|
*/
|
|
1464
1686
|
id: string | undefined;
|
|
1465
1687
|
/**
|
|
1688
|
+
* @public
|
|
1466
1689
|
* <p>The Amazon Resource Name (ARN) of the deployment.</p>
|
|
1467
1690
|
*/
|
|
1468
1691
|
arn: string | undefined;
|
|
1469
1692
|
/**
|
|
1693
|
+
* @public
|
|
1470
1694
|
* <p>The Amazon Resource Name (ARN) of the target of the deployment.</p>
|
|
1471
1695
|
*/
|
|
1472
1696
|
targetArn: string | undefined;
|
|
1473
1697
|
/**
|
|
1698
|
+
* @public
|
|
1474
1699
|
* <p>The date and time the target resource was created.</p>
|
|
1475
1700
|
*/
|
|
1476
1701
|
targetResourceCreatedAt: Date | undefined;
|
|
1477
1702
|
/**
|
|
1703
|
+
* @public
|
|
1478
1704
|
* <p>The resource type of the deployment target. It can be an environment, service, service instance, or component.</p>
|
|
1479
1705
|
*/
|
|
1480
1706
|
targetResourceType: DeploymentTargetResourceType | string | undefined;
|
|
1481
1707
|
/**
|
|
1708
|
+
* @public
|
|
1482
1709
|
* <p>The date and time the deployment was created.</p>
|
|
1483
1710
|
*/
|
|
1484
1711
|
createdAt: Date | undefined;
|
|
1485
1712
|
/**
|
|
1713
|
+
* @public
|
|
1486
1714
|
* <p>The date and time the deployment was last modified.</p>
|
|
1487
1715
|
*/
|
|
1488
1716
|
lastModifiedAt: Date | undefined;
|
|
1489
1717
|
/**
|
|
1718
|
+
* @public
|
|
1490
1719
|
* <p>The date and time the deployment was completed.</p>
|
|
1491
1720
|
*/
|
|
1492
1721
|
completedAt?: Date;
|
|
1493
1722
|
/**
|
|
1723
|
+
* @public
|
|
1494
1724
|
* <p>The name of the environment associated with the deployment.</p>
|
|
1495
1725
|
*/
|
|
1496
1726
|
environmentName: string | undefined;
|
|
1497
1727
|
/**
|
|
1728
|
+
* @public
|
|
1498
1729
|
* <p>The name of the service associated with the deployment.</p>
|
|
1499
1730
|
*/
|
|
1500
1731
|
serviceName?: string;
|
|
1501
1732
|
/**
|
|
1733
|
+
* @public
|
|
1502
1734
|
* <p>The name of the service instance associated with the deployment.</p>
|
|
1503
1735
|
*/
|
|
1504
1736
|
serviceInstanceName?: string;
|
|
1505
1737
|
/**
|
|
1738
|
+
* @public
|
|
1506
1739
|
* <p>The name of the component associated with the deployment.</p>
|
|
1507
1740
|
*/
|
|
1508
1741
|
componentName?: string;
|
|
1509
1742
|
/**
|
|
1743
|
+
* @public
|
|
1510
1744
|
* <p>The ID of the last attempted deployment.</p>
|
|
1511
1745
|
*/
|
|
1512
1746
|
lastAttemptedDeploymentId?: string;
|
|
1513
1747
|
/**
|
|
1748
|
+
* @public
|
|
1514
1749
|
* <p>The ID of the last successful deployment.</p>
|
|
1515
1750
|
*/
|
|
1516
1751
|
lastSucceededDeploymentId?: string;
|
|
1517
1752
|
/**
|
|
1753
|
+
* @public
|
|
1518
1754
|
* <p>The current status of the deployment.</p>
|
|
1519
1755
|
*/
|
|
1520
1756
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
@@ -1524,10 +1760,12 @@ export interface DeploymentSummary {
|
|
|
1524
1760
|
*/
|
|
1525
1761
|
export interface ListDeploymentsOutput {
|
|
1526
1762
|
/**
|
|
1763
|
+
* @public
|
|
1527
1764
|
* <p>A token that indicates the location of the next deployment in the array of deployment, after the current requested list of deployment.</p>
|
|
1528
1765
|
*/
|
|
1529
1766
|
nextToken?: string;
|
|
1530
1767
|
/**
|
|
1768
|
+
* @public
|
|
1531
1769
|
* <p>An array of deployment with summary data.</p>
|
|
1532
1770
|
*/
|
|
1533
1771
|
deployments: DeploymentSummary[] | undefined;
|
|
@@ -1537,32 +1775,38 @@ export interface ListDeploymentsOutput {
|
|
|
1537
1775
|
*/
|
|
1538
1776
|
export interface CreateEnvironmentAccountConnectionInput {
|
|
1539
1777
|
/**
|
|
1778
|
+
* @public
|
|
1540
1779
|
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first
|
|
1541
1780
|
* request created.</p>
|
|
1542
1781
|
*/
|
|
1543
1782
|
clientToken?: string;
|
|
1544
1783
|
/**
|
|
1784
|
+
* @public
|
|
1545
1785
|
* <p>The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this
|
|
1546
1786
|
* account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment
|
|
1547
1787
|
* infrastructure resources in the associated environment account.</p>
|
|
1548
1788
|
*/
|
|
1549
1789
|
managementAccountId: string | undefined;
|
|
1550
1790
|
/**
|
|
1791
|
+
* @public
|
|
1551
1792
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure
|
|
1552
1793
|
* resources in the associated environment account.</p>
|
|
1553
1794
|
*/
|
|
1554
1795
|
roleArn?: string;
|
|
1555
1796
|
/**
|
|
1797
|
+
* @public
|
|
1556
1798
|
* <p>The name of the Proton environment that's created in the associated management account.</p>
|
|
1557
1799
|
*/
|
|
1558
1800
|
environmentName: string | undefined;
|
|
1559
1801
|
/**
|
|
1802
|
+
* @public
|
|
1560
1803
|
* <p>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</p>
|
|
1561
1804
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
1562
1805
|
* <i>Proton User Guide</i>.</p>
|
|
1563
1806
|
*/
|
|
1564
1807
|
tags?: Tag[];
|
|
1565
1808
|
/**
|
|
1809
|
+
* @public
|
|
1566
1810
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1567
1811
|
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1568
1812
|
* <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in this
|
|
@@ -1573,6 +1817,7 @@ export interface CreateEnvironmentAccountConnectionInput {
|
|
|
1573
1817
|
*/
|
|
1574
1818
|
componentRoleArn?: string;
|
|
1575
1819
|
/**
|
|
1820
|
+
* @public
|
|
1576
1821
|
* <p>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources
|
|
1577
1822
|
* using CodeBuild-based provisioning in the associated environment account.</p>
|
|
1578
1823
|
*/
|
|
@@ -1583,6 +1828,7 @@ export interface CreateEnvironmentAccountConnectionInput {
|
|
|
1583
1828
|
*/
|
|
1584
1829
|
export interface CreateEnvironmentAccountConnectionOutput {
|
|
1585
1830
|
/**
|
|
1831
|
+
* @public
|
|
1586
1832
|
* <p>The environment account connection detail data that's returned by Proton.</p>
|
|
1587
1833
|
*/
|
|
1588
1834
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
@@ -1592,6 +1838,7 @@ export interface CreateEnvironmentAccountConnectionOutput {
|
|
|
1592
1838
|
*/
|
|
1593
1839
|
export interface DeleteEnvironmentAccountConnectionInput {
|
|
1594
1840
|
/**
|
|
1841
|
+
* @public
|
|
1595
1842
|
* <p>The ID of the environment account connection to delete.</p>
|
|
1596
1843
|
*/
|
|
1597
1844
|
id: string | undefined;
|
|
@@ -1601,6 +1848,7 @@ export interface DeleteEnvironmentAccountConnectionInput {
|
|
|
1601
1848
|
*/
|
|
1602
1849
|
export interface DeleteEnvironmentAccountConnectionOutput {
|
|
1603
1850
|
/**
|
|
1851
|
+
* @public
|
|
1604
1852
|
* <p>The detailed data of the environment account connection being deleted.</p>
|
|
1605
1853
|
*/
|
|
1606
1854
|
environmentAccountConnection?: EnvironmentAccountConnection;
|
|
@@ -1610,6 +1858,7 @@ export interface DeleteEnvironmentAccountConnectionOutput {
|
|
|
1610
1858
|
*/
|
|
1611
1859
|
export interface GetEnvironmentAccountConnectionInput {
|
|
1612
1860
|
/**
|
|
1861
|
+
* @public
|
|
1613
1862
|
* <p>The ID of the environment account connection that you want to get the detailed data for.</p>
|
|
1614
1863
|
*/
|
|
1615
1864
|
id: string | undefined;
|
|
@@ -1619,6 +1868,7 @@ export interface GetEnvironmentAccountConnectionInput {
|
|
|
1619
1868
|
*/
|
|
1620
1869
|
export interface GetEnvironmentAccountConnectionOutput {
|
|
1621
1870
|
/**
|
|
1871
|
+
* @public
|
|
1622
1872
|
* <p>The detailed data of the requested environment account connection.</p>
|
|
1623
1873
|
*/
|
|
1624
1874
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
@@ -1640,23 +1890,28 @@ export type EnvironmentAccountConnectionRequesterAccountType = (typeof Environme
|
|
|
1640
1890
|
*/
|
|
1641
1891
|
export interface ListEnvironmentAccountConnectionsInput {
|
|
1642
1892
|
/**
|
|
1893
|
+
* @public
|
|
1643
1894
|
* <p>The type of account making the <code>ListEnvironmentAccountConnections</code> request.</p>
|
|
1644
1895
|
*/
|
|
1645
1896
|
requestedBy: EnvironmentAccountConnectionRequesterAccountType | string | undefined;
|
|
1646
1897
|
/**
|
|
1898
|
+
* @public
|
|
1647
1899
|
* <p>The environment name that's associated with each listed environment account connection.</p>
|
|
1648
1900
|
*/
|
|
1649
1901
|
environmentName?: string;
|
|
1650
1902
|
/**
|
|
1903
|
+
* @public
|
|
1651
1904
|
* <p>The status details for each listed environment account connection.</p>
|
|
1652
1905
|
*/
|
|
1653
1906
|
statuses?: (EnvironmentAccountConnectionStatus | string)[];
|
|
1654
1907
|
/**
|
|
1908
|
+
* @public
|
|
1655
1909
|
* <p>A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of
|
|
1656
1910
|
* environment account connections that was previously requested.</p>
|
|
1657
1911
|
*/
|
|
1658
1912
|
nextToken?: string;
|
|
1659
1913
|
/**
|
|
1914
|
+
* @public
|
|
1660
1915
|
* <p>The maximum number of environment account connections to list.</p>
|
|
1661
1916
|
*/
|
|
1662
1917
|
maxResults?: number;
|
|
@@ -1667,42 +1922,52 @@ export interface ListEnvironmentAccountConnectionsInput {
|
|
|
1667
1922
|
*/
|
|
1668
1923
|
export interface EnvironmentAccountConnectionSummary {
|
|
1669
1924
|
/**
|
|
1925
|
+
* @public
|
|
1670
1926
|
* <p>The ID of the environment account connection.</p>
|
|
1671
1927
|
*/
|
|
1672
1928
|
id: string | undefined;
|
|
1673
1929
|
/**
|
|
1930
|
+
* @public
|
|
1674
1931
|
* <p>The Amazon Resource Name (ARN) of the environment account connection.</p>
|
|
1675
1932
|
*/
|
|
1676
1933
|
arn: string | undefined;
|
|
1677
1934
|
/**
|
|
1935
|
+
* @public
|
|
1678
1936
|
* <p>The ID of the management account that's connected to the environment account connection.</p>
|
|
1679
1937
|
*/
|
|
1680
1938
|
managementAccountId: string | undefined;
|
|
1681
1939
|
/**
|
|
1940
|
+
* @public
|
|
1682
1941
|
* <p>The ID of the environment account that's connected to the environment account connection.</p>
|
|
1683
1942
|
*/
|
|
1684
1943
|
environmentAccountId: string | undefined;
|
|
1685
1944
|
/**
|
|
1945
|
+
* @public
|
|
1686
1946
|
* <p>The IAM service role that's associated with the environment account connection.</p>
|
|
1687
1947
|
*/
|
|
1688
1948
|
roleArn: string | undefined;
|
|
1689
1949
|
/**
|
|
1950
|
+
* @public
|
|
1690
1951
|
* <p>The name of the environment that's associated with the environment account connection.</p>
|
|
1691
1952
|
*/
|
|
1692
1953
|
environmentName: string | undefined;
|
|
1693
1954
|
/**
|
|
1955
|
+
* @public
|
|
1694
1956
|
* <p>The time when the environment account connection request was made.</p>
|
|
1695
1957
|
*/
|
|
1696
1958
|
requestedAt: Date | undefined;
|
|
1697
1959
|
/**
|
|
1960
|
+
* @public
|
|
1698
1961
|
* <p>The time when the environment account connection was last modified.</p>
|
|
1699
1962
|
*/
|
|
1700
1963
|
lastModifiedAt: Date | undefined;
|
|
1701
1964
|
/**
|
|
1965
|
+
* @public
|
|
1702
1966
|
* <p>The status of the environment account connection.</p>
|
|
1703
1967
|
*/
|
|
1704
1968
|
status: EnvironmentAccountConnectionStatus | string | undefined;
|
|
1705
1969
|
/**
|
|
1970
|
+
* @public
|
|
1706
1971
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1707
1972
|
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1708
1973
|
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
@@ -1718,10 +1983,12 @@ export interface EnvironmentAccountConnectionSummary {
|
|
|
1718
1983
|
*/
|
|
1719
1984
|
export interface ListEnvironmentAccountConnectionsOutput {
|
|
1720
1985
|
/**
|
|
1986
|
+
* @public
|
|
1721
1987
|
* <p>An array of environment account connections with details that's returned by Proton. </p>
|
|
1722
1988
|
*/
|
|
1723
1989
|
environmentAccountConnections: EnvironmentAccountConnectionSummary[] | undefined;
|
|
1724
1990
|
/**
|
|
1991
|
+
* @public
|
|
1725
1992
|
* <p>A token that indicates the location of the next environment account connection in the array of environment account connections, after the current
|
|
1726
1993
|
* requested list of environment account connections.</p>
|
|
1727
1994
|
*/
|
|
@@ -1732,6 +1999,7 @@ export interface ListEnvironmentAccountConnectionsOutput {
|
|
|
1732
1999
|
*/
|
|
1733
2000
|
export interface RejectEnvironmentAccountConnectionInput {
|
|
1734
2001
|
/**
|
|
2002
|
+
* @public
|
|
1735
2003
|
* <p>The ID of the environment account connection to reject.</p>
|
|
1736
2004
|
*/
|
|
1737
2005
|
id: string | undefined;
|
|
@@ -1741,6 +2009,7 @@ export interface RejectEnvironmentAccountConnectionInput {
|
|
|
1741
2009
|
*/
|
|
1742
2010
|
export interface RejectEnvironmentAccountConnectionOutput {
|
|
1743
2011
|
/**
|
|
2012
|
+
* @public
|
|
1744
2013
|
* <p>The environment connection account detail data that's returned by Proton.</p>
|
|
1745
2014
|
*/
|
|
1746
2015
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
@@ -1750,14 +2019,17 @@ export interface RejectEnvironmentAccountConnectionOutput {
|
|
|
1750
2019
|
*/
|
|
1751
2020
|
export interface UpdateEnvironmentAccountConnectionInput {
|
|
1752
2021
|
/**
|
|
2022
|
+
* @public
|
|
1753
2023
|
* <p>The ID of the environment account connection to update.</p>
|
|
1754
2024
|
*/
|
|
1755
2025
|
id: string | undefined;
|
|
1756
2026
|
/**
|
|
2027
|
+
* @public
|
|
1757
2028
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.</p>
|
|
1758
2029
|
*/
|
|
1759
2030
|
roleArn?: string;
|
|
1760
2031
|
/**
|
|
2032
|
+
* @public
|
|
1761
2033
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1762
2034
|
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1763
2035
|
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
@@ -1768,6 +2040,7 @@ export interface UpdateEnvironmentAccountConnectionInput {
|
|
|
1768
2040
|
*/
|
|
1769
2041
|
componentRoleArn?: string;
|
|
1770
2042
|
/**
|
|
2043
|
+
* @public
|
|
1771
2044
|
* <p>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources
|
|
1772
2045
|
* using CodeBuild-based provisioning in the associated environment account.</p>
|
|
1773
2046
|
*/
|
|
@@ -1778,6 +2051,7 @@ export interface UpdateEnvironmentAccountConnectionInput {
|
|
|
1778
2051
|
*/
|
|
1779
2052
|
export interface UpdateEnvironmentAccountConnectionOutput {
|
|
1780
2053
|
/**
|
|
2054
|
+
* @public
|
|
1781
2055
|
* <p>The environment account connection detail data that's returned by Proton.</p>
|
|
1782
2056
|
*/
|
|
1783
2057
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
@@ -1787,15 +2061,18 @@ export interface UpdateEnvironmentAccountConnectionOutput {
|
|
|
1787
2061
|
*/
|
|
1788
2062
|
export interface ListEnvironmentOutputsInput {
|
|
1789
2063
|
/**
|
|
2064
|
+
* @public
|
|
1790
2065
|
* <p>The environment name.</p>
|
|
1791
2066
|
*/
|
|
1792
2067
|
environmentName: string | undefined;
|
|
1793
2068
|
/**
|
|
2069
|
+
* @public
|
|
1794
2070
|
* <p>A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was
|
|
1795
2071
|
* previously requested.</p>
|
|
1796
2072
|
*/
|
|
1797
2073
|
nextToken?: string;
|
|
1798
2074
|
/**
|
|
2075
|
+
* @public
|
|
1799
2076
|
* <p>The ID of the deployment whose outputs you want.</p>
|
|
1800
2077
|
*/
|
|
1801
2078
|
deploymentId?: string;
|
|
@@ -1805,11 +2082,13 @@ export interface ListEnvironmentOutputsInput {
|
|
|
1805
2082
|
*/
|
|
1806
2083
|
export interface ListEnvironmentOutputsOutput {
|
|
1807
2084
|
/**
|
|
2085
|
+
* @public
|
|
1808
2086
|
* <p>A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of
|
|
1809
2087
|
* environment outputs.</p>
|
|
1810
2088
|
*/
|
|
1811
2089
|
nextToken?: string;
|
|
1812
2090
|
/**
|
|
2091
|
+
* @public
|
|
1813
2092
|
* <p>An array of environment outputs with detail data.</p>
|
|
1814
2093
|
*/
|
|
1815
2094
|
outputs: Output[] | undefined;
|
|
@@ -1819,10 +2098,12 @@ export interface ListEnvironmentOutputsOutput {
|
|
|
1819
2098
|
*/
|
|
1820
2099
|
export interface ListEnvironmentProvisionedResourcesInput {
|
|
1821
2100
|
/**
|
|
2101
|
+
* @public
|
|
1822
2102
|
* <p>The environment name.</p>
|
|
1823
2103
|
*/
|
|
1824
2104
|
environmentName: string | undefined;
|
|
1825
2105
|
/**
|
|
2106
|
+
* @public
|
|
1826
2107
|
* <p>A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of
|
|
1827
2108
|
* environment provisioned resources that was previously requested.</p>
|
|
1828
2109
|
*/
|
|
@@ -1833,11 +2114,13 @@ export interface ListEnvironmentProvisionedResourcesInput {
|
|
|
1833
2114
|
*/
|
|
1834
2115
|
export interface ListEnvironmentProvisionedResourcesOutput {
|
|
1835
2116
|
/**
|
|
2117
|
+
* @public
|
|
1836
2118
|
* <p>A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested
|
|
1837
2119
|
* list of environment provisioned resources.</p>
|
|
1838
2120
|
*/
|
|
1839
2121
|
nextToken?: string;
|
|
1840
2122
|
/**
|
|
2123
|
+
* @public
|
|
1841
2124
|
* <p>An array of environment provisioned resources.</p>
|
|
1842
2125
|
*/
|
|
1843
2126
|
provisionedResources: ProvisionedResource[] | undefined;
|
|
@@ -1847,37 +2130,45 @@ export interface ListEnvironmentProvisionedResourcesOutput {
|
|
|
1847
2130
|
*/
|
|
1848
2131
|
export interface CreateEnvironmentInput {
|
|
1849
2132
|
/**
|
|
2133
|
+
* @public
|
|
1850
2134
|
* <p>The name of the environment.</p>
|
|
1851
2135
|
*/
|
|
1852
2136
|
name: string | undefined;
|
|
1853
2137
|
/**
|
|
2138
|
+
* @public
|
|
1854
2139
|
* <p>The name of the environment template. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Environment Templates</a> in the <i>Proton User Guide</i>.</p>
|
|
1855
2140
|
*/
|
|
1856
2141
|
templateName: string | undefined;
|
|
1857
2142
|
/**
|
|
2143
|
+
* @public
|
|
1858
2144
|
* <p>The major version of the environment template.</p>
|
|
1859
2145
|
*/
|
|
1860
2146
|
templateMajorVersion: string | undefined;
|
|
1861
2147
|
/**
|
|
2148
|
+
* @public
|
|
1862
2149
|
* <p>The minor version of the environment template.</p>
|
|
1863
2150
|
*/
|
|
1864
2151
|
templateMinorVersion?: string;
|
|
1865
2152
|
/**
|
|
2153
|
+
* @public
|
|
1866
2154
|
* <p>A description of the environment that's being created and deployed.</p>
|
|
1867
2155
|
*/
|
|
1868
2156
|
description?: string;
|
|
1869
2157
|
/**
|
|
2158
|
+
* @public
|
|
1870
2159
|
* <p>A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> in the <i>Proton User
|
|
1871
2160
|
* Guide</i>.</p>
|
|
1872
2161
|
*/
|
|
1873
2162
|
spec: string | undefined;
|
|
1874
2163
|
/**
|
|
2164
|
+
* @public
|
|
1875
2165
|
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</p>
|
|
1876
2166
|
* <p>To use Amazon Web Services-managed provisioning for the environment, specify either the <code>environmentAccountConnectionId</code> or
|
|
1877
2167
|
* <code>protonServiceRoleArn</code> parameter and omit the <code>provisioningRepository</code> parameter.</p>
|
|
1878
2168
|
*/
|
|
1879
2169
|
protonServiceRoleArn?: string;
|
|
1880
2170
|
/**
|
|
2171
|
+
* @public
|
|
1881
2172
|
* <p>The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment
|
|
1882
2173
|
* account. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
1883
2174
|
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
@@ -1886,12 +2177,14 @@ export interface CreateEnvironmentInput {
|
|
|
1886
2177
|
*/
|
|
1887
2178
|
environmentAccountConnectionId?: string;
|
|
1888
2179
|
/**
|
|
2180
|
+
* @public
|
|
1889
2181
|
* <p>An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.</p>
|
|
1890
2182
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
1891
2183
|
* <i>Proton User Guide</i>.</p>
|
|
1892
2184
|
*/
|
|
1893
2185
|
tags?: Tag[];
|
|
1894
2186
|
/**
|
|
2187
|
+
* @public
|
|
1895
2188
|
* <p>The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository
|
|
1896
2189
|
* that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
1897
2190
|
* <p>To use self-managed provisioning for the environment, specify this parameter and omit the <code>environmentAccountConnectionId</code> and
|
|
@@ -1899,6 +2192,7 @@ export interface CreateEnvironmentInput {
|
|
|
1899
2192
|
*/
|
|
1900
2193
|
provisioningRepository?: RepositoryBranchInput;
|
|
1901
2194
|
/**
|
|
2195
|
+
* @public
|
|
1902
2196
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
1903
2197
|
* determines the scope of infrastructure that a component can provision.</p>
|
|
1904
2198
|
* <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with this environment.</p>
|
|
@@ -1908,6 +2202,7 @@ export interface CreateEnvironmentInput {
|
|
|
1908
2202
|
*/
|
|
1909
2203
|
componentRoleArn?: string;
|
|
1910
2204
|
/**
|
|
2205
|
+
* @public
|
|
1911
2206
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your
|
|
1912
2207
|
* behalf.</p>
|
|
1913
2208
|
* <p>To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the
|
|
@@ -1920,6 +2215,7 @@ export interface CreateEnvironmentInput {
|
|
|
1920
2215
|
*/
|
|
1921
2216
|
export interface CreateEnvironmentOutput {
|
|
1922
2217
|
/**
|
|
2218
|
+
* @public
|
|
1923
2219
|
* <p>The environment detail data that's returned by Proton.</p>
|
|
1924
2220
|
*/
|
|
1925
2221
|
environment: Environment | undefined;
|
|
@@ -1929,6 +2225,7 @@ export interface CreateEnvironmentOutput {
|
|
|
1929
2225
|
*/
|
|
1930
2226
|
export interface DeleteEnvironmentInput {
|
|
1931
2227
|
/**
|
|
2228
|
+
* @public
|
|
1932
2229
|
* <p>The name of the environment to delete.</p>
|
|
1933
2230
|
*/
|
|
1934
2231
|
name: string | undefined;
|
|
@@ -1938,6 +2235,7 @@ export interface DeleteEnvironmentInput {
|
|
|
1938
2235
|
*/
|
|
1939
2236
|
export interface DeleteEnvironmentOutput {
|
|
1940
2237
|
/**
|
|
2238
|
+
* @public
|
|
1941
2239
|
* <p>The detailed data of the environment being deleted.</p>
|
|
1942
2240
|
*/
|
|
1943
2241
|
environment?: Environment;
|
|
@@ -1947,6 +2245,7 @@ export interface DeleteEnvironmentOutput {
|
|
|
1947
2245
|
*/
|
|
1948
2246
|
export interface GetEnvironmentInput {
|
|
1949
2247
|
/**
|
|
2248
|
+
* @public
|
|
1950
2249
|
* <p>The name of the environment that you want to get the detailed data for.</p>
|
|
1951
2250
|
*/
|
|
1952
2251
|
name: string | undefined;
|
|
@@ -1956,6 +2255,7 @@ export interface GetEnvironmentInput {
|
|
|
1956
2255
|
*/
|
|
1957
2256
|
export interface GetEnvironmentOutput {
|
|
1958
2257
|
/**
|
|
2258
|
+
* @public
|
|
1959
2259
|
* <p>The detailed data of the requested environment.</p>
|
|
1960
2260
|
*/
|
|
1961
2261
|
environment: Environment | undefined;
|
|
@@ -1966,10 +2266,12 @@ export interface GetEnvironmentOutput {
|
|
|
1966
2266
|
*/
|
|
1967
2267
|
export interface EnvironmentTemplateFilter {
|
|
1968
2268
|
/**
|
|
2269
|
+
* @public
|
|
1969
2270
|
* <p>Include <code>templateName</code> to filter search for a template name.</p>
|
|
1970
2271
|
*/
|
|
1971
2272
|
templateName: string | undefined;
|
|
1972
2273
|
/**
|
|
2274
|
+
* @public
|
|
1973
2275
|
* <p>Include <code>majorVersion</code> to filter search for a major version.</p>
|
|
1974
2276
|
*/
|
|
1975
2277
|
majorVersion: string | undefined;
|
|
@@ -1979,15 +2281,18 @@ export interface EnvironmentTemplateFilter {
|
|
|
1979
2281
|
*/
|
|
1980
2282
|
export interface ListEnvironmentsInput {
|
|
1981
2283
|
/**
|
|
2284
|
+
* @public
|
|
1982
2285
|
* <p>A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously
|
|
1983
2286
|
* requested.</p>
|
|
1984
2287
|
*/
|
|
1985
2288
|
nextToken?: string;
|
|
1986
2289
|
/**
|
|
2290
|
+
* @public
|
|
1987
2291
|
* <p>The maximum number of environments to list.</p>
|
|
1988
2292
|
*/
|
|
1989
2293
|
maxResults?: number;
|
|
1990
2294
|
/**
|
|
2295
|
+
* @public
|
|
1991
2296
|
* <p>An array of the versions of the environment template.</p>
|
|
1992
2297
|
*/
|
|
1993
2298
|
environmentTemplates?: EnvironmentTemplateFilter[];
|
|
@@ -1998,66 +2303,82 @@ export interface ListEnvironmentsInput {
|
|
|
1998
2303
|
*/
|
|
1999
2304
|
export interface EnvironmentSummary {
|
|
2000
2305
|
/**
|
|
2306
|
+
* @public
|
|
2001
2307
|
* <p>The name of the environment.</p>
|
|
2002
2308
|
*/
|
|
2003
2309
|
name: string | undefined;
|
|
2004
2310
|
/**
|
|
2311
|
+
* @public
|
|
2005
2312
|
* <p>The description of the environment.</p>
|
|
2006
2313
|
*/
|
|
2007
2314
|
description?: string;
|
|
2008
2315
|
/**
|
|
2316
|
+
* @public
|
|
2009
2317
|
* <p>The time when the environment was created.</p>
|
|
2010
2318
|
*/
|
|
2011
2319
|
createdAt: Date | undefined;
|
|
2012
2320
|
/**
|
|
2321
|
+
* @public
|
|
2013
2322
|
* <p>The time when a deployment of the environment was last attempted.</p>
|
|
2014
2323
|
*/
|
|
2015
2324
|
lastDeploymentAttemptedAt: Date | undefined;
|
|
2016
2325
|
/**
|
|
2326
|
+
* @public
|
|
2017
2327
|
* <p>The time when the environment was last deployed successfully.</p>
|
|
2018
2328
|
*/
|
|
2019
2329
|
lastDeploymentSucceededAt: Date | undefined;
|
|
2020
2330
|
/**
|
|
2331
|
+
* @public
|
|
2021
2332
|
* <p>The Amazon Resource Name (ARN) of the environment.</p>
|
|
2022
2333
|
*/
|
|
2023
2334
|
arn: string | undefined;
|
|
2024
2335
|
/**
|
|
2336
|
+
* @public
|
|
2025
2337
|
* <p>The name of the environment template.</p>
|
|
2026
2338
|
*/
|
|
2027
2339
|
templateName: string | undefined;
|
|
2028
2340
|
/**
|
|
2341
|
+
* @public
|
|
2029
2342
|
* <p>The major version of the environment template.</p>
|
|
2030
2343
|
*/
|
|
2031
2344
|
templateMajorVersion: string | undefined;
|
|
2032
2345
|
/**
|
|
2346
|
+
* @public
|
|
2033
2347
|
* <p>The minor version of the environment template.</p>
|
|
2034
2348
|
*/
|
|
2035
2349
|
templateMinorVersion: string | undefined;
|
|
2036
2350
|
/**
|
|
2351
|
+
* @public
|
|
2037
2352
|
* <p>The environment deployment status.</p>
|
|
2038
2353
|
*/
|
|
2039
2354
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
2040
2355
|
/**
|
|
2356
|
+
* @public
|
|
2041
2357
|
* <p>An environment deployment status message.</p>
|
|
2042
2358
|
*/
|
|
2043
2359
|
deploymentStatusMessage?: string;
|
|
2044
2360
|
/**
|
|
2361
|
+
* @public
|
|
2045
2362
|
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</p>
|
|
2046
2363
|
*/
|
|
2047
2364
|
protonServiceRoleArn?: string;
|
|
2048
2365
|
/**
|
|
2366
|
+
* @public
|
|
2049
2367
|
* <p>The ID of the environment account connection that the environment is associated with.</p>
|
|
2050
2368
|
*/
|
|
2051
2369
|
environmentAccountConnectionId?: string;
|
|
2052
2370
|
/**
|
|
2371
|
+
* @public
|
|
2053
2372
|
* <p>The ID of the environment account that the environment infrastructure resources are provisioned in.</p>
|
|
2054
2373
|
*/
|
|
2055
2374
|
environmentAccountId?: string;
|
|
2056
2375
|
/**
|
|
2376
|
+
* @public
|
|
2057
2377
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
2058
2378
|
*/
|
|
2059
2379
|
provisioning?: Provisioning | string;
|
|
2060
2380
|
/**
|
|
2381
|
+
* @public
|
|
2061
2382
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
2062
2383
|
* determines the scope of infrastructure that a component can provision.</p>
|
|
2063
2384
|
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
@@ -2067,10 +2388,12 @@ export interface EnvironmentSummary {
|
|
|
2067
2388
|
*/
|
|
2068
2389
|
componentRoleArn?: string;
|
|
2069
2390
|
/**
|
|
2391
|
+
* @public
|
|
2070
2392
|
* <p>The ID of the last attempted deployment of this environment.</p>
|
|
2071
2393
|
*/
|
|
2072
2394
|
lastAttemptedDeploymentId?: string;
|
|
2073
2395
|
/**
|
|
2396
|
+
* @public
|
|
2074
2397
|
* <p>The ID of the last successful deployment of this environment.</p>
|
|
2075
2398
|
*/
|
|
2076
2399
|
lastSucceededDeploymentId?: string;
|
|
@@ -2080,10 +2403,12 @@ export interface EnvironmentSummary {
|
|
|
2080
2403
|
*/
|
|
2081
2404
|
export interface ListEnvironmentsOutput {
|
|
2082
2405
|
/**
|
|
2406
|
+
* @public
|
|
2083
2407
|
* <p>A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.</p>
|
|
2084
2408
|
*/
|
|
2085
2409
|
nextToken?: string;
|
|
2086
2410
|
/**
|
|
2411
|
+
* @public
|
|
2087
2412
|
* <p>An array of environment detail data summaries.</p>
|
|
2088
2413
|
*/
|
|
2089
2414
|
environments: EnvironmentSummary[] | undefined;
|
|
@@ -2107,30 +2432,37 @@ export type DeploymentUpdateType = (typeof DeploymentUpdateType)[keyof typeof De
|
|
|
2107
2432
|
*/
|
|
2108
2433
|
export interface UpdateEnvironmentInput {
|
|
2109
2434
|
/**
|
|
2435
|
+
* @public
|
|
2110
2436
|
* <p>The name of the environment to update.</p>
|
|
2111
2437
|
*/
|
|
2112
2438
|
name: string | undefined;
|
|
2113
2439
|
/**
|
|
2440
|
+
* @public
|
|
2114
2441
|
* <p>A description of the environment update.</p>
|
|
2115
2442
|
*/
|
|
2116
2443
|
description?: string;
|
|
2117
2444
|
/**
|
|
2445
|
+
* @public
|
|
2118
2446
|
* <p>The formatted specification that defines the update.</p>
|
|
2119
2447
|
*/
|
|
2120
2448
|
spec?: string;
|
|
2121
2449
|
/**
|
|
2450
|
+
* @public
|
|
2122
2451
|
* <p>The major version of the environment to update.</p>
|
|
2123
2452
|
*/
|
|
2124
2453
|
templateMajorVersion?: string;
|
|
2125
2454
|
/**
|
|
2455
|
+
* @public
|
|
2126
2456
|
* <p>The minor version of the environment to update.</p>
|
|
2127
2457
|
*/
|
|
2128
2458
|
templateMinorVersion?: string;
|
|
2129
2459
|
/**
|
|
2460
|
+
* @public
|
|
2130
2461
|
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</p>
|
|
2131
2462
|
*/
|
|
2132
2463
|
protonServiceRoleArn?: string;
|
|
2133
2464
|
/**
|
|
2465
|
+
* @public
|
|
2134
2466
|
* <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
|
|
2135
2467
|
* <dl>
|
|
2136
2468
|
* <dt/>
|
|
@@ -2168,17 +2500,20 @@ export interface UpdateEnvironmentInput {
|
|
|
2168
2500
|
*/
|
|
2169
2501
|
deploymentType: DeploymentUpdateType | string | undefined;
|
|
2170
2502
|
/**
|
|
2503
|
+
* @public
|
|
2171
2504
|
* <p>The ID of the environment account connection.</p>
|
|
2172
2505
|
* <p>You can only update to a new environment account connection if it was created in the same environment account that the current environment account
|
|
2173
2506
|
* connection was created in and is associated with the current environment.</p>
|
|
2174
2507
|
*/
|
|
2175
2508
|
environmentAccountConnectionId?: string;
|
|
2176
2509
|
/**
|
|
2510
|
+
* @public
|
|
2177
2511
|
* <p>The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository
|
|
2178
2512
|
* that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
2179
2513
|
*/
|
|
2180
2514
|
provisioningRepository?: RepositoryBranchInput;
|
|
2181
2515
|
/**
|
|
2516
|
+
* @public
|
|
2182
2517
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
2183
2518
|
* determines the scope of infrastructure that a component can provision.</p>
|
|
2184
2519
|
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
@@ -2188,6 +2523,7 @@ export interface UpdateEnvironmentInput {
|
|
|
2188
2523
|
*/
|
|
2189
2524
|
componentRoleArn?: string;
|
|
2190
2525
|
/**
|
|
2526
|
+
* @public
|
|
2191
2527
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your
|
|
2192
2528
|
* behalf.</p>
|
|
2193
2529
|
*/
|
|
@@ -2198,6 +2534,7 @@ export interface UpdateEnvironmentInput {
|
|
|
2198
2534
|
*/
|
|
2199
2535
|
export interface UpdateEnvironmentOutput {
|
|
2200
2536
|
/**
|
|
2537
|
+
* @public
|
|
2201
2538
|
* <p>The environment detail data that's returned by Proton.</p>
|
|
2202
2539
|
*/
|
|
2203
2540
|
environment: Environment | undefined;
|
|
@@ -2207,26 +2544,32 @@ export interface UpdateEnvironmentOutput {
|
|
|
2207
2544
|
*/
|
|
2208
2545
|
export interface CreateEnvironmentTemplateInput {
|
|
2209
2546
|
/**
|
|
2547
|
+
* @public
|
|
2210
2548
|
* <p>The name of the environment template.</p>
|
|
2211
2549
|
*/
|
|
2212
2550
|
name: string | undefined;
|
|
2213
2551
|
/**
|
|
2552
|
+
* @public
|
|
2214
2553
|
* <p>The environment template name as displayed in the developer interface.</p>
|
|
2215
2554
|
*/
|
|
2216
2555
|
displayName?: string;
|
|
2217
2556
|
/**
|
|
2557
|
+
* @public
|
|
2218
2558
|
* <p>A description of the environment template.</p>
|
|
2219
2559
|
*/
|
|
2220
2560
|
description?: string;
|
|
2221
2561
|
/**
|
|
2562
|
+
* @public
|
|
2222
2563
|
* <p>A customer provided encryption key that Proton uses to encrypt data.</p>
|
|
2223
2564
|
*/
|
|
2224
2565
|
encryptionKey?: string;
|
|
2225
2566
|
/**
|
|
2567
|
+
* @public
|
|
2226
2568
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
2227
2569
|
*/
|
|
2228
2570
|
provisioning?: Provisioning | string;
|
|
2229
2571
|
/**
|
|
2572
|
+
* @public
|
|
2230
2573
|
* <p>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</p>
|
|
2231
2574
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
2232
2575
|
* <i>Proton User Guide</i>.</p>
|
|
@@ -2239,38 +2582,47 @@ export interface CreateEnvironmentTemplateInput {
|
|
|
2239
2582
|
*/
|
|
2240
2583
|
export interface EnvironmentTemplate {
|
|
2241
2584
|
/**
|
|
2585
|
+
* @public
|
|
2242
2586
|
* <p>The name of the environment template.</p>
|
|
2243
2587
|
*/
|
|
2244
2588
|
name: string | undefined;
|
|
2245
2589
|
/**
|
|
2590
|
+
* @public
|
|
2246
2591
|
* <p>The Amazon Resource Name (ARN) of the environment template.</p>
|
|
2247
2592
|
*/
|
|
2248
2593
|
arn: string | undefined;
|
|
2249
2594
|
/**
|
|
2595
|
+
* @public
|
|
2250
2596
|
* <p>The time when the environment template was created.</p>
|
|
2251
2597
|
*/
|
|
2252
2598
|
createdAt: Date | undefined;
|
|
2253
2599
|
/**
|
|
2600
|
+
* @public
|
|
2254
2601
|
* <p>The time when the environment template was last modified.</p>
|
|
2255
2602
|
*/
|
|
2256
2603
|
lastModifiedAt: Date | undefined;
|
|
2257
2604
|
/**
|
|
2605
|
+
* @public
|
|
2258
2606
|
* <p>The name of the environment template as displayed in the developer interface.</p>
|
|
2259
2607
|
*/
|
|
2260
2608
|
displayName?: string;
|
|
2261
2609
|
/**
|
|
2610
|
+
* @public
|
|
2262
2611
|
* <p>A description of the environment template.</p>
|
|
2263
2612
|
*/
|
|
2264
2613
|
description?: string;
|
|
2265
2614
|
/**
|
|
2615
|
+
* @public
|
|
2266
2616
|
* <p>The ID of the recommended version of the environment template.</p>
|
|
2267
2617
|
*/
|
|
2268
2618
|
recommendedVersion?: string;
|
|
2269
2619
|
/**
|
|
2620
|
+
* @public
|
|
2270
2621
|
* <p>The customer provided encryption key for the environment template.</p>
|
|
2271
2622
|
*/
|
|
2272
2623
|
encryptionKey?: string;
|
|
2273
2624
|
/**
|
|
2625
|
+
* @public
|
|
2274
2626
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
2275
2627
|
*/
|
|
2276
2628
|
provisioning?: Provisioning | string;
|
|
@@ -2280,6 +2632,7 @@ export interface EnvironmentTemplate {
|
|
|
2280
2632
|
*/
|
|
2281
2633
|
export interface CreateEnvironmentTemplateOutput {
|
|
2282
2634
|
/**
|
|
2635
|
+
* @public
|
|
2283
2636
|
* <p>The environment template detail data that's returned by Proton.</p>
|
|
2284
2637
|
*/
|
|
2285
2638
|
environmentTemplate: EnvironmentTemplate | undefined;
|
|
@@ -2289,6 +2642,7 @@ export interface CreateEnvironmentTemplateOutput {
|
|
|
2289
2642
|
*/
|
|
2290
2643
|
export interface DeleteEnvironmentTemplateInput {
|
|
2291
2644
|
/**
|
|
2645
|
+
* @public
|
|
2292
2646
|
* <p>The name of the environment template to delete.</p>
|
|
2293
2647
|
*/
|
|
2294
2648
|
name: string | undefined;
|
|
@@ -2298,6 +2652,7 @@ export interface DeleteEnvironmentTemplateInput {
|
|
|
2298
2652
|
*/
|
|
2299
2653
|
export interface DeleteEnvironmentTemplateOutput {
|
|
2300
2654
|
/**
|
|
2655
|
+
* @public
|
|
2301
2656
|
* <p>The detailed data of the environment template being deleted.</p>
|
|
2302
2657
|
*/
|
|
2303
2658
|
environmentTemplate?: EnvironmentTemplate;
|
|
@@ -2307,6 +2662,7 @@ export interface DeleteEnvironmentTemplateOutput {
|
|
|
2307
2662
|
*/
|
|
2308
2663
|
export interface GetEnvironmentTemplateInput {
|
|
2309
2664
|
/**
|
|
2665
|
+
* @public
|
|
2310
2666
|
* <p>The name of the environment template that you want to get the detailed data for.</p>
|
|
2311
2667
|
*/
|
|
2312
2668
|
name: string | undefined;
|
|
@@ -2316,6 +2672,7 @@ export interface GetEnvironmentTemplateInput {
|
|
|
2316
2672
|
*/
|
|
2317
2673
|
export interface GetEnvironmentTemplateOutput {
|
|
2318
2674
|
/**
|
|
2675
|
+
* @public
|
|
2319
2676
|
* <p>The detailed data of the requested environment template.</p>
|
|
2320
2677
|
*/
|
|
2321
2678
|
environmentTemplate: EnvironmentTemplate | undefined;
|
|
@@ -2325,11 +2682,13 @@ export interface GetEnvironmentTemplateOutput {
|
|
|
2325
2682
|
*/
|
|
2326
2683
|
export interface ListEnvironmentTemplatesInput {
|
|
2327
2684
|
/**
|
|
2685
|
+
* @public
|
|
2328
2686
|
* <p>A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates
|
|
2329
2687
|
* that was previously requested.</p>
|
|
2330
2688
|
*/
|
|
2331
2689
|
nextToken?: string;
|
|
2332
2690
|
/**
|
|
2691
|
+
* @public
|
|
2333
2692
|
* <p>The maximum number of environment templates to list.</p>
|
|
2334
2693
|
*/
|
|
2335
2694
|
maxResults?: number;
|
|
@@ -2340,34 +2699,42 @@ export interface ListEnvironmentTemplatesInput {
|
|
|
2340
2699
|
*/
|
|
2341
2700
|
export interface EnvironmentTemplateSummary {
|
|
2342
2701
|
/**
|
|
2702
|
+
* @public
|
|
2343
2703
|
* <p>The name of the environment template.</p>
|
|
2344
2704
|
*/
|
|
2345
2705
|
name: string | undefined;
|
|
2346
2706
|
/**
|
|
2707
|
+
* @public
|
|
2347
2708
|
* <p>The Amazon Resource Name (ARN) of the environment template.</p>
|
|
2348
2709
|
*/
|
|
2349
2710
|
arn: string | undefined;
|
|
2350
2711
|
/**
|
|
2712
|
+
* @public
|
|
2351
2713
|
* <p>The time when the environment template was created.</p>
|
|
2352
2714
|
*/
|
|
2353
2715
|
createdAt: Date | undefined;
|
|
2354
2716
|
/**
|
|
2717
|
+
* @public
|
|
2355
2718
|
* <p>The time when the environment template was last modified.</p>
|
|
2356
2719
|
*/
|
|
2357
2720
|
lastModifiedAt: Date | undefined;
|
|
2358
2721
|
/**
|
|
2722
|
+
* @public
|
|
2359
2723
|
* <p>The name of the environment template as displayed in the developer interface.</p>
|
|
2360
2724
|
*/
|
|
2361
2725
|
displayName?: string;
|
|
2362
2726
|
/**
|
|
2727
|
+
* @public
|
|
2363
2728
|
* <p>A description of the environment template.</p>
|
|
2364
2729
|
*/
|
|
2365
2730
|
description?: string;
|
|
2366
2731
|
/**
|
|
2732
|
+
* @public
|
|
2367
2733
|
* <p>The recommended version of the environment template.</p>
|
|
2368
2734
|
*/
|
|
2369
2735
|
recommendedVersion?: string;
|
|
2370
2736
|
/**
|
|
2737
|
+
* @public
|
|
2371
2738
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
2372
2739
|
*/
|
|
2373
2740
|
provisioning?: Provisioning | string;
|
|
@@ -2377,11 +2744,13 @@ export interface EnvironmentTemplateSummary {
|
|
|
2377
2744
|
*/
|
|
2378
2745
|
export interface ListEnvironmentTemplatesOutput {
|
|
2379
2746
|
/**
|
|
2747
|
+
* @public
|
|
2380
2748
|
* <p>A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of
|
|
2381
2749
|
* environment templates.</p>
|
|
2382
2750
|
*/
|
|
2383
2751
|
nextToken?: string;
|
|
2384
2752
|
/**
|
|
2753
|
+
* @public
|
|
2385
2754
|
* <p>An array of environment templates with detail data.</p>
|
|
2386
2755
|
*/
|
|
2387
2756
|
templates: EnvironmentTemplateSummary[] | undefined;
|
|
@@ -2391,14 +2760,17 @@ export interface ListEnvironmentTemplatesOutput {
|
|
|
2391
2760
|
*/
|
|
2392
2761
|
export interface UpdateEnvironmentTemplateInput {
|
|
2393
2762
|
/**
|
|
2763
|
+
* @public
|
|
2394
2764
|
* <p>The name of the environment template to update.</p>
|
|
2395
2765
|
*/
|
|
2396
2766
|
name: string | undefined;
|
|
2397
2767
|
/**
|
|
2768
|
+
* @public
|
|
2398
2769
|
* <p>The name of the environment template to update as displayed in the developer interface.</p>
|
|
2399
2770
|
*/
|
|
2400
2771
|
displayName?: string;
|
|
2401
2772
|
/**
|
|
2773
|
+
* @public
|
|
2402
2774
|
* <p>A description of the environment template update.</p>
|
|
2403
2775
|
*/
|
|
2404
2776
|
description?: string;
|
|
@@ -2408,6 +2780,7 @@ export interface UpdateEnvironmentTemplateInput {
|
|
|
2408
2780
|
*/
|
|
2409
2781
|
export interface UpdateEnvironmentTemplateOutput {
|
|
2410
2782
|
/**
|
|
2783
|
+
* @public
|
|
2411
2784
|
* <p>The environment template detail data that's returned by Proton.</p>
|
|
2412
2785
|
*/
|
|
2413
2786
|
environmentTemplate: EnvironmentTemplate | undefined;
|
|
@@ -2418,10 +2791,12 @@ export interface UpdateEnvironmentTemplateOutput {
|
|
|
2418
2791
|
*/
|
|
2419
2792
|
export interface S3ObjectSource {
|
|
2420
2793
|
/**
|
|
2794
|
+
* @public
|
|
2421
2795
|
* <p>The name of the S3 bucket that contains a template bundle.</p>
|
|
2422
2796
|
*/
|
|
2423
2797
|
bucket: string | undefined;
|
|
2424
2798
|
/**
|
|
2799
|
+
* @public
|
|
2425
2800
|
* <p>The path to the S3 bucket that contains a template bundle.</p>
|
|
2426
2801
|
*/
|
|
2427
2802
|
key: string | undefined;
|
|
@@ -2436,12 +2811,16 @@ export type TemplateVersionSourceInput = TemplateVersionSourceInput.S3Member | T
|
|
|
2436
2811
|
*/
|
|
2437
2812
|
export declare namespace TemplateVersionSourceInput {
|
|
2438
2813
|
/**
|
|
2814
|
+
* @public
|
|
2439
2815
|
* <p>An S3 source object that includes the template bundle S3 path and name for a template minor version.</p>
|
|
2440
2816
|
*/
|
|
2441
2817
|
interface S3Member {
|
|
2442
2818
|
s3: S3ObjectSource;
|
|
2443
2819
|
$unknown?: never;
|
|
2444
2820
|
}
|
|
2821
|
+
/**
|
|
2822
|
+
* @public
|
|
2823
|
+
*/
|
|
2445
2824
|
interface $UnknownMember {
|
|
2446
2825
|
s3?: never;
|
|
2447
2826
|
$unknown: [string, any];
|
|
@@ -2457,28 +2836,34 @@ export declare namespace TemplateVersionSourceInput {
|
|
|
2457
2836
|
*/
|
|
2458
2837
|
export interface CreateEnvironmentTemplateVersionInput {
|
|
2459
2838
|
/**
|
|
2839
|
+
* @public
|
|
2460
2840
|
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first
|
|
2461
2841
|
* request created.</p>
|
|
2462
2842
|
*/
|
|
2463
2843
|
clientToken?: string;
|
|
2464
2844
|
/**
|
|
2845
|
+
* @public
|
|
2465
2846
|
* <p>The name of the environment template.</p>
|
|
2466
2847
|
*/
|
|
2467
2848
|
templateName: string | undefined;
|
|
2468
2849
|
/**
|
|
2850
|
+
* @public
|
|
2469
2851
|
* <p>A description of the new version of an environment template.</p>
|
|
2470
2852
|
*/
|
|
2471
2853
|
description?: string;
|
|
2472
2854
|
/**
|
|
2855
|
+
* @public
|
|
2473
2856
|
* <p>To create a new minor version of the environment template, include <code>major Version</code>.</p>
|
|
2474
2857
|
* <p>To create a new major and minor version of the environment template, exclude <code>major Version</code>.</p>
|
|
2475
2858
|
*/
|
|
2476
2859
|
majorVersion?: string;
|
|
2477
2860
|
/**
|
|
2861
|
+
* @public
|
|
2478
2862
|
* <p>An object that includes the template bundle S3 bucket path and name for the new version of an template.</p>
|
|
2479
2863
|
*/
|
|
2480
2864
|
source: TemplateVersionSourceInput | undefined;
|
|
2481
2865
|
/**
|
|
2866
|
+
* @public
|
|
2482
2867
|
* <p>An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.</p>
|
|
2483
2868
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
2484
2869
|
* <i>Proton User Guide</i>.</p>
|
|
@@ -2505,46 +2890,57 @@ export type TemplateVersionStatus = (typeof TemplateVersionStatus)[keyof typeof
|
|
|
2505
2890
|
*/
|
|
2506
2891
|
export interface EnvironmentTemplateVersion {
|
|
2507
2892
|
/**
|
|
2893
|
+
* @public
|
|
2508
2894
|
* <p>The name of the version of an environment template.</p>
|
|
2509
2895
|
*/
|
|
2510
2896
|
templateName: string | undefined;
|
|
2511
2897
|
/**
|
|
2898
|
+
* @public
|
|
2512
2899
|
* <p>The latest major version that's associated with the version of an environment template.</p>
|
|
2513
2900
|
*/
|
|
2514
2901
|
majorVersion: string | undefined;
|
|
2515
2902
|
/**
|
|
2903
|
+
* @public
|
|
2516
2904
|
* <p>The minor version of an environment template.</p>
|
|
2517
2905
|
*/
|
|
2518
2906
|
minorVersion: string | undefined;
|
|
2519
2907
|
/**
|
|
2908
|
+
* @public
|
|
2520
2909
|
* <p>The recommended minor version of the environment template.</p>
|
|
2521
2910
|
*/
|
|
2522
2911
|
recommendedMinorVersion?: string;
|
|
2523
2912
|
/**
|
|
2913
|
+
* @public
|
|
2524
2914
|
* <p>The status of the version of an environment template.</p>
|
|
2525
2915
|
*/
|
|
2526
2916
|
status: TemplateVersionStatus | string | undefined;
|
|
2527
2917
|
/**
|
|
2918
|
+
* @public
|
|
2528
2919
|
* <p>The status message of the version of an environment template.</p>
|
|
2529
2920
|
*/
|
|
2530
2921
|
statusMessage?: string;
|
|
2531
2922
|
/**
|
|
2923
|
+
* @public
|
|
2532
2924
|
* <p>A description of the minor version of an environment template.</p>
|
|
2533
2925
|
*/
|
|
2534
2926
|
description?: string;
|
|
2535
2927
|
/**
|
|
2928
|
+
* @public
|
|
2536
2929
|
* <p>The Amazon Resource Name (ARN) of the version of an environment template.</p>
|
|
2537
2930
|
*/
|
|
2538
2931
|
arn: string | undefined;
|
|
2539
2932
|
/**
|
|
2933
|
+
* @public
|
|
2540
2934
|
* <p>The time when the version of an environment template was created.</p>
|
|
2541
2935
|
*/
|
|
2542
2936
|
createdAt: Date | undefined;
|
|
2543
2937
|
/**
|
|
2938
|
+
* @public
|
|
2544
2939
|
* <p>The time when the version of an environment template was last modified.</p>
|
|
2545
2940
|
*/
|
|
2546
2941
|
lastModifiedAt: Date | undefined;
|
|
2547
2942
|
/**
|
|
2943
|
+
* @public
|
|
2548
2944
|
* <p>The schema of the version of an environment template.</p>
|
|
2549
2945
|
*/
|
|
2550
2946
|
schema?: string;
|
|
@@ -2554,6 +2950,7 @@ export interface EnvironmentTemplateVersion {
|
|
|
2554
2950
|
*/
|
|
2555
2951
|
export interface CreateEnvironmentTemplateVersionOutput {
|
|
2556
2952
|
/**
|
|
2953
|
+
* @public
|
|
2557
2954
|
* <p>The environment template detail data that's returned by Proton.</p>
|
|
2558
2955
|
*/
|
|
2559
2956
|
environmentTemplateVersion: EnvironmentTemplateVersion | undefined;
|
|
@@ -2563,14 +2960,17 @@ export interface CreateEnvironmentTemplateVersionOutput {
|
|
|
2563
2960
|
*/
|
|
2564
2961
|
export interface DeleteEnvironmentTemplateVersionInput {
|
|
2565
2962
|
/**
|
|
2963
|
+
* @public
|
|
2566
2964
|
* <p>The name of the environment template.</p>
|
|
2567
2965
|
*/
|
|
2568
2966
|
templateName: string | undefined;
|
|
2569
2967
|
/**
|
|
2968
|
+
* @public
|
|
2570
2969
|
* <p>The environment template major version to delete.</p>
|
|
2571
2970
|
*/
|
|
2572
2971
|
majorVersion: string | undefined;
|
|
2573
2972
|
/**
|
|
2973
|
+
* @public
|
|
2574
2974
|
* <p>The environment template minor version to delete.</p>
|
|
2575
2975
|
*/
|
|
2576
2976
|
minorVersion: string | undefined;
|
|
@@ -2580,6 +2980,7 @@ export interface DeleteEnvironmentTemplateVersionInput {
|
|
|
2580
2980
|
*/
|
|
2581
2981
|
export interface DeleteEnvironmentTemplateVersionOutput {
|
|
2582
2982
|
/**
|
|
2983
|
+
* @public
|
|
2583
2984
|
* <p>The detailed data of the environment template version being deleted.</p>
|
|
2584
2985
|
*/
|
|
2585
2986
|
environmentTemplateVersion?: EnvironmentTemplateVersion;
|
|
@@ -2589,14 +2990,17 @@ export interface DeleteEnvironmentTemplateVersionOutput {
|
|
|
2589
2990
|
*/
|
|
2590
2991
|
export interface GetEnvironmentTemplateVersionInput {
|
|
2591
2992
|
/**
|
|
2993
|
+
* @public
|
|
2592
2994
|
* <p>The name of the environment template a version of which you want to get detailed data for.</p>
|
|
2593
2995
|
*/
|
|
2594
2996
|
templateName: string | undefined;
|
|
2595
2997
|
/**
|
|
2998
|
+
* @public
|
|
2596
2999
|
* <p>To get environment template major version detail data, include <code>major Version</code>.</p>
|
|
2597
3000
|
*/
|
|
2598
3001
|
majorVersion: string | undefined;
|
|
2599
3002
|
/**
|
|
3003
|
+
* @public
|
|
2600
3004
|
* <p>To get environment template minor version detail data, include <code>minorVersion</code>.</p>
|
|
2601
3005
|
*/
|
|
2602
3006
|
minorVersion: string | undefined;
|
|
@@ -2606,6 +3010,7 @@ export interface GetEnvironmentTemplateVersionInput {
|
|
|
2606
3010
|
*/
|
|
2607
3011
|
export interface GetEnvironmentTemplateVersionOutput {
|
|
2608
3012
|
/**
|
|
3013
|
+
* @public
|
|
2609
3014
|
* <p>The detailed data of the requested environment template version.</p>
|
|
2610
3015
|
*/
|
|
2611
3016
|
environmentTemplateVersion: EnvironmentTemplateVersion | undefined;
|
|
@@ -2615,19 +3020,23 @@ export interface GetEnvironmentTemplateVersionOutput {
|
|
|
2615
3020
|
*/
|
|
2616
3021
|
export interface ListEnvironmentTemplateVersionsInput {
|
|
2617
3022
|
/**
|
|
3023
|
+
* @public
|
|
2618
3024
|
* <p>A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the
|
|
2619
3025
|
* list of major or minor versions that was previously requested.</p>
|
|
2620
3026
|
*/
|
|
2621
3027
|
nextToken?: string;
|
|
2622
3028
|
/**
|
|
3029
|
+
* @public
|
|
2623
3030
|
* <p>The maximum number of major or minor versions of an environment template to list.</p>
|
|
2624
3031
|
*/
|
|
2625
3032
|
maxResults?: number;
|
|
2626
3033
|
/**
|
|
3034
|
+
* @public
|
|
2627
3035
|
* <p>The name of the environment template.</p>
|
|
2628
3036
|
*/
|
|
2629
3037
|
templateName: string | undefined;
|
|
2630
3038
|
/**
|
|
3039
|
+
* @public
|
|
2631
3040
|
* <p>To view a list of minor of versions under a major version of an environment template, include <code>major Version</code>.</p>
|
|
2632
3041
|
* <p>To view a list of major versions of an environment template, <i>exclude</i>
|
|
2633
3042
|
* <code>major Version</code>.</p>
|
|
@@ -2640,42 +3049,52 @@ export interface ListEnvironmentTemplateVersionsInput {
|
|
|
2640
3049
|
*/
|
|
2641
3050
|
export interface EnvironmentTemplateVersionSummary {
|
|
2642
3051
|
/**
|
|
3052
|
+
* @public
|
|
2643
3053
|
* <p>The name of the environment template.</p>
|
|
2644
3054
|
*/
|
|
2645
3055
|
templateName: string | undefined;
|
|
2646
3056
|
/**
|
|
3057
|
+
* @public
|
|
2647
3058
|
* <p>The latest major version that's associated with the version of an environment template.</p>
|
|
2648
3059
|
*/
|
|
2649
3060
|
majorVersion: string | undefined;
|
|
2650
3061
|
/**
|
|
3062
|
+
* @public
|
|
2651
3063
|
* <p>The version of an environment template.</p>
|
|
2652
3064
|
*/
|
|
2653
3065
|
minorVersion: string | undefined;
|
|
2654
3066
|
/**
|
|
3067
|
+
* @public
|
|
2655
3068
|
* <p>The recommended minor version of the environment template.</p>
|
|
2656
3069
|
*/
|
|
2657
3070
|
recommendedMinorVersion?: string;
|
|
2658
3071
|
/**
|
|
3072
|
+
* @public
|
|
2659
3073
|
* <p>The status of the version of an environment template.</p>
|
|
2660
3074
|
*/
|
|
2661
3075
|
status: TemplateVersionStatus | string | undefined;
|
|
2662
3076
|
/**
|
|
3077
|
+
* @public
|
|
2663
3078
|
* <p>The status message of the version of an environment template.</p>
|
|
2664
3079
|
*/
|
|
2665
3080
|
statusMessage?: string;
|
|
2666
3081
|
/**
|
|
3082
|
+
* @public
|
|
2667
3083
|
* <p>A description of the version of an environment template.</p>
|
|
2668
3084
|
*/
|
|
2669
3085
|
description?: string;
|
|
2670
3086
|
/**
|
|
3087
|
+
* @public
|
|
2671
3088
|
* <p>The Amazon Resource Name (ARN) of the version of an environment template.</p>
|
|
2672
3089
|
*/
|
|
2673
3090
|
arn: string | undefined;
|
|
2674
3091
|
/**
|
|
3092
|
+
* @public
|
|
2675
3093
|
* <p>The time when the version of an environment template was created.</p>
|
|
2676
3094
|
*/
|
|
2677
3095
|
createdAt: Date | undefined;
|
|
2678
3096
|
/**
|
|
3097
|
+
* @public
|
|
2679
3098
|
* <p>The time when the version of an environment template was last modified.</p>
|
|
2680
3099
|
*/
|
|
2681
3100
|
lastModifiedAt: Date | undefined;
|
|
@@ -2685,11 +3104,13 @@ export interface EnvironmentTemplateVersionSummary {
|
|
|
2685
3104
|
*/
|
|
2686
3105
|
export interface ListEnvironmentTemplateVersionsOutput {
|
|
2687
3106
|
/**
|
|
3107
|
+
* @public
|
|
2688
3108
|
* <p>A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the
|
|
2689
3109
|
* list of major or minor versions that was previously requested.</p>
|
|
2690
3110
|
*/
|
|
2691
3111
|
nextToken?: string;
|
|
2692
3112
|
/**
|
|
3113
|
+
* @public
|
|
2693
3114
|
* <p>An array of major or minor versions of an environment template detail data.</p>
|
|
2694
3115
|
*/
|
|
2695
3116
|
templateVersions: EnvironmentTemplateVersionSummary[] | undefined;
|
|
@@ -2699,22 +3120,27 @@ export interface ListEnvironmentTemplateVersionsOutput {
|
|
|
2699
3120
|
*/
|
|
2700
3121
|
export interface UpdateEnvironmentTemplateVersionInput {
|
|
2701
3122
|
/**
|
|
3123
|
+
* @public
|
|
2702
3124
|
* <p>The name of the environment template.</p>
|
|
2703
3125
|
*/
|
|
2704
3126
|
templateName: string | undefined;
|
|
2705
3127
|
/**
|
|
3128
|
+
* @public
|
|
2706
3129
|
* <p>To update a major version of an environment template, include <code>major Version</code>.</p>
|
|
2707
3130
|
*/
|
|
2708
3131
|
majorVersion: string | undefined;
|
|
2709
3132
|
/**
|
|
3133
|
+
* @public
|
|
2710
3134
|
* <p>To update a minor version of an environment template, include <code>minorVersion</code>.</p>
|
|
2711
3135
|
*/
|
|
2712
3136
|
minorVersion: string | undefined;
|
|
2713
3137
|
/**
|
|
3138
|
+
* @public
|
|
2714
3139
|
* <p>A description of environment template version to update.</p>
|
|
2715
3140
|
*/
|
|
2716
3141
|
description?: string;
|
|
2717
3142
|
/**
|
|
3143
|
+
* @public
|
|
2718
3144
|
* <p>The status of the environment template minor version to update.</p>
|
|
2719
3145
|
*/
|
|
2720
3146
|
status?: TemplateVersionStatus | string;
|
|
@@ -2724,6 +3150,7 @@ export interface UpdateEnvironmentTemplateVersionInput {
|
|
|
2724
3150
|
*/
|
|
2725
3151
|
export interface UpdateEnvironmentTemplateVersionOutput {
|
|
2726
3152
|
/**
|
|
3153
|
+
* @public
|
|
2727
3154
|
* <p>The environment template version detail data that's returned by Proton.</p>
|
|
2728
3155
|
*/
|
|
2729
3156
|
environmentTemplateVersion: EnvironmentTemplateVersion | undefined;
|
|
@@ -2753,18 +3180,22 @@ export type SyncType = (typeof SyncType)[keyof typeof SyncType];
|
|
|
2753
3180
|
*/
|
|
2754
3181
|
export interface GetRepositorySyncStatusInput {
|
|
2755
3182
|
/**
|
|
3183
|
+
* @public
|
|
2756
3184
|
* <p>The repository name.</p>
|
|
2757
3185
|
*/
|
|
2758
3186
|
repositoryName: string | undefined;
|
|
2759
3187
|
/**
|
|
3188
|
+
* @public
|
|
2760
3189
|
* <p>The repository provider.</p>
|
|
2761
3190
|
*/
|
|
2762
3191
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
2763
3192
|
/**
|
|
3193
|
+
* @public
|
|
2764
3194
|
* <p>The repository branch.</p>
|
|
2765
3195
|
*/
|
|
2766
3196
|
branch: string | undefined;
|
|
2767
3197
|
/**
|
|
3198
|
+
* @public
|
|
2768
3199
|
* <p>The repository sync type.</p>
|
|
2769
3200
|
*/
|
|
2770
3201
|
syncType: SyncType | string | undefined;
|
|
@@ -2775,18 +3206,22 @@ export interface GetRepositorySyncStatusInput {
|
|
|
2775
3206
|
*/
|
|
2776
3207
|
export interface RepositorySyncEvent {
|
|
2777
3208
|
/**
|
|
3209
|
+
* @public
|
|
2778
3210
|
* <p>The type of event.</p>
|
|
2779
3211
|
*/
|
|
2780
3212
|
type: string | undefined;
|
|
2781
3213
|
/**
|
|
3214
|
+
* @public
|
|
2782
3215
|
* <p>The external ID of the sync event.</p>
|
|
2783
3216
|
*/
|
|
2784
3217
|
externalId?: string;
|
|
2785
3218
|
/**
|
|
3219
|
+
* @public
|
|
2786
3220
|
* <p>The time that the sync event occurred.</p>
|
|
2787
3221
|
*/
|
|
2788
3222
|
time: Date | undefined;
|
|
2789
3223
|
/**
|
|
3224
|
+
* @public
|
|
2790
3225
|
* <p>Event detail for a repository sync attempt.</p>
|
|
2791
3226
|
*/
|
|
2792
3227
|
event: string | undefined;
|
|
@@ -2832,14 +3267,17 @@ export type RepositorySyncStatus = (typeof RepositorySyncStatus)[keyof typeof Re
|
|
|
2832
3267
|
*/
|
|
2833
3268
|
export interface RepositorySyncAttempt {
|
|
2834
3269
|
/**
|
|
3270
|
+
* @public
|
|
2835
3271
|
* <p>The time when the sync attempt started.</p>
|
|
2836
3272
|
*/
|
|
2837
3273
|
startedAt: Date | undefined;
|
|
2838
3274
|
/**
|
|
3275
|
+
* @public
|
|
2839
3276
|
* <p>The sync attempt status.</p>
|
|
2840
3277
|
*/
|
|
2841
3278
|
status: RepositorySyncStatus | string | undefined;
|
|
2842
3279
|
/**
|
|
3280
|
+
* @public
|
|
2843
3281
|
* <p>Detail data for sync attempt events.</p>
|
|
2844
3282
|
*/
|
|
2845
3283
|
events: RepositorySyncEvent[] | undefined;
|
|
@@ -2849,6 +3287,7 @@ export interface RepositorySyncAttempt {
|
|
|
2849
3287
|
*/
|
|
2850
3288
|
export interface GetRepositorySyncStatusOutput {
|
|
2851
3289
|
/**
|
|
3290
|
+
* @public
|
|
2852
3291
|
* <p>The repository sync status detail data that's returned by Proton.</p>
|
|
2853
3292
|
*/
|
|
2854
3293
|
latestSync?: RepositorySyncAttempt;
|
|
@@ -2864,22 +3303,27 @@ export interface GetResourcesSummaryInput {
|
|
|
2864
3303
|
*/
|
|
2865
3304
|
export interface ResourceCountsSummary {
|
|
2866
3305
|
/**
|
|
3306
|
+
* @public
|
|
2867
3307
|
* <p>The total number of resources of this type in the Amazon Web Services account.</p>
|
|
2868
3308
|
*/
|
|
2869
3309
|
total: number | undefined;
|
|
2870
3310
|
/**
|
|
3311
|
+
* @public
|
|
2871
3312
|
* <p>The number of resources of this type in the Amazon Web Services account that failed to deploy.</p>
|
|
2872
3313
|
*/
|
|
2873
3314
|
failed?: number;
|
|
2874
3315
|
/**
|
|
3316
|
+
* @public
|
|
2875
3317
|
* <p>The number of resources of this type in the Amazon Web Services account that are up-to-date with their template.</p>
|
|
2876
3318
|
*/
|
|
2877
3319
|
upToDate?: number;
|
|
2878
3320
|
/**
|
|
3321
|
+
* @public
|
|
2879
3322
|
* <p>The number of resources of this type in the Amazon Web Services account that need a major template version update.</p>
|
|
2880
3323
|
*/
|
|
2881
3324
|
behindMajor?: number;
|
|
2882
3325
|
/**
|
|
3326
|
+
* @public
|
|
2883
3327
|
* <p>The number of resources of this type in the Amazon Web Services account that need a minor template version update.</p>
|
|
2884
3328
|
*/
|
|
2885
3329
|
behindMinor?: number;
|
|
@@ -2890,6 +3334,7 @@ export interface ResourceCountsSummary {
|
|
|
2890
3334
|
*/
|
|
2891
3335
|
export interface CountsSummary {
|
|
2892
3336
|
/**
|
|
3337
|
+
* @public
|
|
2893
3338
|
* <p>The total number of components in the Amazon Web Services account.</p>
|
|
2894
3339
|
* <p>The semantics of the <code>components</code> field are different from the semantics of results for other
|
|
2895
3340
|
* infrastructure-provisioning resources. That's because at this time components don't have associated templates,
|
|
@@ -2898,29 +3343,35 @@ export interface CountsSummary {
|
|
|
2898
3343
|
*/
|
|
2899
3344
|
components?: ResourceCountsSummary;
|
|
2900
3345
|
/**
|
|
3346
|
+
* @public
|
|
2901
3347
|
* <p>The staleness counts for Proton environments in the Amazon Web Services account. The <code>environments</code> object will only
|
|
2902
3348
|
* contain <code>total</code> members.</p>
|
|
2903
3349
|
*/
|
|
2904
3350
|
environments?: ResourceCountsSummary;
|
|
2905
3351
|
/**
|
|
3352
|
+
* @public
|
|
2906
3353
|
* <p>The total number of environment templates in the Amazon Web Services account. The <code>environmentTemplates</code> object
|
|
2907
3354
|
* will only contain <code>total</code> members.</p>
|
|
2908
3355
|
*/
|
|
2909
3356
|
environmentTemplates?: ResourceCountsSummary;
|
|
2910
3357
|
/**
|
|
3358
|
+
* @public
|
|
2911
3359
|
* <p>The staleness counts for Proton service instances in the Amazon Web Services account.</p>
|
|
2912
3360
|
*/
|
|
2913
3361
|
serviceInstances?: ResourceCountsSummary;
|
|
2914
3362
|
/**
|
|
3363
|
+
* @public
|
|
2915
3364
|
* <p>The staleness counts for Proton services in the Amazon Web Services account.</p>
|
|
2916
3365
|
*/
|
|
2917
3366
|
services?: ResourceCountsSummary;
|
|
2918
3367
|
/**
|
|
3368
|
+
* @public
|
|
2919
3369
|
* <p>The total number of service templates in the Amazon Web Services account. The <code>serviceTemplates</code> object will only
|
|
2920
3370
|
* contain <code>total</code> members.</p>
|
|
2921
3371
|
*/
|
|
2922
3372
|
serviceTemplates?: ResourceCountsSummary;
|
|
2923
3373
|
/**
|
|
3374
|
+
* @public
|
|
2924
3375
|
* <p>The staleness counts for Proton pipelines in the Amazon Web Services account.</p>
|
|
2925
3376
|
*/
|
|
2926
3377
|
pipelines?: ResourceCountsSummary;
|
|
@@ -2930,6 +3381,7 @@ export interface CountsSummary {
|
|
|
2930
3381
|
*/
|
|
2931
3382
|
export interface GetResourcesSummaryOutput {
|
|
2932
3383
|
/**
|
|
3384
|
+
* @public
|
|
2933
3385
|
* <p>Summary counts of each Proton resource type.</p>
|
|
2934
3386
|
*/
|
|
2935
3387
|
counts: CountsSummary | undefined;
|
|
@@ -2939,10 +3391,12 @@ export interface GetResourcesSummaryOutput {
|
|
|
2939
3391
|
*/
|
|
2940
3392
|
export interface GetServiceInstanceSyncStatusInput {
|
|
2941
3393
|
/**
|
|
3394
|
+
* @public
|
|
2942
3395
|
* <p>The name of the service that the service instance belongs to.</p>
|
|
2943
3396
|
*/
|
|
2944
3397
|
serviceName: string | undefined;
|
|
2945
3398
|
/**
|
|
3399
|
+
* @public
|
|
2946
3400
|
* <p>The name of the service instance that you want the sync status input for.</p>
|
|
2947
3401
|
*/
|
|
2948
3402
|
serviceInstanceName: string | undefined;
|
|
@@ -2953,22 +3407,27 @@ export interface GetServiceInstanceSyncStatusInput {
|
|
|
2953
3407
|
*/
|
|
2954
3408
|
export interface Revision {
|
|
2955
3409
|
/**
|
|
3410
|
+
* @public
|
|
2956
3411
|
* <p>The repository name.</p>
|
|
2957
3412
|
*/
|
|
2958
3413
|
repositoryName: string | undefined;
|
|
2959
3414
|
/**
|
|
3415
|
+
* @public
|
|
2960
3416
|
* <p>The repository provider.</p>
|
|
2961
3417
|
*/
|
|
2962
3418
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
2963
3419
|
/**
|
|
3420
|
+
* @public
|
|
2964
3421
|
* <p>The secure hash algorithm (SHA) hash for the revision.</p>
|
|
2965
3422
|
*/
|
|
2966
3423
|
sha: string | undefined;
|
|
2967
3424
|
/**
|
|
3425
|
+
* @public
|
|
2968
3426
|
* <p>The repository directory changed by a commit and push that activated the sync attempt.</p>
|
|
2969
3427
|
*/
|
|
2970
3428
|
directory: string | undefined;
|
|
2971
3429
|
/**
|
|
3430
|
+
* @public
|
|
2972
3431
|
* <p>The repository branch.</p>
|
|
2973
3432
|
*/
|
|
2974
3433
|
branch: string | undefined;
|
|
@@ -2979,18 +3438,22 @@ export interface Revision {
|
|
|
2979
3438
|
*/
|
|
2980
3439
|
export interface ResourceSyncEvent {
|
|
2981
3440
|
/**
|
|
3441
|
+
* @public
|
|
2982
3442
|
* <p>The type of event.</p>
|
|
2983
3443
|
*/
|
|
2984
3444
|
type: string | undefined;
|
|
2985
3445
|
/**
|
|
3446
|
+
* @public
|
|
2986
3447
|
* <p>The external ID for the event.</p>
|
|
2987
3448
|
*/
|
|
2988
3449
|
externalId?: string;
|
|
2989
3450
|
/**
|
|
3451
|
+
* @public
|
|
2990
3452
|
* <p>The time when the event occurred.</p>
|
|
2991
3453
|
*/
|
|
2992
3454
|
time: Date | undefined;
|
|
2993
3455
|
/**
|
|
3456
|
+
* @public
|
|
2994
3457
|
* <p>A resource sync event.</p>
|
|
2995
3458
|
*/
|
|
2996
3459
|
event: string | undefined;
|
|
@@ -3031,26 +3494,32 @@ export type ResourceSyncStatus = (typeof ResourceSyncStatus)[keyof typeof Resour
|
|
|
3031
3494
|
*/
|
|
3032
3495
|
export interface ResourceSyncAttempt {
|
|
3033
3496
|
/**
|
|
3497
|
+
* @public
|
|
3034
3498
|
* <p>Detail data for the initial repository commit, path and push.</p>
|
|
3035
3499
|
*/
|
|
3036
3500
|
initialRevision: Revision | undefined;
|
|
3037
3501
|
/**
|
|
3502
|
+
* @public
|
|
3038
3503
|
* <p>Detail data for the target revision.</p>
|
|
3039
3504
|
*/
|
|
3040
3505
|
targetRevision: Revision | undefined;
|
|
3041
3506
|
/**
|
|
3507
|
+
* @public
|
|
3042
3508
|
* <p>The resource that is synced to.</p>
|
|
3043
3509
|
*/
|
|
3044
3510
|
target: string | undefined;
|
|
3045
3511
|
/**
|
|
3512
|
+
* @public
|
|
3046
3513
|
* <p>The time when the sync attempt started.</p>
|
|
3047
3514
|
*/
|
|
3048
3515
|
startedAt: Date | undefined;
|
|
3049
3516
|
/**
|
|
3517
|
+
* @public
|
|
3050
3518
|
* <p>The status of the sync attempt.</p>
|
|
3051
3519
|
*/
|
|
3052
3520
|
status: ResourceSyncStatus | string | undefined;
|
|
3053
3521
|
/**
|
|
3522
|
+
* @public
|
|
3054
3523
|
* <p>An array of events with detail data.</p>
|
|
3055
3524
|
*/
|
|
3056
3525
|
events: ResourceSyncEvent[] | undefined;
|
|
@@ -3060,14 +3529,17 @@ export interface ResourceSyncAttempt {
|
|
|
3060
3529
|
*/
|
|
3061
3530
|
export interface GetServiceInstanceSyncStatusOutput {
|
|
3062
3531
|
/**
|
|
3532
|
+
* @public
|
|
3063
3533
|
* <p>The detailed data of the latest sync with the service instance.</p>
|
|
3064
3534
|
*/
|
|
3065
3535
|
latestSync?: ResourceSyncAttempt;
|
|
3066
3536
|
/**
|
|
3537
|
+
* @public
|
|
3067
3538
|
* <p>The detailed data of the latest successful sync with the service instance.</p>
|
|
3068
3539
|
*/
|
|
3069
3540
|
latestSuccessfulSync?: ResourceSyncAttempt;
|
|
3070
3541
|
/**
|
|
3542
|
+
* @public
|
|
3071
3543
|
* <p>The service instance sync desired state that's returned by Proton</p>
|
|
3072
3544
|
*/
|
|
3073
3545
|
desiredState?: Revision;
|
|
@@ -3089,14 +3561,17 @@ export type TemplateType = (typeof TemplateType)[keyof typeof TemplateType];
|
|
|
3089
3561
|
*/
|
|
3090
3562
|
export interface GetTemplateSyncStatusInput {
|
|
3091
3563
|
/**
|
|
3564
|
+
* @public
|
|
3092
3565
|
* <p>The template name.</p>
|
|
3093
3566
|
*/
|
|
3094
3567
|
templateName: string | undefined;
|
|
3095
3568
|
/**
|
|
3569
|
+
* @public
|
|
3096
3570
|
* <p>The template type.</p>
|
|
3097
3571
|
*/
|
|
3098
3572
|
templateType: TemplateType | string | undefined;
|
|
3099
3573
|
/**
|
|
3574
|
+
* @public
|
|
3100
3575
|
* <p>The template major version.</p>
|
|
3101
3576
|
*/
|
|
3102
3577
|
templateVersion: string | undefined;
|
|
@@ -3106,14 +3581,17 @@ export interface GetTemplateSyncStatusInput {
|
|
|
3106
3581
|
*/
|
|
3107
3582
|
export interface GetTemplateSyncStatusOutput {
|
|
3108
3583
|
/**
|
|
3584
|
+
* @public
|
|
3109
3585
|
* <p>The details of the last sync that's returned by Proton.</p>
|
|
3110
3586
|
*/
|
|
3111
3587
|
latestSync?: ResourceSyncAttempt;
|
|
3112
3588
|
/**
|
|
3589
|
+
* @public
|
|
3113
3590
|
* <p>The details of the last successful sync that's returned by Proton.</p>
|
|
3114
3591
|
*/
|
|
3115
3592
|
latestSuccessfulSync?: ResourceSyncAttempt;
|
|
3116
3593
|
/**
|
|
3594
|
+
* @public
|
|
3117
3595
|
* <p>The template sync desired state that's returned by Proton.</p>
|
|
3118
3596
|
*/
|
|
3119
3597
|
desiredState?: Revision;
|
|
@@ -3123,18 +3601,22 @@ export interface GetTemplateSyncStatusOutput {
|
|
|
3123
3601
|
*/
|
|
3124
3602
|
export interface ListRepositorySyncDefinitionsInput {
|
|
3125
3603
|
/**
|
|
3604
|
+
* @public
|
|
3126
3605
|
* <p>The repository name.</p>
|
|
3127
3606
|
*/
|
|
3128
3607
|
repositoryName: string | undefined;
|
|
3129
3608
|
/**
|
|
3609
|
+
* @public
|
|
3130
3610
|
* <p>The repository provider.</p>
|
|
3131
3611
|
*/
|
|
3132
3612
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
3133
3613
|
/**
|
|
3614
|
+
* @public
|
|
3134
3615
|
* <p>The sync type. The only supported value is <code>TEMPLATE_SYNC</code>.</p>
|
|
3135
3616
|
*/
|
|
3136
3617
|
syncType: SyncType | string | undefined;
|
|
3137
3618
|
/**
|
|
3619
|
+
* @public
|
|
3138
3620
|
* <p>A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository
|
|
3139
3621
|
* sync definitions previously requested.</p>
|
|
3140
3622
|
*/
|
|
@@ -3146,18 +3628,22 @@ export interface ListRepositorySyncDefinitionsInput {
|
|
|
3146
3628
|
*/
|
|
3147
3629
|
export interface RepositorySyncDefinition {
|
|
3148
3630
|
/**
|
|
3631
|
+
* @public
|
|
3149
3632
|
* <p>The resource that is synced to.</p>
|
|
3150
3633
|
*/
|
|
3151
3634
|
target: string | undefined;
|
|
3152
3635
|
/**
|
|
3636
|
+
* @public
|
|
3153
3637
|
* <p>The resource that is synced from.</p>
|
|
3154
3638
|
*/
|
|
3155
3639
|
parent: string | undefined;
|
|
3156
3640
|
/**
|
|
3641
|
+
* @public
|
|
3157
3642
|
* <p>The repository branch.</p>
|
|
3158
3643
|
*/
|
|
3159
3644
|
branch: string | undefined;
|
|
3160
3645
|
/**
|
|
3646
|
+
* @public
|
|
3161
3647
|
* <p>The directory in the repository.</p>
|
|
3162
3648
|
*/
|
|
3163
3649
|
directory: string | undefined;
|
|
@@ -3167,11 +3653,13 @@ export interface RepositorySyncDefinition {
|
|
|
3167
3653
|
*/
|
|
3168
3654
|
export interface ListRepositorySyncDefinitionsOutput {
|
|
3169
3655
|
/**
|
|
3656
|
+
* @public
|
|
3170
3657
|
* <p>A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested
|
|
3171
3658
|
* list of repository sync definitions.</p>
|
|
3172
3659
|
*/
|
|
3173
3660
|
nextToken?: string;
|
|
3174
3661
|
/**
|
|
3662
|
+
* @public
|
|
3175
3663
|
* <p>An array of repository sync definitions.</p>
|
|
3176
3664
|
*/
|
|
3177
3665
|
syncDefinitions: RepositorySyncDefinition[] | undefined;
|
|
@@ -3181,15 +3669,18 @@ export interface ListRepositorySyncDefinitionsOutput {
|
|
|
3181
3669
|
*/
|
|
3182
3670
|
export interface ListTagsForResourceInput {
|
|
3183
3671
|
/**
|
|
3672
|
+
* @public
|
|
3184
3673
|
* <p>The Amazon Resource Name (ARN) of the resource for the listed tags.</p>
|
|
3185
3674
|
*/
|
|
3186
3675
|
resourceArn: string | undefined;
|
|
3187
3676
|
/**
|
|
3677
|
+
* @public
|
|
3188
3678
|
* <p>A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was
|
|
3189
3679
|
* previously requested.</p>
|
|
3190
3680
|
*/
|
|
3191
3681
|
nextToken?: string;
|
|
3192
3682
|
/**
|
|
3683
|
+
* @public
|
|
3193
3684
|
* <p>The maximum number of tags to list.</p>
|
|
3194
3685
|
*/
|
|
3195
3686
|
maxResults?: number;
|
|
@@ -3199,10 +3690,12 @@ export interface ListTagsForResourceInput {
|
|
|
3199
3690
|
*/
|
|
3200
3691
|
export interface ListTagsForResourceOutput {
|
|
3201
3692
|
/**
|
|
3693
|
+
* @public
|
|
3202
3694
|
* <p>A list of resource tags with detail data.</p>
|
|
3203
3695
|
*/
|
|
3204
3696
|
tags: Tag[] | undefined;
|
|
3205
3697
|
/**
|
|
3698
|
+
* @public
|
|
3206
3699
|
* <p>A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource
|
|
3207
3700
|
* tags.</p>
|
|
3208
3701
|
*/
|
|
@@ -3226,22 +3719,27 @@ export type ResourceDeploymentStatus = (typeof ResourceDeploymentStatus)[keyof t
|
|
|
3226
3719
|
*/
|
|
3227
3720
|
export interface NotifyResourceDeploymentStatusChangeInput {
|
|
3228
3721
|
/**
|
|
3722
|
+
* @public
|
|
3229
3723
|
* <p>The provisioned resource Amazon Resource Name (ARN).</p>
|
|
3230
3724
|
*/
|
|
3231
3725
|
resourceArn: string | undefined;
|
|
3232
3726
|
/**
|
|
3727
|
+
* @public
|
|
3233
3728
|
* <p>The status of your provisioned resource.</p>
|
|
3234
3729
|
*/
|
|
3235
3730
|
status?: ResourceDeploymentStatus | string;
|
|
3236
3731
|
/**
|
|
3732
|
+
* @public
|
|
3237
3733
|
* <p>The provisioned resource state change detail data that's returned by Proton.</p>
|
|
3238
3734
|
*/
|
|
3239
3735
|
outputs?: Output[];
|
|
3240
3736
|
/**
|
|
3737
|
+
* @public
|
|
3241
3738
|
* <p>The deployment ID for your provisioned resource.</p>
|
|
3242
3739
|
*/
|
|
3243
3740
|
deploymentId?: string;
|
|
3244
3741
|
/**
|
|
3742
|
+
* @public
|
|
3245
3743
|
* <p>The deployment status message for your provisioned resource.</p>
|
|
3246
3744
|
*/
|
|
3247
3745
|
statusMessage?: string;
|
|
@@ -3256,23 +3754,28 @@ export interface NotifyResourceDeploymentStatusChangeOutput {
|
|
|
3256
3754
|
*/
|
|
3257
3755
|
export interface CreateRepositoryInput {
|
|
3258
3756
|
/**
|
|
3757
|
+
* @public
|
|
3259
3758
|
* <p>The repository provider.</p>
|
|
3260
3759
|
*/
|
|
3261
3760
|
provider: RepositoryProvider | string | undefined;
|
|
3262
3761
|
/**
|
|
3762
|
+
* @public
|
|
3263
3763
|
* <p>The repository name (for example, <code>myrepos/myrepo</code>).</p>
|
|
3264
3764
|
*/
|
|
3265
3765
|
name: string | undefined;
|
|
3266
3766
|
/**
|
|
3767
|
+
* @public
|
|
3267
3768
|
* <p>The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html">Setting up for Proton</a> in the <i>Proton User
|
|
3268
3769
|
* Guide</i>.</p>
|
|
3269
3770
|
*/
|
|
3270
3771
|
connectionArn: string | undefined;
|
|
3271
3772
|
/**
|
|
3773
|
+
* @public
|
|
3272
3774
|
* <p>The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.</p>
|
|
3273
3775
|
*/
|
|
3274
3776
|
encryptionKey?: string;
|
|
3275
3777
|
/**
|
|
3778
|
+
* @public
|
|
3276
3779
|
* <p>An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.</p>
|
|
3277
3780
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
3278
3781
|
* <i>Proton User Guide</i>.</p>
|
|
@@ -3285,22 +3788,27 @@ export interface CreateRepositoryInput {
|
|
|
3285
3788
|
*/
|
|
3286
3789
|
export interface Repository {
|
|
3287
3790
|
/**
|
|
3791
|
+
* @public
|
|
3288
3792
|
* <p>The Amazon Resource Name (ARN) of the linked repository.</p>
|
|
3289
3793
|
*/
|
|
3290
3794
|
arn: string | undefined;
|
|
3291
3795
|
/**
|
|
3796
|
+
* @public
|
|
3292
3797
|
* <p>The repository provider.</p>
|
|
3293
3798
|
*/
|
|
3294
3799
|
provider: RepositoryProvider | string | undefined;
|
|
3295
3800
|
/**
|
|
3801
|
+
* @public
|
|
3296
3802
|
* <p>The repository name.</p>
|
|
3297
3803
|
*/
|
|
3298
3804
|
name: string | undefined;
|
|
3299
3805
|
/**
|
|
3806
|
+
* @public
|
|
3300
3807
|
* <p>The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.</p>
|
|
3301
3808
|
*/
|
|
3302
3809
|
connectionArn: string | undefined;
|
|
3303
3810
|
/**
|
|
3811
|
+
* @public
|
|
3304
3812
|
* <p>Your customer Amazon Web Services KMS encryption key.</p>
|
|
3305
3813
|
*/
|
|
3306
3814
|
encryptionKey?: string;
|
|
@@ -3310,6 +3818,7 @@ export interface Repository {
|
|
|
3310
3818
|
*/
|
|
3311
3819
|
export interface CreateRepositoryOutput {
|
|
3312
3820
|
/**
|
|
3821
|
+
* @public
|
|
3313
3822
|
* <p>The repository link's detail data that's returned by Proton.</p>
|
|
3314
3823
|
*/
|
|
3315
3824
|
repository: Repository | undefined;
|
|
@@ -3319,10 +3828,12 @@ export interface CreateRepositoryOutput {
|
|
|
3319
3828
|
*/
|
|
3320
3829
|
export interface DeleteRepositoryInput {
|
|
3321
3830
|
/**
|
|
3831
|
+
* @public
|
|
3322
3832
|
* <p>The repository provider.</p>
|
|
3323
3833
|
*/
|
|
3324
3834
|
provider: RepositoryProvider | string | undefined;
|
|
3325
3835
|
/**
|
|
3836
|
+
* @public
|
|
3326
3837
|
* <p>The repository name.</p>
|
|
3327
3838
|
*/
|
|
3328
3839
|
name: string | undefined;
|
|
@@ -3332,6 +3843,7 @@ export interface DeleteRepositoryInput {
|
|
|
3332
3843
|
*/
|
|
3333
3844
|
export interface DeleteRepositoryOutput {
|
|
3334
3845
|
/**
|
|
3846
|
+
* @public
|
|
3335
3847
|
* <p>The deleted repository link's detail data that's returned by Proton.</p>
|
|
3336
3848
|
*/
|
|
3337
3849
|
repository?: Repository;
|
|
@@ -3341,10 +3853,12 @@ export interface DeleteRepositoryOutput {
|
|
|
3341
3853
|
*/
|
|
3342
3854
|
export interface GetRepositoryInput {
|
|
3343
3855
|
/**
|
|
3856
|
+
* @public
|
|
3344
3857
|
* <p>The repository provider.</p>
|
|
3345
3858
|
*/
|
|
3346
3859
|
provider: RepositoryProvider | string | undefined;
|
|
3347
3860
|
/**
|
|
3861
|
+
* @public
|
|
3348
3862
|
* <p>The repository name, for example <code>myrepos/myrepo</code>.</p>
|
|
3349
3863
|
*/
|
|
3350
3864
|
name: string | undefined;
|
|
@@ -3354,6 +3868,7 @@ export interface GetRepositoryInput {
|
|
|
3354
3868
|
*/
|
|
3355
3869
|
export interface GetRepositoryOutput {
|
|
3356
3870
|
/**
|
|
3871
|
+
* @public
|
|
3357
3872
|
* <p>The repository link's detail data that's returned by Proton.</p>
|
|
3358
3873
|
*/
|
|
3359
3874
|
repository: Repository | undefined;
|
|
@@ -3363,10 +3878,12 @@ export interface GetRepositoryOutput {
|
|
|
3363
3878
|
*/
|
|
3364
3879
|
export interface ListRepositoriesInput {
|
|
3365
3880
|
/**
|
|
3881
|
+
* @public
|
|
3366
3882
|
* <p>A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.</p>
|
|
3367
3883
|
*/
|
|
3368
3884
|
nextToken?: string;
|
|
3369
3885
|
/**
|
|
3886
|
+
* @public
|
|
3370
3887
|
* <p>The maximum number of repositories to list.</p>
|
|
3371
3888
|
*/
|
|
3372
3889
|
maxResults?: number;
|
|
@@ -3377,18 +3894,22 @@ export interface ListRepositoriesInput {
|
|
|
3377
3894
|
*/
|
|
3378
3895
|
export interface RepositorySummary {
|
|
3379
3896
|
/**
|
|
3897
|
+
* @public
|
|
3380
3898
|
* <p>The Amazon Resource Name (ARN) of the linked repository.</p>
|
|
3381
3899
|
*/
|
|
3382
3900
|
arn: string | undefined;
|
|
3383
3901
|
/**
|
|
3902
|
+
* @public
|
|
3384
3903
|
* <p>The repository provider.</p>
|
|
3385
3904
|
*/
|
|
3386
3905
|
provider: RepositoryProvider | string | undefined;
|
|
3387
3906
|
/**
|
|
3907
|
+
* @public
|
|
3388
3908
|
* <p>The repository name.</p>
|
|
3389
3909
|
*/
|
|
3390
3910
|
name: string | undefined;
|
|
3391
3911
|
/**
|
|
3912
|
+
* @public
|
|
3392
3913
|
* <p>The Amazon Resource Name (ARN) of the of your connection that connects Proton to your repository.</p>
|
|
3393
3914
|
*/
|
|
3394
3915
|
connectionArn: string | undefined;
|
|
@@ -3398,10 +3919,12 @@ export interface RepositorySummary {
|
|
|
3398
3919
|
*/
|
|
3399
3920
|
export interface ListRepositoriesOutput {
|
|
3400
3921
|
/**
|
|
3922
|
+
* @public
|
|
3401
3923
|
* <p>A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories. </p>
|
|
3402
3924
|
*/
|
|
3403
3925
|
nextToken?: string;
|
|
3404
3926
|
/**
|
|
3927
|
+
* @public
|
|
3405
3928
|
* <p>An array of repository links.</p>
|
|
3406
3929
|
*/
|
|
3407
3930
|
repositories: RepositorySummary[] | undefined;
|
|
@@ -3411,19 +3934,23 @@ export interface ListRepositoriesOutput {
|
|
|
3411
3934
|
*/
|
|
3412
3935
|
export interface ListServiceInstanceOutputsInput {
|
|
3413
3936
|
/**
|
|
3937
|
+
* @public
|
|
3414
3938
|
* <p>The name of the service instance whose outputs you want.</p>
|
|
3415
3939
|
*/
|
|
3416
3940
|
serviceInstanceName: string | undefined;
|
|
3417
3941
|
/**
|
|
3942
|
+
* @public
|
|
3418
3943
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>
|
|
3419
3944
|
*/
|
|
3420
3945
|
serviceName: string | undefined;
|
|
3421
3946
|
/**
|
|
3947
|
+
* @public
|
|
3422
3948
|
* <p>A token that indicates the location of the next output in the array of outputs, after the
|
|
3423
3949
|
* list of outputs that was previously requested.</p>
|
|
3424
3950
|
*/
|
|
3425
3951
|
nextToken?: string;
|
|
3426
3952
|
/**
|
|
3953
|
+
* @public
|
|
3427
3954
|
* <p>The ID of the deployment whose outputs you want.</p>
|
|
3428
3955
|
*/
|
|
3429
3956
|
deploymentId?: string;
|
|
@@ -3433,11 +3960,13 @@ export interface ListServiceInstanceOutputsInput {
|
|
|
3433
3960
|
*/
|
|
3434
3961
|
export interface ListServiceInstanceOutputsOutput {
|
|
3435
3962
|
/**
|
|
3963
|
+
* @public
|
|
3436
3964
|
* <p>A token that indicates the location of the next output in the array of outputs, after the
|
|
3437
3965
|
* current requested list of outputs.</p>
|
|
3438
3966
|
*/
|
|
3439
3967
|
nextToken?: string;
|
|
3440
3968
|
/**
|
|
3969
|
+
* @public
|
|
3441
3970
|
* <p>An array of service instance Infrastructure as Code (IaC) outputs.</p>
|
|
3442
3971
|
*/
|
|
3443
3972
|
outputs: Output[] | undefined;
|
|
@@ -3447,14 +3976,17 @@ export interface ListServiceInstanceOutputsOutput {
|
|
|
3447
3976
|
*/
|
|
3448
3977
|
export interface ListServiceInstanceProvisionedResourcesInput {
|
|
3449
3978
|
/**
|
|
3979
|
+
* @public
|
|
3450
3980
|
* <p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>
|
|
3451
3981
|
*/
|
|
3452
3982
|
serviceName: string | undefined;
|
|
3453
3983
|
/**
|
|
3984
|
+
* @public
|
|
3454
3985
|
* <p>The name of the service instance whose provisioned resources you want.</p>
|
|
3455
3986
|
*/
|
|
3456
3987
|
serviceInstanceName: string | undefined;
|
|
3457
3988
|
/**
|
|
3989
|
+
* @public
|
|
3458
3990
|
* <p>A token that indicates the location of the next provisioned resource in the array of
|
|
3459
3991
|
* provisioned resources, after the list of provisioned resources that was previously
|
|
3460
3992
|
* requested.</p>
|
|
@@ -3466,11 +3998,13 @@ export interface ListServiceInstanceProvisionedResourcesInput {
|
|
|
3466
3998
|
*/
|
|
3467
3999
|
export interface ListServiceInstanceProvisionedResourcesOutput {
|
|
3468
4000
|
/**
|
|
4001
|
+
* @public
|
|
3469
4002
|
* <p>A token that indicates the location of the next provisioned resource in the array of
|
|
3470
4003
|
* provisioned resources, after the current requested list of provisioned resources.</p>
|
|
3471
4004
|
*/
|
|
3472
4005
|
nextToken?: string;
|
|
3473
4006
|
/**
|
|
4007
|
+
* @public
|
|
3474
4008
|
* <p>An array of provisioned resources for a service instance.</p>
|
|
3475
4009
|
*/
|
|
3476
4010
|
provisionedResources: ProvisionedResource[] | undefined;
|
|
@@ -3480,29 +4014,35 @@ export interface ListServiceInstanceProvisionedResourcesOutput {
|
|
|
3480
4014
|
*/
|
|
3481
4015
|
export interface CreateServiceInstanceInput {
|
|
3482
4016
|
/**
|
|
4017
|
+
* @public
|
|
3483
4018
|
* <p>The name of the service instance to create.</p>
|
|
3484
4019
|
*/
|
|
3485
4020
|
name: string | undefined;
|
|
3486
4021
|
/**
|
|
4022
|
+
* @public
|
|
3487
4023
|
* <p>The name of the service the service instance is added to.</p>
|
|
3488
4024
|
*/
|
|
3489
4025
|
serviceName: string | undefined;
|
|
3490
4026
|
/**
|
|
4027
|
+
* @public
|
|
3491
4028
|
* <p>The spec for the service instance you want to create.</p>
|
|
3492
4029
|
*/
|
|
3493
4030
|
spec: string | undefined;
|
|
3494
4031
|
/**
|
|
4032
|
+
* @public
|
|
3495
4033
|
* <p>To create a new major and minor version of the service template,
|
|
3496
4034
|
* <i>exclude</i>
|
|
3497
4035
|
* <code>major Version</code>.</p>
|
|
3498
4036
|
*/
|
|
3499
4037
|
templateMajorVersion?: string;
|
|
3500
4038
|
/**
|
|
4039
|
+
* @public
|
|
3501
4040
|
* <p>To create a new minor version of the service template, include a <code>major
|
|
3502
4041
|
* Version</code>.</p>
|
|
3503
4042
|
*/
|
|
3504
4043
|
templateMinorVersion?: string;
|
|
3505
4044
|
/**
|
|
4045
|
+
* @public
|
|
3506
4046
|
* <p>An optional list of metadata items that you can associate with the Proton service instance.
|
|
3507
4047
|
* A tag is a key-value pair.</p>
|
|
3508
4048
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
@@ -3510,6 +4050,7 @@ export interface CreateServiceInstanceInput {
|
|
|
3510
4050
|
*/
|
|
3511
4051
|
tags?: Tag[];
|
|
3512
4052
|
/**
|
|
4053
|
+
* @public
|
|
3513
4054
|
* <p>The client token of the service instance to create.</p>
|
|
3514
4055
|
*/
|
|
3515
4056
|
clientToken?: string;
|
|
@@ -3519,6 +4060,7 @@ export interface CreateServiceInstanceInput {
|
|
|
3519
4060
|
*/
|
|
3520
4061
|
export interface CreateServiceInstanceOutput {
|
|
3521
4062
|
/**
|
|
4063
|
+
* @public
|
|
3522
4064
|
* <p>The detailed data of the service instance being created.</p>
|
|
3523
4065
|
*/
|
|
3524
4066
|
serviceInstance: ServiceInstance | undefined;
|
|
@@ -3528,10 +4070,12 @@ export interface CreateServiceInstanceOutput {
|
|
|
3528
4070
|
*/
|
|
3529
4071
|
export interface GetServiceInstanceInput {
|
|
3530
4072
|
/**
|
|
4073
|
+
* @public
|
|
3531
4074
|
* <p>The name of a service instance that you want to get the detailed data for.</p>
|
|
3532
4075
|
*/
|
|
3533
4076
|
name: string | undefined;
|
|
3534
4077
|
/**
|
|
4078
|
+
* @public
|
|
3535
4079
|
* <p>The name of the service that you want the service instance input for.</p>
|
|
3536
4080
|
*/
|
|
3537
4081
|
serviceName: string | undefined;
|
|
@@ -3541,6 +4085,7 @@ export interface GetServiceInstanceInput {
|
|
|
3541
4085
|
*/
|
|
3542
4086
|
export interface GetServiceInstanceOutput {
|
|
3543
4087
|
/**
|
|
4088
|
+
* @public
|
|
3544
4089
|
* <p>The detailed data of the requested service instance.</p>
|
|
3545
4090
|
*/
|
|
3546
4091
|
serviceInstance: ServiceInstance | undefined;
|
|
@@ -3571,10 +4116,12 @@ export type ListServiceInstancesFilterBy = (typeof ListServiceInstancesFilterBy)
|
|
|
3571
4116
|
*/
|
|
3572
4117
|
export interface ListServiceInstancesFilter {
|
|
3573
4118
|
/**
|
|
4119
|
+
* @public
|
|
3574
4120
|
* <p>The name of a filtering criterion.</p>
|
|
3575
4121
|
*/
|
|
3576
4122
|
key?: ListServiceInstancesFilterBy | string;
|
|
3577
4123
|
/**
|
|
4124
|
+
* @public
|
|
3578
4125
|
* <p>A value to filter by.</p>
|
|
3579
4126
|
* <p>With the date/time keys (<code>*At\{Before,After\}</code>), the value is a valid <a href="https://datatracker.ietf.org/doc/html/rfc3339.html">RFC 3339</a> string with no UTC
|
|
3580
4127
|
* offset and with an optional fractional precision (for example,
|
|
@@ -3616,24 +4163,29 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
3616
4163
|
*/
|
|
3617
4164
|
export interface ListServiceInstancesInput {
|
|
3618
4165
|
/**
|
|
4166
|
+
* @public
|
|
3619
4167
|
* <p>The name of the service that the service instance belongs to.</p>
|
|
3620
4168
|
*/
|
|
3621
4169
|
serviceName?: string;
|
|
3622
4170
|
/**
|
|
4171
|
+
* @public
|
|
3623
4172
|
* <p>A token that indicates the location of the next service in the array of service instances,
|
|
3624
4173
|
* after the list of service instances that was previously requested.</p>
|
|
3625
4174
|
*/
|
|
3626
4175
|
nextToken?: string;
|
|
3627
4176
|
/**
|
|
4177
|
+
* @public
|
|
3628
4178
|
* <p>The maximum number of service instances to list.</p>
|
|
3629
4179
|
*/
|
|
3630
4180
|
maxResults?: number;
|
|
3631
4181
|
/**
|
|
4182
|
+
* @public
|
|
3632
4183
|
* <p>An array of filtering criteria that scope down the result list. By default, all service
|
|
3633
4184
|
* instances in the Amazon Web Services account are returned.</p>
|
|
3634
4185
|
*/
|
|
3635
4186
|
filters?: ListServiceInstancesFilter[];
|
|
3636
4187
|
/**
|
|
4188
|
+
* @public
|
|
3637
4189
|
* <p>The field that the result list is sorted by.</p>
|
|
3638
4190
|
* <p>When you choose to sort by <code>serviceName</code>, service instances within each service
|
|
3639
4191
|
* are sorted by service instance name.</p>
|
|
@@ -3642,6 +4194,7 @@ export interface ListServiceInstancesInput {
|
|
|
3642
4194
|
*/
|
|
3643
4195
|
sortBy?: ListServiceInstancesSortBy | string;
|
|
3644
4196
|
/**
|
|
4197
|
+
* @public
|
|
3645
4198
|
* <p>Result list sort order.</p>
|
|
3646
4199
|
* <p>Default: <code>ASCENDING</code>
|
|
3647
4200
|
* </p>
|
|
@@ -3654,58 +4207,72 @@ export interface ListServiceInstancesInput {
|
|
|
3654
4207
|
*/
|
|
3655
4208
|
export interface ServiceInstanceSummary {
|
|
3656
4209
|
/**
|
|
4210
|
+
* @public
|
|
3657
4211
|
* <p>The name of the service instance.</p>
|
|
3658
4212
|
*/
|
|
3659
4213
|
name: string | undefined;
|
|
3660
4214
|
/**
|
|
4215
|
+
* @public
|
|
3661
4216
|
* <p>The Amazon Resource Name (ARN) of the service instance.</p>
|
|
3662
4217
|
*/
|
|
3663
4218
|
arn: string | undefined;
|
|
3664
4219
|
/**
|
|
4220
|
+
* @public
|
|
3665
4221
|
* <p>The time when the service instance was created.</p>
|
|
3666
4222
|
*/
|
|
3667
4223
|
createdAt: Date | undefined;
|
|
3668
4224
|
/**
|
|
4225
|
+
* @public
|
|
3669
4226
|
* <p>The time when a deployment of the service was last attempted.</p>
|
|
3670
4227
|
*/
|
|
3671
4228
|
lastDeploymentAttemptedAt: Date | undefined;
|
|
3672
4229
|
/**
|
|
4230
|
+
* @public
|
|
3673
4231
|
* <p>The time when the service was last deployed successfully.</p>
|
|
3674
4232
|
*/
|
|
3675
4233
|
lastDeploymentSucceededAt: Date | undefined;
|
|
3676
4234
|
/**
|
|
4235
|
+
* @public
|
|
3677
4236
|
* <p>The name of the service that the service instance belongs to.</p>
|
|
3678
4237
|
*/
|
|
3679
4238
|
serviceName: string | undefined;
|
|
3680
4239
|
/**
|
|
4240
|
+
* @public
|
|
3681
4241
|
* <p>The name of the environment that the service instance was deployed into.</p>
|
|
3682
4242
|
*/
|
|
3683
4243
|
environmentName: string | undefined;
|
|
3684
4244
|
/**
|
|
4245
|
+
* @public
|
|
3685
4246
|
* <p>The name of the service template.</p>
|
|
3686
4247
|
*/
|
|
3687
4248
|
templateName: string | undefined;
|
|
3688
4249
|
/**
|
|
4250
|
+
* @public
|
|
3689
4251
|
* <p>The service instance template major version.</p>
|
|
3690
4252
|
*/
|
|
3691
4253
|
templateMajorVersion: string | undefined;
|
|
3692
4254
|
/**
|
|
4255
|
+
* @public
|
|
3693
4256
|
* <p>The service instance template minor version.</p>
|
|
3694
4257
|
*/
|
|
3695
4258
|
templateMinorVersion: string | undefined;
|
|
3696
4259
|
/**
|
|
4260
|
+
* @public
|
|
3697
4261
|
* <p>The service instance deployment status.</p>
|
|
3698
4262
|
*/
|
|
3699
4263
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
3700
4264
|
/**
|
|
4265
|
+
* @public
|
|
3701
4266
|
* <p>A service instance deployment status message.</p>
|
|
3702
4267
|
*/
|
|
3703
4268
|
deploymentStatusMessage?: string;
|
|
3704
4269
|
/**
|
|
4270
|
+
* @public
|
|
3705
4271
|
* <p>The ID of the last attempted deployment of this service instance.</p>
|
|
3706
4272
|
*/
|
|
3707
4273
|
lastAttemptedDeploymentId?: string;
|
|
3708
4274
|
/**
|
|
4275
|
+
* @public
|
|
3709
4276
|
* <p>The ID of the last successful deployment of this service instance.</p>
|
|
3710
4277
|
*/
|
|
3711
4278
|
lastSucceededDeploymentId?: string;
|
|
@@ -3715,11 +4282,13 @@ export interface ServiceInstanceSummary {
|
|
|
3715
4282
|
*/
|
|
3716
4283
|
export interface ListServiceInstancesOutput {
|
|
3717
4284
|
/**
|
|
4285
|
+
* @public
|
|
3718
4286
|
* <p>A token that indicates the location of the next service instance in the array of service
|
|
3719
4287
|
* instances, after the current requested list of service instances.</p>
|
|
3720
4288
|
*/
|
|
3721
4289
|
nextToken?: string;
|
|
3722
4290
|
/**
|
|
4291
|
+
* @public
|
|
3723
4292
|
* <p>An array of service instances with summary data.</p>
|
|
3724
4293
|
*/
|
|
3725
4294
|
serviceInstances: ServiceInstanceSummary[] | undefined;
|
|
@@ -3729,14 +4298,17 @@ export interface ListServiceInstancesOutput {
|
|
|
3729
4298
|
*/
|
|
3730
4299
|
export interface UpdateServiceInstanceInput {
|
|
3731
4300
|
/**
|
|
4301
|
+
* @public
|
|
3732
4302
|
* <p>The name of the service instance to update.</p>
|
|
3733
4303
|
*/
|
|
3734
4304
|
name: string | undefined;
|
|
3735
4305
|
/**
|
|
4306
|
+
* @public
|
|
3736
4307
|
* <p>The name of the service that the service instance belongs to.</p>
|
|
3737
4308
|
*/
|
|
3738
4309
|
serviceName: string | undefined;
|
|
3739
4310
|
/**
|
|
4311
|
+
* @public
|
|
3740
4312
|
* <p>The deployment type. It defines the mode for updating a service instance, as
|
|
3741
4313
|
* follows:</p>
|
|
3742
4314
|
* <dl>
|
|
@@ -3780,18 +4352,22 @@ export interface UpdateServiceInstanceInput {
|
|
|
3780
4352
|
*/
|
|
3781
4353
|
deploymentType: DeploymentUpdateType | string | undefined;
|
|
3782
4354
|
/**
|
|
4355
|
+
* @public
|
|
3783
4356
|
* <p>The formatted specification that defines the service instance update.</p>
|
|
3784
4357
|
*/
|
|
3785
4358
|
spec?: string;
|
|
3786
4359
|
/**
|
|
4360
|
+
* @public
|
|
3787
4361
|
* <p>The major version of the service template to update.</p>
|
|
3788
4362
|
*/
|
|
3789
4363
|
templateMajorVersion?: string;
|
|
3790
4364
|
/**
|
|
4365
|
+
* @public
|
|
3791
4366
|
* <p>The minor version of the service template to update.</p>
|
|
3792
4367
|
*/
|
|
3793
4368
|
templateMinorVersion?: string;
|
|
3794
4369
|
/**
|
|
4370
|
+
* @public
|
|
3795
4371
|
* <p>The client token of the service instance to update.</p>
|
|
3796
4372
|
*/
|
|
3797
4373
|
clientToken?: string;
|
|
@@ -3801,6 +4377,7 @@ export interface UpdateServiceInstanceInput {
|
|
|
3801
4377
|
*/
|
|
3802
4378
|
export interface UpdateServiceInstanceOutput {
|
|
3803
4379
|
/**
|
|
4380
|
+
* @public
|
|
3804
4381
|
* <p>The service instance summary data that's returned by Proton.</p>
|
|
3805
4382
|
*/
|
|
3806
4383
|
serviceInstance: ServiceInstance | undefined;
|
|
@@ -3810,15 +4387,18 @@ export interface UpdateServiceInstanceOutput {
|
|
|
3810
4387
|
*/
|
|
3811
4388
|
export interface ListServicePipelineOutputsInput {
|
|
3812
4389
|
/**
|
|
4390
|
+
* @public
|
|
3813
4391
|
* <p>The name of the service whose pipeline's outputs you want.</p>
|
|
3814
4392
|
*/
|
|
3815
4393
|
serviceName: string | undefined;
|
|
3816
4394
|
/**
|
|
4395
|
+
* @public
|
|
3817
4396
|
* <p>A token that indicates the location of the next output in the array of outputs, after the
|
|
3818
4397
|
* list of outputs that was previously requested.</p>
|
|
3819
4398
|
*/
|
|
3820
4399
|
nextToken?: string;
|
|
3821
4400
|
/**
|
|
4401
|
+
* @public
|
|
3822
4402
|
* <p>The ID of the deployment you want the outputs for.</p>
|
|
3823
4403
|
*/
|
|
3824
4404
|
deploymentId?: string;
|
|
@@ -3828,11 +4408,13 @@ export interface ListServicePipelineOutputsInput {
|
|
|
3828
4408
|
*/
|
|
3829
4409
|
export interface ListServicePipelineOutputsOutput {
|
|
3830
4410
|
/**
|
|
4411
|
+
* @public
|
|
3831
4412
|
* <p>A token that indicates the location of the next output in the array of outputs, after the
|
|
3832
4413
|
* current requested list of outputs.</p>
|
|
3833
4414
|
*/
|
|
3834
4415
|
nextToken?: string;
|
|
3835
4416
|
/**
|
|
4417
|
+
* @public
|
|
3836
4418
|
* <p>An array of service pipeline Infrastructure as Code (IaC) outputs.</p>
|
|
3837
4419
|
*/
|
|
3838
4420
|
outputs: Output[] | undefined;
|
|
@@ -3842,10 +4424,12 @@ export interface ListServicePipelineOutputsOutput {
|
|
|
3842
4424
|
*/
|
|
3843
4425
|
export interface ListServicePipelineProvisionedResourcesInput {
|
|
3844
4426
|
/**
|
|
4427
|
+
* @public
|
|
3845
4428
|
* <p>The name of the service whose pipeline's provisioned resources you want.</p>
|
|
3846
4429
|
*/
|
|
3847
4430
|
serviceName: string | undefined;
|
|
3848
4431
|
/**
|
|
4432
|
+
* @public
|
|
3849
4433
|
* <p>A token that indicates the location of the next provisioned resource in the array of
|
|
3850
4434
|
* provisioned resources, after the list of provisioned resources that was previously
|
|
3851
4435
|
* requested.</p>
|
|
@@ -3857,11 +4441,13 @@ export interface ListServicePipelineProvisionedResourcesInput {
|
|
|
3857
4441
|
*/
|
|
3858
4442
|
export interface ListServicePipelineProvisionedResourcesOutput {
|
|
3859
4443
|
/**
|
|
4444
|
+
* @public
|
|
3860
4445
|
* <p>A token that indicates the location of the next provisioned resource in the array of
|
|
3861
4446
|
* provisioned resources, after the current requested list of provisioned resources.</p>
|
|
3862
4447
|
*/
|
|
3863
4448
|
nextToken?: string;
|
|
3864
4449
|
/**
|
|
4450
|
+
* @public
|
|
3865
4451
|
* <p>An array of provisioned resources for a service and pipeline.</p>
|
|
3866
4452
|
*/
|
|
3867
4453
|
provisionedResources: ProvisionedResource[] | undefined;
|
|
@@ -3871,14 +4457,17 @@ export interface ListServicePipelineProvisionedResourcesOutput {
|
|
|
3871
4457
|
*/
|
|
3872
4458
|
export interface UpdateServicePipelineInput {
|
|
3873
4459
|
/**
|
|
4460
|
+
* @public
|
|
3874
4461
|
* <p>The name of the service to that the pipeline is associated with.</p>
|
|
3875
4462
|
*/
|
|
3876
4463
|
serviceName: string | undefined;
|
|
3877
4464
|
/**
|
|
4465
|
+
* @public
|
|
3878
4466
|
* <p>The spec for the service pipeline to update.</p>
|
|
3879
4467
|
*/
|
|
3880
4468
|
spec: string | undefined;
|
|
3881
4469
|
/**
|
|
4470
|
+
* @public
|
|
3882
4471
|
* <p>The deployment type.</p>
|
|
3883
4472
|
* <p>There are four modes for updating a service pipeline. The <code>deploymentType</code>
|
|
3884
4473
|
* field defines the mode.</p>
|
|
@@ -3923,11 +4512,13 @@ export interface UpdateServicePipelineInput {
|
|
|
3923
4512
|
*/
|
|
3924
4513
|
deploymentType: DeploymentUpdateType | string | undefined;
|
|
3925
4514
|
/**
|
|
4515
|
+
* @public
|
|
3926
4516
|
* <p>The major version of the service template that was used to create the service that the
|
|
3927
4517
|
* pipeline is associated with.</p>
|
|
3928
4518
|
*/
|
|
3929
4519
|
templateMajorVersion?: string;
|
|
3930
4520
|
/**
|
|
4521
|
+
* @public
|
|
3931
4522
|
* <p>The minor version of the service template that was used to create the service that the
|
|
3932
4523
|
* pipeline is associated with.</p>
|
|
3933
4524
|
*/
|
|
@@ -3938,6 +4529,7 @@ export interface UpdateServicePipelineInput {
|
|
|
3938
4529
|
*/
|
|
3939
4530
|
export interface UpdateServicePipelineOutput {
|
|
3940
4531
|
/**
|
|
4532
|
+
* @public
|
|
3941
4533
|
* <p>The pipeline details that are returned by Proton.</p>
|
|
3942
4534
|
*/
|
|
3943
4535
|
pipeline: ServicePipeline | undefined;
|
|
@@ -3947,26 +4539,32 @@ export interface UpdateServicePipelineOutput {
|
|
|
3947
4539
|
*/
|
|
3948
4540
|
export interface CreateServiceInput {
|
|
3949
4541
|
/**
|
|
4542
|
+
* @public
|
|
3950
4543
|
* <p>The service name.</p>
|
|
3951
4544
|
*/
|
|
3952
4545
|
name: string | undefined;
|
|
3953
4546
|
/**
|
|
4547
|
+
* @public
|
|
3954
4548
|
* <p>A description of the Proton service.</p>
|
|
3955
4549
|
*/
|
|
3956
4550
|
description?: string;
|
|
3957
4551
|
/**
|
|
4552
|
+
* @public
|
|
3958
4553
|
* <p>The name of the service template that's used to create the service.</p>
|
|
3959
4554
|
*/
|
|
3960
4555
|
templateName: string | undefined;
|
|
3961
4556
|
/**
|
|
4557
|
+
* @public
|
|
3962
4558
|
* <p>The major version of the service template that was used to create the service.</p>
|
|
3963
4559
|
*/
|
|
3964
4560
|
templateMajorVersion: string | undefined;
|
|
3965
4561
|
/**
|
|
4562
|
+
* @public
|
|
3966
4563
|
* <p>The minor version of the service template that was used to create the service.</p>
|
|
3967
4564
|
*/
|
|
3968
4565
|
templateMinorVersion?: string;
|
|
3969
4566
|
/**
|
|
4567
|
+
* @public
|
|
3970
4568
|
* <p>A link to a spec file that provides inputs as defined in the service template bundle
|
|
3971
4569
|
* schema file. The spec file is in YAML format. <i>Don’t</i> include pipeline
|
|
3972
4570
|
* inputs in the spec if your service template <i>doesn’t</i> include a service
|
|
@@ -3975,6 +4573,7 @@ export interface CreateServiceInput {
|
|
|
3975
4573
|
*/
|
|
3976
4574
|
spec: string | undefined;
|
|
3977
4575
|
/**
|
|
4576
|
+
* @public
|
|
3978
4577
|
* <p>The Amazon Resource Name (ARN) of the repository connection. For more information, see
|
|
3979
4578
|
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an
|
|
3980
4579
|
* AWS CodeStar connection</a> in the <i>Proton User Guide</i>.
|
|
@@ -3983,17 +4582,20 @@ export interface CreateServiceInput {
|
|
|
3983
4582
|
*/
|
|
3984
4583
|
repositoryConnectionArn?: string;
|
|
3985
4584
|
/**
|
|
4585
|
+
* @public
|
|
3986
4586
|
* <p>The ID of the code repository. <i>Don't</i> include this parameter if your
|
|
3987
4587
|
* service template <i>doesn't</i> include a service pipeline.</p>
|
|
3988
4588
|
*/
|
|
3989
4589
|
repositoryId?: string;
|
|
3990
4590
|
/**
|
|
4591
|
+
* @public
|
|
3991
4592
|
* <p>The name of the code repository branch that holds the code that's deployed in Proton.
|
|
3992
4593
|
* <i>Don't</i> include this parameter if your service template
|
|
3993
4594
|
* <i>doesn't</i> include a service pipeline.</p>
|
|
3994
4595
|
*/
|
|
3995
4596
|
branchName?: string;
|
|
3996
4597
|
/**
|
|
4598
|
+
* @public
|
|
3997
4599
|
* <p>An optional list of metadata items that you can associate with the Proton service. A tag is
|
|
3998
4600
|
* a key-value pair.</p>
|
|
3999
4601
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
@@ -4031,56 +4633,69 @@ export type ServiceStatus = (typeof ServiceStatus)[keyof typeof ServiceStatus];
|
|
|
4031
4633
|
*/
|
|
4032
4634
|
export interface Service {
|
|
4033
4635
|
/**
|
|
4636
|
+
* @public
|
|
4034
4637
|
* <p>The name of the service.</p>
|
|
4035
4638
|
*/
|
|
4036
4639
|
name: string | undefined;
|
|
4037
4640
|
/**
|
|
4641
|
+
* @public
|
|
4038
4642
|
* <p>A description of the service.</p>
|
|
4039
4643
|
*/
|
|
4040
4644
|
description?: string;
|
|
4041
4645
|
/**
|
|
4646
|
+
* @public
|
|
4042
4647
|
* <p>The Amazon Resource Name (ARN) of the service.</p>
|
|
4043
4648
|
*/
|
|
4044
4649
|
arn: string | undefined;
|
|
4045
4650
|
/**
|
|
4651
|
+
* @public
|
|
4046
4652
|
* <p>The name of the service template.</p>
|
|
4047
4653
|
*/
|
|
4048
4654
|
templateName: string | undefined;
|
|
4049
4655
|
/**
|
|
4656
|
+
* @public
|
|
4050
4657
|
* <p>The time when the service was created.</p>
|
|
4051
4658
|
*/
|
|
4052
4659
|
createdAt: Date | undefined;
|
|
4053
4660
|
/**
|
|
4661
|
+
* @public
|
|
4054
4662
|
* <p>The time when the service was last modified.</p>
|
|
4055
4663
|
*/
|
|
4056
4664
|
lastModifiedAt: Date | undefined;
|
|
4057
4665
|
/**
|
|
4666
|
+
* @public
|
|
4058
4667
|
* <p>The status of the service.</p>
|
|
4059
4668
|
*/
|
|
4060
4669
|
status: ServiceStatus | string | undefined;
|
|
4061
4670
|
/**
|
|
4671
|
+
* @public
|
|
4062
4672
|
* <p>A service status message.</p>
|
|
4063
4673
|
*/
|
|
4064
4674
|
statusMessage?: string;
|
|
4065
4675
|
/**
|
|
4676
|
+
* @public
|
|
4066
4677
|
* <p>The formatted specification that defines the service.</p>
|
|
4067
4678
|
*/
|
|
4068
4679
|
spec: string | undefined;
|
|
4069
4680
|
/**
|
|
4681
|
+
* @public
|
|
4070
4682
|
* <p>The service pipeline detail data.</p>
|
|
4071
4683
|
*/
|
|
4072
4684
|
pipeline?: ServicePipeline;
|
|
4073
4685
|
/**
|
|
4686
|
+
* @public
|
|
4074
4687
|
* <p>The Amazon Resource Name (ARN) of the repository connection. For more information, see
|
|
4075
4688
|
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an
|
|
4076
4689
|
* AWS CodeStar connection</a> in the <i>Proton User Guide</i>.</p>
|
|
4077
4690
|
*/
|
|
4078
4691
|
repositoryConnectionArn?: string;
|
|
4079
4692
|
/**
|
|
4693
|
+
* @public
|
|
4080
4694
|
* <p>The ID of the source code repository.</p>
|
|
4081
4695
|
*/
|
|
4082
4696
|
repositoryId?: string;
|
|
4083
4697
|
/**
|
|
4698
|
+
* @public
|
|
4084
4699
|
* <p>The name of the code repository branch that holds the code that's deployed in
|
|
4085
4700
|
* Proton.</p>
|
|
4086
4701
|
*/
|
|
@@ -4091,6 +4706,7 @@ export interface Service {
|
|
|
4091
4706
|
*/
|
|
4092
4707
|
export interface CreateServiceOutput {
|
|
4093
4708
|
/**
|
|
4709
|
+
* @public
|
|
4094
4710
|
* <p>The service detail data that's returned by Proton.</p>
|
|
4095
4711
|
*/
|
|
4096
4712
|
service: Service | undefined;
|
|
@@ -4100,6 +4716,7 @@ export interface CreateServiceOutput {
|
|
|
4100
4716
|
*/
|
|
4101
4717
|
export interface DeleteServiceInput {
|
|
4102
4718
|
/**
|
|
4719
|
+
* @public
|
|
4103
4720
|
* <p>The name of the service to delete.</p>
|
|
4104
4721
|
*/
|
|
4105
4722
|
name: string | undefined;
|
|
@@ -4109,6 +4726,7 @@ export interface DeleteServiceInput {
|
|
|
4109
4726
|
*/
|
|
4110
4727
|
export interface DeleteServiceOutput {
|
|
4111
4728
|
/**
|
|
4729
|
+
* @public
|
|
4112
4730
|
* <p>The detailed data of the service being deleted.</p>
|
|
4113
4731
|
*/
|
|
4114
4732
|
service?: Service;
|
|
@@ -4118,6 +4736,7 @@ export interface DeleteServiceOutput {
|
|
|
4118
4736
|
*/
|
|
4119
4737
|
export interface GetServiceInput {
|
|
4120
4738
|
/**
|
|
4739
|
+
* @public
|
|
4121
4740
|
* <p>The name of the service that you want to get the detailed data for.</p>
|
|
4122
4741
|
*/
|
|
4123
4742
|
name: string | undefined;
|
|
@@ -4127,6 +4746,7 @@ export interface GetServiceInput {
|
|
|
4127
4746
|
*/
|
|
4128
4747
|
export interface GetServiceOutput {
|
|
4129
4748
|
/**
|
|
4749
|
+
* @public
|
|
4130
4750
|
* <p>The detailed data of the requested service.</p>
|
|
4131
4751
|
*/
|
|
4132
4752
|
service?: Service;
|
|
@@ -4136,11 +4756,13 @@ export interface GetServiceOutput {
|
|
|
4136
4756
|
*/
|
|
4137
4757
|
export interface ListServicesInput {
|
|
4138
4758
|
/**
|
|
4759
|
+
* @public
|
|
4139
4760
|
* <p>A token that indicates the location of the next service in the array of services, after
|
|
4140
4761
|
* the list of services that was previously requested.</p>
|
|
4141
4762
|
*/
|
|
4142
4763
|
nextToken?: string;
|
|
4143
4764
|
/**
|
|
4765
|
+
* @public
|
|
4144
4766
|
* <p>The maximum number of services to list.</p>
|
|
4145
4767
|
*/
|
|
4146
4768
|
maxResults?: number;
|
|
@@ -4151,34 +4773,42 @@ export interface ListServicesInput {
|
|
|
4151
4773
|
*/
|
|
4152
4774
|
export interface ServiceSummary {
|
|
4153
4775
|
/**
|
|
4776
|
+
* @public
|
|
4154
4777
|
* <p>The name of the service.</p>
|
|
4155
4778
|
*/
|
|
4156
4779
|
name: string | undefined;
|
|
4157
4780
|
/**
|
|
4781
|
+
* @public
|
|
4158
4782
|
* <p>A description of the service.</p>
|
|
4159
4783
|
*/
|
|
4160
4784
|
description?: string;
|
|
4161
4785
|
/**
|
|
4786
|
+
* @public
|
|
4162
4787
|
* <p>The Amazon Resource Name (ARN) of the service.</p>
|
|
4163
4788
|
*/
|
|
4164
4789
|
arn: string | undefined;
|
|
4165
4790
|
/**
|
|
4791
|
+
* @public
|
|
4166
4792
|
* <p>The name of the service template.</p>
|
|
4167
4793
|
*/
|
|
4168
4794
|
templateName: string | undefined;
|
|
4169
4795
|
/**
|
|
4796
|
+
* @public
|
|
4170
4797
|
* <p>The time when the service was created.</p>
|
|
4171
4798
|
*/
|
|
4172
4799
|
createdAt: Date | undefined;
|
|
4173
4800
|
/**
|
|
4801
|
+
* @public
|
|
4174
4802
|
* <p>The time when the service was last modified.</p>
|
|
4175
4803
|
*/
|
|
4176
4804
|
lastModifiedAt: Date | undefined;
|
|
4177
4805
|
/**
|
|
4806
|
+
* @public
|
|
4178
4807
|
* <p>The status of the service.</p>
|
|
4179
4808
|
*/
|
|
4180
4809
|
status: ServiceStatus | string | undefined;
|
|
4181
4810
|
/**
|
|
4811
|
+
* @public
|
|
4182
4812
|
* <p>A service status message.</p>
|
|
4183
4813
|
*/
|
|
4184
4814
|
statusMessage?: string;
|
|
@@ -4188,11 +4818,13 @@ export interface ServiceSummary {
|
|
|
4188
4818
|
*/
|
|
4189
4819
|
export interface ListServicesOutput {
|
|
4190
4820
|
/**
|
|
4821
|
+
* @public
|
|
4191
4822
|
* <p>A token that indicates the location of the next service in the array of services, after
|
|
4192
4823
|
* the current requested list of services.</p>
|
|
4193
4824
|
*/
|
|
4194
4825
|
nextToken?: string;
|
|
4195
4826
|
/**
|
|
4827
|
+
* @public
|
|
4196
4828
|
* <p>An array of services with summaries of detail data.</p>
|
|
4197
4829
|
*/
|
|
4198
4830
|
services: ServiceSummary[] | undefined;
|
|
@@ -4202,14 +4834,17 @@ export interface ListServicesOutput {
|
|
|
4202
4834
|
*/
|
|
4203
4835
|
export interface UpdateServiceInput {
|
|
4204
4836
|
/**
|
|
4837
|
+
* @public
|
|
4205
4838
|
* <p>The name of the service to edit.</p>
|
|
4206
4839
|
*/
|
|
4207
4840
|
name: string | undefined;
|
|
4208
4841
|
/**
|
|
4842
|
+
* @public
|
|
4209
4843
|
* <p>The edited service description.</p>
|
|
4210
4844
|
*/
|
|
4211
4845
|
description?: string;
|
|
4212
4846
|
/**
|
|
4847
|
+
* @public
|
|
4213
4848
|
* <p>Lists the service instances to add and the existing service instances to remain. Omit the
|
|
4214
4849
|
* existing service instances to delete from the list. <i>Don't</i> include edits
|
|
4215
4850
|
* to the existing service instances or pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html">Edit a service</a>
|
|
@@ -4222,6 +4857,7 @@ export interface UpdateServiceInput {
|
|
|
4222
4857
|
*/
|
|
4223
4858
|
export interface UpdateServiceOutput {
|
|
4224
4859
|
/**
|
|
4860
|
+
* @public
|
|
4225
4861
|
* <p>The service detail data that's returned by Proton.</p>
|
|
4226
4862
|
*/
|
|
4227
4863
|
service: Service | undefined;
|
|
@@ -4231,11 +4867,13 @@ export interface UpdateServiceOutput {
|
|
|
4231
4867
|
*/
|
|
4232
4868
|
export interface GetServiceSyncBlockerSummaryInput {
|
|
4233
4869
|
/**
|
|
4870
|
+
* @public
|
|
4234
4871
|
* <p>The name of the service that you want to get the service sync blocker summary for. If
|
|
4235
4872
|
* given only the service name, all instances are blocked.</p>
|
|
4236
4873
|
*/
|
|
4237
4874
|
serviceName: string | undefined;
|
|
4238
4875
|
/**
|
|
4876
|
+
* @public
|
|
4239
4877
|
* <p>The name of the service instance that you want to get the service sync blocker summary
|
|
4240
4878
|
* for. If given bothe the instance name and the service name, only the instance is
|
|
4241
4879
|
* blocked.</p>
|
|
@@ -4248,10 +4886,12 @@ export interface GetServiceSyncBlockerSummaryInput {
|
|
|
4248
4886
|
*/
|
|
4249
4887
|
export interface SyncBlockerContext {
|
|
4250
4888
|
/**
|
|
4889
|
+
* @public
|
|
4251
4890
|
* <p>The key for the sync blocker context.</p>
|
|
4252
4891
|
*/
|
|
4253
4892
|
key: string | undefined;
|
|
4254
4893
|
/**
|
|
4894
|
+
* @public
|
|
4255
4895
|
* <p>The value of the sync blocker context.</p>
|
|
4256
4896
|
*/
|
|
4257
4897
|
value: string | undefined;
|
|
@@ -4285,34 +4925,42 @@ export type BlockerType = (typeof BlockerType)[keyof typeof BlockerType];
|
|
|
4285
4925
|
*/
|
|
4286
4926
|
export interface SyncBlocker {
|
|
4287
4927
|
/**
|
|
4928
|
+
* @public
|
|
4288
4929
|
* <p>The ID of the sync blocker.</p>
|
|
4289
4930
|
*/
|
|
4290
4931
|
id: string | undefined;
|
|
4291
4932
|
/**
|
|
4933
|
+
* @public
|
|
4292
4934
|
* <p>The type of the sync blocker.</p>
|
|
4293
4935
|
*/
|
|
4294
4936
|
type: BlockerType | string | undefined;
|
|
4295
4937
|
/**
|
|
4938
|
+
* @public
|
|
4296
4939
|
* <p>The status of the sync blocker.</p>
|
|
4297
4940
|
*/
|
|
4298
4941
|
status: BlockerStatus | string | undefined;
|
|
4299
4942
|
/**
|
|
4943
|
+
* @public
|
|
4300
4944
|
* <p>The reason why the sync blocker was created.</p>
|
|
4301
4945
|
*/
|
|
4302
4946
|
createdReason: string | undefined;
|
|
4303
4947
|
/**
|
|
4948
|
+
* @public
|
|
4304
4949
|
* <p>The time when the sync blocker was created.</p>
|
|
4305
4950
|
*/
|
|
4306
4951
|
createdAt: Date | undefined;
|
|
4307
4952
|
/**
|
|
4953
|
+
* @public
|
|
4308
4954
|
* <p>The contexts for the sync blocker.</p>
|
|
4309
4955
|
*/
|
|
4310
4956
|
contexts?: SyncBlockerContext[];
|
|
4311
4957
|
/**
|
|
4958
|
+
* @public
|
|
4312
4959
|
* <p>The reason the sync blocker was resolved.</p>
|
|
4313
4960
|
*/
|
|
4314
4961
|
resolvedReason?: string;
|
|
4315
4962
|
/**
|
|
4963
|
+
* @public
|
|
4316
4964
|
* <p>The time the sync blocker was resolved.</p>
|
|
4317
4965
|
*/
|
|
4318
4966
|
resolvedAt?: Date;
|
|
@@ -4326,6 +4974,7 @@ export interface SyncBlocker {
|
|
|
4326
4974
|
*/
|
|
4327
4975
|
export interface ServiceSyncBlockerSummary {
|
|
4328
4976
|
/**
|
|
4977
|
+
* @public
|
|
4329
4978
|
* <p>The name of the service that you want to get the sync blocker summary for. If given a
|
|
4330
4979
|
* service instance name and a service name, it will return the blockers only applying to the
|
|
4331
4980
|
* instance that is blocked.</p>
|
|
@@ -4336,11 +4985,13 @@ export interface ServiceSyncBlockerSummary {
|
|
|
4336
4985
|
*/
|
|
4337
4986
|
serviceName: string | undefined;
|
|
4338
4987
|
/**
|
|
4988
|
+
* @public
|
|
4339
4989
|
* <p>The name of the service instance that you want sync your service configuration
|
|
4340
4990
|
* with.</p>
|
|
4341
4991
|
*/
|
|
4342
4992
|
serviceInstanceName?: string;
|
|
4343
4993
|
/**
|
|
4994
|
+
* @public
|
|
4344
4995
|
* <p>The latest active blockers for the synced service.</p>
|
|
4345
4996
|
*/
|
|
4346
4997
|
latestBlockers?: SyncBlocker[];
|
|
@@ -4350,6 +5001,7 @@ export interface ServiceSyncBlockerSummary {
|
|
|
4350
5001
|
*/
|
|
4351
5002
|
export interface GetServiceSyncBlockerSummaryOutput {
|
|
4352
5003
|
/**
|
|
5004
|
+
* @public
|
|
4353
5005
|
* <p>The detailed data of the requested service sync blocker summary.</p>
|
|
4354
5006
|
*/
|
|
4355
5007
|
serviceSyncBlockerSummary?: ServiceSyncBlockerSummary;
|
|
@@ -4359,10 +5011,12 @@ export interface GetServiceSyncBlockerSummaryOutput {
|
|
|
4359
5011
|
*/
|
|
4360
5012
|
export interface UpdateServiceSyncBlockerInput {
|
|
4361
5013
|
/**
|
|
5014
|
+
* @public
|
|
4362
5015
|
* <p>The ID of the service sync blocker.</p>
|
|
4363
5016
|
*/
|
|
4364
5017
|
id: string | undefined;
|
|
4365
5018
|
/**
|
|
5019
|
+
* @public
|
|
4366
5020
|
* <p>The reason the service sync blocker was resolved.</p>
|
|
4367
5021
|
*/
|
|
4368
5022
|
resolvedReason: string | undefined;
|
|
@@ -4372,15 +5026,18 @@ export interface UpdateServiceSyncBlockerInput {
|
|
|
4372
5026
|
*/
|
|
4373
5027
|
export interface UpdateServiceSyncBlockerOutput {
|
|
4374
5028
|
/**
|
|
5029
|
+
* @public
|
|
4375
5030
|
* <p>The name of the service that you want to update the service sync blocker for.</p>
|
|
4376
5031
|
*/
|
|
4377
5032
|
serviceName: string | undefined;
|
|
4378
5033
|
/**
|
|
5034
|
+
* @public
|
|
4379
5035
|
* <p>The name of the service instance that you want to update the service sync blocker
|
|
4380
5036
|
* for.</p>
|
|
4381
5037
|
*/
|
|
4382
5038
|
serviceInstanceName?: string;
|
|
4383
5039
|
/**
|
|
5040
|
+
* @public
|
|
4384
5041
|
* <p>The detailed data on the service sync blocker that was updated.</p>
|
|
4385
5042
|
*/
|
|
4386
5043
|
serviceSyncBlocker: SyncBlocker | undefined;
|
|
@@ -4390,22 +5047,27 @@ export interface UpdateServiceSyncBlockerOutput {
|
|
|
4390
5047
|
*/
|
|
4391
5048
|
export interface CreateServiceSyncConfigInput {
|
|
4392
5049
|
/**
|
|
5050
|
+
* @public
|
|
4393
5051
|
* <p>The name of the service the Proton Ops file is for.</p>
|
|
4394
5052
|
*/
|
|
4395
5053
|
serviceName: string | undefined;
|
|
4396
5054
|
/**
|
|
5055
|
+
* @public
|
|
4397
5056
|
* <p>The provider type for your repository.</p>
|
|
4398
5057
|
*/
|
|
4399
5058
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
4400
5059
|
/**
|
|
5060
|
+
* @public
|
|
4401
5061
|
* <p>The repository name.</p>
|
|
4402
5062
|
*/
|
|
4403
5063
|
repositoryName: string | undefined;
|
|
4404
5064
|
/**
|
|
5065
|
+
* @public
|
|
4405
5066
|
* <p>The repository branch for your Proton Ops file.</p>
|
|
4406
5067
|
*/
|
|
4407
5068
|
branch: string | undefined;
|
|
4408
5069
|
/**
|
|
5070
|
+
* @public
|
|
4409
5071
|
* <p>The path to the Proton Ops file.</p>
|
|
4410
5072
|
*/
|
|
4411
5073
|
filePath: string | undefined;
|
|
@@ -4416,25 +5078,30 @@ export interface CreateServiceSyncConfigInput {
|
|
|
4416
5078
|
*/
|
|
4417
5079
|
export interface ServiceSyncConfig {
|
|
4418
5080
|
/**
|
|
5081
|
+
* @public
|
|
4419
5082
|
* <p>The name of the service that the service instance is added to.</p>
|
|
4420
5083
|
*/
|
|
4421
5084
|
serviceName: string | undefined;
|
|
4422
5085
|
/**
|
|
5086
|
+
* @public
|
|
4423
5087
|
* <p>The name of the repository provider that holds the repository Proton will sync
|
|
4424
5088
|
* with.</p>
|
|
4425
5089
|
*/
|
|
4426
5090
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
4427
5091
|
/**
|
|
5092
|
+
* @public
|
|
4428
5093
|
* <p>The name of the code repository that holds the service code Proton will sync
|
|
4429
5094
|
* with.</p>
|
|
4430
5095
|
*/
|
|
4431
5096
|
repositoryName: string | undefined;
|
|
4432
5097
|
/**
|
|
5098
|
+
* @public
|
|
4433
5099
|
* <p>The name of the code repository branch that holds the service code Proton will sync
|
|
4434
5100
|
* with.</p>
|
|
4435
5101
|
*/
|
|
4436
5102
|
branch: string | undefined;
|
|
4437
5103
|
/**
|
|
5104
|
+
* @public
|
|
4438
5105
|
* <p>The file path to the service sync configuration file.</p>
|
|
4439
5106
|
*/
|
|
4440
5107
|
filePath: string | undefined;
|
|
@@ -4444,6 +5111,7 @@ export interface ServiceSyncConfig {
|
|
|
4444
5111
|
*/
|
|
4445
5112
|
export interface CreateServiceSyncConfigOutput {
|
|
4446
5113
|
/**
|
|
5114
|
+
* @public
|
|
4447
5115
|
* <p>The detailed data of the Proton Ops file.</p>
|
|
4448
5116
|
*/
|
|
4449
5117
|
serviceSyncConfig?: ServiceSyncConfig;
|
|
@@ -4453,6 +5121,7 @@ export interface CreateServiceSyncConfigOutput {
|
|
|
4453
5121
|
*/
|
|
4454
5122
|
export interface DeleteServiceSyncConfigInput {
|
|
4455
5123
|
/**
|
|
5124
|
+
* @public
|
|
4456
5125
|
* <p>The name of the service that you want to delete the service sync configuration for.</p>
|
|
4457
5126
|
*/
|
|
4458
5127
|
serviceName: string | undefined;
|
|
@@ -4462,6 +5131,7 @@ export interface DeleteServiceSyncConfigInput {
|
|
|
4462
5131
|
*/
|
|
4463
5132
|
export interface DeleteServiceSyncConfigOutput {
|
|
4464
5133
|
/**
|
|
5134
|
+
* @public
|
|
4465
5135
|
* <p>The detailed data for the service sync config.</p>
|
|
4466
5136
|
*/
|
|
4467
5137
|
serviceSyncConfig?: ServiceSyncConfig;
|
|
@@ -4471,6 +5141,7 @@ export interface DeleteServiceSyncConfigOutput {
|
|
|
4471
5141
|
*/
|
|
4472
5142
|
export interface GetServiceSyncConfigInput {
|
|
4473
5143
|
/**
|
|
5144
|
+
* @public
|
|
4474
5145
|
* <p>The name of the service that you want to get the service sync configuration for.</p>
|
|
4475
5146
|
*/
|
|
4476
5147
|
serviceName: string | undefined;
|
|
@@ -4480,6 +5151,7 @@ export interface GetServiceSyncConfigInput {
|
|
|
4480
5151
|
*/
|
|
4481
5152
|
export interface GetServiceSyncConfigOutput {
|
|
4482
5153
|
/**
|
|
5154
|
+
* @public
|
|
4483
5155
|
* <p>The detailed data of the requested service sync configuration.</p>
|
|
4484
5156
|
*/
|
|
4485
5157
|
serviceSyncConfig?: ServiceSyncConfig;
|
|
@@ -4489,22 +5161,27 @@ export interface GetServiceSyncConfigOutput {
|
|
|
4489
5161
|
*/
|
|
4490
5162
|
export interface UpdateServiceSyncConfigInput {
|
|
4491
5163
|
/**
|
|
5164
|
+
* @public
|
|
4492
5165
|
* <p>The name of the service the Proton Ops file is for.</p>
|
|
4493
5166
|
*/
|
|
4494
5167
|
serviceName: string | undefined;
|
|
4495
5168
|
/**
|
|
5169
|
+
* @public
|
|
4496
5170
|
* <p>The name of the repository provider where the Proton Ops file is found.</p>
|
|
4497
5171
|
*/
|
|
4498
5172
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
4499
5173
|
/**
|
|
5174
|
+
* @public
|
|
4500
5175
|
* <p>The name of the repository where the Proton Ops file is found.</p>
|
|
4501
5176
|
*/
|
|
4502
5177
|
repositoryName: string | undefined;
|
|
4503
5178
|
/**
|
|
5179
|
+
* @public
|
|
4504
5180
|
* <p>The name of the code repository branch where the Proton Ops file is found.</p>
|
|
4505
5181
|
*/
|
|
4506
5182
|
branch: string | undefined;
|
|
4507
5183
|
/**
|
|
5184
|
+
* @public
|
|
4508
5185
|
* <p>The path to the Proton Ops file.</p>
|
|
4509
5186
|
*/
|
|
4510
5187
|
filePath: string | undefined;
|
|
@@ -4514,6 +5191,7 @@ export interface UpdateServiceSyncConfigInput {
|
|
|
4514
5191
|
*/
|
|
4515
5192
|
export interface UpdateServiceSyncConfigOutput {
|
|
4516
5193
|
/**
|
|
5194
|
+
* @public
|
|
4517
5195
|
* <p>The detailed data of the Proton Ops file.</p>
|
|
4518
5196
|
*/
|
|
4519
5197
|
serviceSyncConfig?: ServiceSyncConfig;
|
|
@@ -4523,22 +5201,27 @@ export interface UpdateServiceSyncConfigOutput {
|
|
|
4523
5201
|
*/
|
|
4524
5202
|
export interface CreateServiceTemplateInput {
|
|
4525
5203
|
/**
|
|
5204
|
+
* @public
|
|
4526
5205
|
* <p>The name of the service template.</p>
|
|
4527
5206
|
*/
|
|
4528
5207
|
name: string | undefined;
|
|
4529
5208
|
/**
|
|
5209
|
+
* @public
|
|
4530
5210
|
* <p>The name of the service template as displayed in the developer interface.</p>
|
|
4531
5211
|
*/
|
|
4532
5212
|
displayName?: string;
|
|
4533
5213
|
/**
|
|
5214
|
+
* @public
|
|
4534
5215
|
* <p>A description of the service template.</p>
|
|
4535
5216
|
*/
|
|
4536
5217
|
description?: string;
|
|
4537
5218
|
/**
|
|
5219
|
+
* @public
|
|
4538
5220
|
* <p>A customer provided encryption key that's used to encrypt data.</p>
|
|
4539
5221
|
*/
|
|
4540
5222
|
encryptionKey?: string;
|
|
4541
5223
|
/**
|
|
5224
|
+
* @public
|
|
4542
5225
|
* <p>By default, Proton provides a service pipeline for your service. When this parameter is
|
|
4543
5226
|
* included, it indicates that an Proton service pipeline <i>isn't</i> provided
|
|
4544
5227
|
* for your service. After it's included, it <i>can't</i> be changed. For more
|
|
@@ -4547,6 +5230,7 @@ export interface CreateServiceTemplateInput {
|
|
|
4547
5230
|
*/
|
|
4548
5231
|
pipelineProvisioning?: Provisioning | string;
|
|
4549
5232
|
/**
|
|
5233
|
+
* @public
|
|
4550
5234
|
* <p>An optional list of metadata items that you can associate with the Proton service template.
|
|
4551
5235
|
* A tag is a key-value pair.</p>
|
|
4552
5236
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
@@ -4560,38 +5244,47 @@ export interface CreateServiceTemplateInput {
|
|
|
4560
5244
|
*/
|
|
4561
5245
|
export interface ServiceTemplate {
|
|
4562
5246
|
/**
|
|
5247
|
+
* @public
|
|
4563
5248
|
* <p>The name of the service template.</p>
|
|
4564
5249
|
*/
|
|
4565
5250
|
name: string | undefined;
|
|
4566
5251
|
/**
|
|
5252
|
+
* @public
|
|
4567
5253
|
* <p>The Amazon Resource Name (ARN) of the service template.</p>
|
|
4568
5254
|
*/
|
|
4569
5255
|
arn: string | undefined;
|
|
4570
5256
|
/**
|
|
5257
|
+
* @public
|
|
4571
5258
|
* <p>The time when the service template was created.</p>
|
|
4572
5259
|
*/
|
|
4573
5260
|
createdAt: Date | undefined;
|
|
4574
5261
|
/**
|
|
5262
|
+
* @public
|
|
4575
5263
|
* <p>The time when the service template was last modified.</p>
|
|
4576
5264
|
*/
|
|
4577
5265
|
lastModifiedAt: Date | undefined;
|
|
4578
5266
|
/**
|
|
5267
|
+
* @public
|
|
4579
5268
|
* <p>The service template name as displayed in the developer interface.</p>
|
|
4580
5269
|
*/
|
|
4581
5270
|
displayName?: string;
|
|
4582
5271
|
/**
|
|
5272
|
+
* @public
|
|
4583
5273
|
* <p>A description of the service template.</p>
|
|
4584
5274
|
*/
|
|
4585
5275
|
description?: string;
|
|
4586
5276
|
/**
|
|
5277
|
+
* @public
|
|
4587
5278
|
* <p>The recommended version of the service template.</p>
|
|
4588
5279
|
*/
|
|
4589
5280
|
recommendedVersion?: string;
|
|
4590
5281
|
/**
|
|
5282
|
+
* @public
|
|
4591
5283
|
* <p>The customer provided service template encryption key that's used to encrypt data.</p>
|
|
4592
5284
|
*/
|
|
4593
5285
|
encryptionKey?: string;
|
|
4594
5286
|
/**
|
|
5287
|
+
* @public
|
|
4595
5288
|
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included
|
|
4596
5289
|
* in the service template. Otherwise, a service pipeline <i>isn't</i> included in
|
|
4597
5290
|
* the service template.</p>
|
|
@@ -4603,6 +5296,7 @@ export interface ServiceTemplate {
|
|
|
4603
5296
|
*/
|
|
4604
5297
|
export interface CreateServiceTemplateOutput {
|
|
4605
5298
|
/**
|
|
5299
|
+
* @public
|
|
4606
5300
|
* <p>The service template detail data that's returned by Proton.</p>
|
|
4607
5301
|
*/
|
|
4608
5302
|
serviceTemplate: ServiceTemplate | undefined;
|
|
@@ -4612,6 +5306,7 @@ export interface CreateServiceTemplateOutput {
|
|
|
4612
5306
|
*/
|
|
4613
5307
|
export interface DeleteServiceTemplateInput {
|
|
4614
5308
|
/**
|
|
5309
|
+
* @public
|
|
4615
5310
|
* <p>The name of the service template to delete.</p>
|
|
4616
5311
|
*/
|
|
4617
5312
|
name: string | undefined;
|
|
@@ -4621,6 +5316,7 @@ export interface DeleteServiceTemplateInput {
|
|
|
4621
5316
|
*/
|
|
4622
5317
|
export interface DeleteServiceTemplateOutput {
|
|
4623
5318
|
/**
|
|
5319
|
+
* @public
|
|
4624
5320
|
* <p>The detailed data of the service template being deleted.</p>
|
|
4625
5321
|
*/
|
|
4626
5322
|
serviceTemplate?: ServiceTemplate;
|
|
@@ -4630,6 +5326,7 @@ export interface DeleteServiceTemplateOutput {
|
|
|
4630
5326
|
*/
|
|
4631
5327
|
export interface GetServiceTemplateInput {
|
|
4632
5328
|
/**
|
|
5329
|
+
* @public
|
|
4633
5330
|
* <p>The name of the service template that you want to get detailed data for.</p>
|
|
4634
5331
|
*/
|
|
4635
5332
|
name: string | undefined;
|
|
@@ -4639,6 +5336,7 @@ export interface GetServiceTemplateInput {
|
|
|
4639
5336
|
*/
|
|
4640
5337
|
export interface GetServiceTemplateOutput {
|
|
4641
5338
|
/**
|
|
5339
|
+
* @public
|
|
4642
5340
|
* <p>The detailed data of the requested service template.</p>
|
|
4643
5341
|
*/
|
|
4644
5342
|
serviceTemplate: ServiceTemplate | undefined;
|
|
@@ -4648,11 +5346,13 @@ export interface GetServiceTemplateOutput {
|
|
|
4648
5346
|
*/
|
|
4649
5347
|
export interface ListServiceTemplatesInput {
|
|
4650
5348
|
/**
|
|
5349
|
+
* @public
|
|
4651
5350
|
* <p>A token that indicates the location of the next service template in the array of service
|
|
4652
5351
|
* templates, after the list of service templates previously requested.</p>
|
|
4653
5352
|
*/
|
|
4654
5353
|
nextToken?: string;
|
|
4655
5354
|
/**
|
|
5355
|
+
* @public
|
|
4656
5356
|
* <p>The maximum number of service templates to list.</p>
|
|
4657
5357
|
*/
|
|
4658
5358
|
maxResults?: number;
|
|
@@ -4663,34 +5363,42 @@ export interface ListServiceTemplatesInput {
|
|
|
4663
5363
|
*/
|
|
4664
5364
|
export interface ServiceTemplateSummary {
|
|
4665
5365
|
/**
|
|
5366
|
+
* @public
|
|
4666
5367
|
* <p>The name of the service template.</p>
|
|
4667
5368
|
*/
|
|
4668
5369
|
name: string | undefined;
|
|
4669
5370
|
/**
|
|
5371
|
+
* @public
|
|
4670
5372
|
* <p>The Amazon Resource Name (ARN) of the service template.</p>
|
|
4671
5373
|
*/
|
|
4672
5374
|
arn: string | undefined;
|
|
4673
5375
|
/**
|
|
5376
|
+
* @public
|
|
4674
5377
|
* <p>The time when the service template was created.</p>
|
|
4675
5378
|
*/
|
|
4676
5379
|
createdAt: Date | undefined;
|
|
4677
5380
|
/**
|
|
5381
|
+
* @public
|
|
4678
5382
|
* <p>The time when the service template was last modified.</p>
|
|
4679
5383
|
*/
|
|
4680
5384
|
lastModifiedAt: Date | undefined;
|
|
4681
5385
|
/**
|
|
5386
|
+
* @public
|
|
4682
5387
|
* <p>The service template name as displayed in the developer interface.</p>
|
|
4683
5388
|
*/
|
|
4684
5389
|
displayName?: string;
|
|
4685
5390
|
/**
|
|
5391
|
+
* @public
|
|
4686
5392
|
* <p>A description of the service template.</p>
|
|
4687
5393
|
*/
|
|
4688
5394
|
description?: string;
|
|
4689
5395
|
/**
|
|
5396
|
+
* @public
|
|
4690
5397
|
* <p>The recommended version of the service template.</p>
|
|
4691
5398
|
*/
|
|
4692
5399
|
recommendedVersion?: string;
|
|
4693
5400
|
/**
|
|
5401
|
+
* @public
|
|
4694
5402
|
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included
|
|
4695
5403
|
* in the service template, otherwise a service pipeline <i>isn't</i> included in
|
|
4696
5404
|
* the service template.</p>
|
|
@@ -4702,11 +5410,13 @@ export interface ServiceTemplateSummary {
|
|
|
4702
5410
|
*/
|
|
4703
5411
|
export interface ListServiceTemplatesOutput {
|
|
4704
5412
|
/**
|
|
5413
|
+
* @public
|
|
4705
5414
|
* <p>A token that indicates the location of the next service template in the array of service
|
|
4706
5415
|
* templates, after the current requested list of service templates.</p>
|
|
4707
5416
|
*/
|
|
4708
5417
|
nextToken?: string;
|
|
4709
5418
|
/**
|
|
5419
|
+
* @public
|
|
4710
5420
|
* <p>An array of service templates with detail data.</p>
|
|
4711
5421
|
*/
|
|
4712
5422
|
templates: ServiceTemplateSummary[] | undefined;
|
|
@@ -4716,15 +5426,18 @@ export interface ListServiceTemplatesOutput {
|
|
|
4716
5426
|
*/
|
|
4717
5427
|
export interface UpdateServiceTemplateInput {
|
|
4718
5428
|
/**
|
|
5429
|
+
* @public
|
|
4719
5430
|
* <p>The name of the service template to update.</p>
|
|
4720
5431
|
*/
|
|
4721
5432
|
name: string | undefined;
|
|
4722
5433
|
/**
|
|
5434
|
+
* @public
|
|
4723
5435
|
* <p>The name of the service template to update that's displayed in the developer
|
|
4724
5436
|
* interface.</p>
|
|
4725
5437
|
*/
|
|
4726
5438
|
displayName?: string;
|
|
4727
5439
|
/**
|
|
5440
|
+
* @public
|
|
4728
5441
|
* <p>A description of the service template update.</p>
|
|
4729
5442
|
*/
|
|
4730
5443
|
description?: string;
|
|
@@ -4734,6 +5447,7 @@ export interface UpdateServiceTemplateInput {
|
|
|
4734
5447
|
*/
|
|
4735
5448
|
export interface UpdateServiceTemplateOutput {
|
|
4736
5449
|
/**
|
|
5450
|
+
* @public
|
|
4737
5451
|
* <p>The service template detail data that's returned by Proton.</p>
|
|
4738
5452
|
*/
|
|
4739
5453
|
serviceTemplate: ServiceTemplate | undefined;
|
|
@@ -4744,10 +5458,12 @@ export interface UpdateServiceTemplateOutput {
|
|
|
4744
5458
|
*/
|
|
4745
5459
|
export interface CompatibleEnvironmentTemplateInput {
|
|
4746
5460
|
/**
|
|
5461
|
+
* @public
|
|
4747
5462
|
* <p>The compatible environment template name.</p>
|
|
4748
5463
|
*/
|
|
4749
5464
|
templateName: string | undefined;
|
|
4750
5465
|
/**
|
|
5466
|
+
* @public
|
|
4751
5467
|
* <p>The major version of the compatible environment template.</p>
|
|
4752
5468
|
*/
|
|
4753
5469
|
majorVersion: string | undefined;
|
|
@@ -4768,19 +5484,23 @@ export type ServiceTemplateSupportedComponentSourceType = (typeof ServiceTemplat
|
|
|
4768
5484
|
*/
|
|
4769
5485
|
export interface CreateServiceTemplateVersionInput {
|
|
4770
5486
|
/**
|
|
5487
|
+
* @public
|
|
4771
5488
|
* <p>When included, if two identical requests are made with the same client token, Proton
|
|
4772
5489
|
* returns the service template version that the first request created.</p>
|
|
4773
5490
|
*/
|
|
4774
5491
|
clientToken?: string;
|
|
4775
5492
|
/**
|
|
5493
|
+
* @public
|
|
4776
5494
|
* <p>The name of the service template.</p>
|
|
4777
5495
|
*/
|
|
4778
5496
|
templateName: string | undefined;
|
|
4779
5497
|
/**
|
|
5498
|
+
* @public
|
|
4780
5499
|
* <p>A description of the new version of a service template.</p>
|
|
4781
5500
|
*/
|
|
4782
5501
|
description?: string;
|
|
4783
5502
|
/**
|
|
5503
|
+
* @public
|
|
4784
5504
|
* <p>To create a new minor version of the service template, include a <code>major
|
|
4785
5505
|
* Version</code>.</p>
|
|
4786
5506
|
* <p>To create a new major and minor version of the service template,
|
|
@@ -4789,17 +5509,20 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
4789
5509
|
*/
|
|
4790
5510
|
majorVersion?: string;
|
|
4791
5511
|
/**
|
|
5512
|
+
* @public
|
|
4792
5513
|
* <p>An object that includes the template bundle S3 bucket path and name for the new version of
|
|
4793
5514
|
* a service template.</p>
|
|
4794
5515
|
*/
|
|
4795
5516
|
source: TemplateVersionSourceInput | undefined;
|
|
4796
5517
|
/**
|
|
5518
|
+
* @public
|
|
4797
5519
|
* <p>An array of environment template objects that are compatible with the new service template
|
|
4798
5520
|
* version. A service instance based on this service template version can run in environments
|
|
4799
5521
|
* based on compatible templates.</p>
|
|
4800
5522
|
*/
|
|
4801
5523
|
compatibleEnvironmentTemplates: CompatibleEnvironmentTemplateInput[] | undefined;
|
|
4802
5524
|
/**
|
|
5525
|
+
* @public
|
|
4803
5526
|
* <p>An optional list of metadata items that you can associate with the Proton service template
|
|
4804
5527
|
* version. A tag is a key-value pair.</p>
|
|
4805
5528
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
@@ -4807,6 +5530,7 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
4807
5530
|
*/
|
|
4808
5531
|
tags?: Tag[];
|
|
4809
5532
|
/**
|
|
5533
|
+
* @public
|
|
4810
5534
|
* <p>An array of supported component sources. Components with supported sources can be attached
|
|
4811
5535
|
* to service instances based on this service template version.</p>
|
|
4812
5536
|
* <p>For more information about components, see
|
|
@@ -4821,10 +5545,12 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
4821
5545
|
*/
|
|
4822
5546
|
export interface CompatibleEnvironmentTemplate {
|
|
4823
5547
|
/**
|
|
5548
|
+
* @public
|
|
4824
5549
|
* <p>The compatible environment template name.</p>
|
|
4825
5550
|
*/
|
|
4826
5551
|
templateName: string | undefined;
|
|
4827
5552
|
/**
|
|
5553
|
+
* @public
|
|
4828
5554
|
* <p>The major version of the compatible environment template.</p>
|
|
4829
5555
|
*/
|
|
4830
5556
|
majorVersion: string | undefined;
|
|
@@ -4835,55 +5561,68 @@ export interface CompatibleEnvironmentTemplate {
|
|
|
4835
5561
|
*/
|
|
4836
5562
|
export interface ServiceTemplateVersion {
|
|
4837
5563
|
/**
|
|
5564
|
+
* @public
|
|
4838
5565
|
* <p>The name of the version of a service template.</p>
|
|
4839
5566
|
*/
|
|
4840
5567
|
templateName: string | undefined;
|
|
4841
5568
|
/**
|
|
5569
|
+
* @public
|
|
4842
5570
|
* <p>The latest major version that's associated with the version of a service template.</p>
|
|
4843
5571
|
*/
|
|
4844
5572
|
majorVersion: string | undefined;
|
|
4845
5573
|
/**
|
|
5574
|
+
* @public
|
|
4846
5575
|
* <p>The minor version of a service template.</p>
|
|
4847
5576
|
*/
|
|
4848
5577
|
minorVersion: string | undefined;
|
|
4849
5578
|
/**
|
|
5579
|
+
* @public
|
|
4850
5580
|
* <p>The recommended minor version of the service template.</p>
|
|
4851
5581
|
*/
|
|
4852
5582
|
recommendedMinorVersion?: string;
|
|
4853
5583
|
/**
|
|
5584
|
+
* @public
|
|
4854
5585
|
* <p>The service template version status.</p>
|
|
4855
5586
|
*/
|
|
4856
5587
|
status: TemplateVersionStatus | string | undefined;
|
|
4857
5588
|
/**
|
|
5589
|
+
* @public
|
|
4858
5590
|
* <p>A service template version status message.</p>
|
|
4859
5591
|
*/
|
|
4860
5592
|
statusMessage?: string;
|
|
4861
5593
|
/**
|
|
5594
|
+
* @public
|
|
4862
5595
|
* <p>A description of the version of a service template.</p>
|
|
4863
5596
|
*/
|
|
4864
5597
|
description?: string;
|
|
4865
5598
|
/**
|
|
5599
|
+
* @public
|
|
4866
5600
|
* <p>The Amazon Resource Name (ARN) of the version of a service template.</p>
|
|
4867
5601
|
*/
|
|
4868
5602
|
arn: string | undefined;
|
|
4869
5603
|
/**
|
|
5604
|
+
* @public
|
|
4870
5605
|
* <p>The time when the version of a service template was created.</p>
|
|
4871
5606
|
*/
|
|
4872
5607
|
createdAt: Date | undefined;
|
|
4873
5608
|
/**
|
|
5609
|
+
* @public
|
|
4874
5610
|
* <p>The time when the version of a service template was last modified.</p>
|
|
4875
5611
|
*/
|
|
4876
5612
|
lastModifiedAt: Date | undefined;
|
|
4877
5613
|
/**
|
|
5614
|
+
* @public
|
|
4878
5615
|
* <p>An array of compatible environment template names for the major version of a service
|
|
4879
5616
|
* template.</p>
|
|
4880
5617
|
*/
|
|
4881
5618
|
compatibleEnvironmentTemplates: CompatibleEnvironmentTemplate[] | undefined;
|
|
4882
5619
|
/**
|
|
5620
|
+
* @public
|
|
4883
5621
|
* <p>The schema of the version of a service template.</p>
|
|
4884
5622
|
*/
|
|
4885
5623
|
schema?: string;
|
|
4886
5624
|
/**
|
|
5625
|
+
* @public
|
|
4887
5626
|
* <p>An array of supported component sources. Components with supported sources can be attached
|
|
4888
5627
|
* to service instances based on this service template version.</p>
|
|
4889
5628
|
* <p>For more information about components, see
|
|
@@ -4897,6 +5636,7 @@ export interface ServiceTemplateVersion {
|
|
|
4897
5636
|
*/
|
|
4898
5637
|
export interface CreateServiceTemplateVersionOutput {
|
|
4899
5638
|
/**
|
|
5639
|
+
* @public
|
|
4900
5640
|
* <p>The service template version summary of detail data that's returned by Proton.</p>
|
|
4901
5641
|
*/
|
|
4902
5642
|
serviceTemplateVersion: ServiceTemplateVersion | undefined;
|
|
@@ -4906,14 +5646,17 @@ export interface CreateServiceTemplateVersionOutput {
|
|
|
4906
5646
|
*/
|
|
4907
5647
|
export interface DeleteServiceTemplateVersionInput {
|
|
4908
5648
|
/**
|
|
5649
|
+
* @public
|
|
4909
5650
|
* <p>The name of the service template.</p>
|
|
4910
5651
|
*/
|
|
4911
5652
|
templateName: string | undefined;
|
|
4912
5653
|
/**
|
|
5654
|
+
* @public
|
|
4913
5655
|
* <p>The service template major version to delete.</p>
|
|
4914
5656
|
*/
|
|
4915
5657
|
majorVersion: string | undefined;
|
|
4916
5658
|
/**
|
|
5659
|
+
* @public
|
|
4917
5660
|
* <p>The service template minor version to delete.</p>
|
|
4918
5661
|
*/
|
|
4919
5662
|
minorVersion: string | undefined;
|
|
@@ -4923,6 +5666,7 @@ export interface DeleteServiceTemplateVersionInput {
|
|
|
4923
5666
|
*/
|
|
4924
5667
|
export interface DeleteServiceTemplateVersionOutput {
|
|
4925
5668
|
/**
|
|
5669
|
+
* @public
|
|
4926
5670
|
* <p>The detailed data of the service template version being deleted.</p>
|
|
4927
5671
|
*/
|
|
4928
5672
|
serviceTemplateVersion?: ServiceTemplateVersion;
|
|
@@ -4932,16 +5676,19 @@ export interface DeleteServiceTemplateVersionOutput {
|
|
|
4932
5676
|
*/
|
|
4933
5677
|
export interface GetServiceTemplateVersionInput {
|
|
4934
5678
|
/**
|
|
5679
|
+
* @public
|
|
4935
5680
|
* <p>The name of the service template a version of which you want to get detailed data
|
|
4936
5681
|
* for.</p>
|
|
4937
5682
|
*/
|
|
4938
5683
|
templateName: string | undefined;
|
|
4939
5684
|
/**
|
|
5685
|
+
* @public
|
|
4940
5686
|
* <p>To get service template major version detail data, include <code>major
|
|
4941
5687
|
* Version</code>.</p>
|
|
4942
5688
|
*/
|
|
4943
5689
|
majorVersion: string | undefined;
|
|
4944
5690
|
/**
|
|
5691
|
+
* @public
|
|
4945
5692
|
* <p>To get service template minor version detail data, include
|
|
4946
5693
|
* <code>minorVersion</code>.</p>
|
|
4947
5694
|
*/
|
|
@@ -4952,6 +5699,7 @@ export interface GetServiceTemplateVersionInput {
|
|
|
4952
5699
|
*/
|
|
4953
5700
|
export interface GetServiceTemplateVersionOutput {
|
|
4954
5701
|
/**
|
|
5702
|
+
* @public
|
|
4955
5703
|
* <p>The detailed data of the requested service template version.</p>
|
|
4956
5704
|
*/
|
|
4957
5705
|
serviceTemplateVersion: ServiceTemplateVersion | undefined;
|
|
@@ -4961,20 +5709,24 @@ export interface GetServiceTemplateVersionOutput {
|
|
|
4961
5709
|
*/
|
|
4962
5710
|
export interface ListServiceTemplateVersionsInput {
|
|
4963
5711
|
/**
|
|
5712
|
+
* @public
|
|
4964
5713
|
* <p>A token that indicates the location of the next major or minor version in the array of
|
|
4965
5714
|
* major or minor versions of a service template, after the list of major or minor versions that
|
|
4966
5715
|
* was previously requested.</p>
|
|
4967
5716
|
*/
|
|
4968
5717
|
nextToken?: string;
|
|
4969
5718
|
/**
|
|
5719
|
+
* @public
|
|
4970
5720
|
* <p>The maximum number of major or minor versions of a service template to list.</p>
|
|
4971
5721
|
*/
|
|
4972
5722
|
maxResults?: number;
|
|
4973
5723
|
/**
|
|
5724
|
+
* @public
|
|
4974
5725
|
* <p>The name of the service template.</p>
|
|
4975
5726
|
*/
|
|
4976
5727
|
templateName: string | undefined;
|
|
4977
5728
|
/**
|
|
5729
|
+
* @public
|
|
4978
5730
|
* <p>To view a list of minor of versions under a major version of a service template, include
|
|
4979
5731
|
* <code>major Version</code>.</p>
|
|
4980
5732
|
* <p>To view a list of major versions of a service template, <i>exclude</i>
|
|
@@ -4988,42 +5740,52 @@ export interface ListServiceTemplateVersionsInput {
|
|
|
4988
5740
|
*/
|
|
4989
5741
|
export interface ServiceTemplateVersionSummary {
|
|
4990
5742
|
/**
|
|
5743
|
+
* @public
|
|
4991
5744
|
* <p>The name of the service template.</p>
|
|
4992
5745
|
*/
|
|
4993
5746
|
templateName: string | undefined;
|
|
4994
5747
|
/**
|
|
5748
|
+
* @public
|
|
4995
5749
|
* <p>The latest major version that's associated with the version of a service template.</p>
|
|
4996
5750
|
*/
|
|
4997
5751
|
majorVersion: string | undefined;
|
|
4998
5752
|
/**
|
|
5753
|
+
* @public
|
|
4999
5754
|
* <p>The minor version of a service template.</p>
|
|
5000
5755
|
*/
|
|
5001
5756
|
minorVersion: string | undefined;
|
|
5002
5757
|
/**
|
|
5758
|
+
* @public
|
|
5003
5759
|
* <p>The recommended minor version of the service template.</p>
|
|
5004
5760
|
*/
|
|
5005
5761
|
recommendedMinorVersion?: string;
|
|
5006
5762
|
/**
|
|
5763
|
+
* @public
|
|
5007
5764
|
* <p>The service template minor version status.</p>
|
|
5008
5765
|
*/
|
|
5009
5766
|
status: TemplateVersionStatus | string | undefined;
|
|
5010
5767
|
/**
|
|
5768
|
+
* @public
|
|
5011
5769
|
* <p>A service template minor version status message.</p>
|
|
5012
5770
|
*/
|
|
5013
5771
|
statusMessage?: string;
|
|
5014
5772
|
/**
|
|
5773
|
+
* @public
|
|
5015
5774
|
* <p>A description of the version of a service template.</p>
|
|
5016
5775
|
*/
|
|
5017
5776
|
description?: string;
|
|
5018
5777
|
/**
|
|
5778
|
+
* @public
|
|
5019
5779
|
* <p>The Amazon Resource Name (ARN) of the version of a service template.</p>
|
|
5020
5780
|
*/
|
|
5021
5781
|
arn: string | undefined;
|
|
5022
5782
|
/**
|
|
5783
|
+
* @public
|
|
5023
5784
|
* <p>The time when the version of a service template was created.</p>
|
|
5024
5785
|
*/
|
|
5025
5786
|
createdAt: Date | undefined;
|
|
5026
5787
|
/**
|
|
5788
|
+
* @public
|
|
5027
5789
|
* <p>The time when the version of a service template was last modified.</p>
|
|
5028
5790
|
*/
|
|
5029
5791
|
lastModifiedAt: Date | undefined;
|
|
@@ -5033,12 +5795,14 @@ export interface ServiceTemplateVersionSummary {
|
|
|
5033
5795
|
*/
|
|
5034
5796
|
export interface ListServiceTemplateVersionsOutput {
|
|
5035
5797
|
/**
|
|
5798
|
+
* @public
|
|
5036
5799
|
* <p>A token that indicates the location of the next major or minor version in the array of
|
|
5037
5800
|
* major or minor versions of a service template, after the current requested list of service
|
|
5038
5801
|
* major or minor versions.</p>
|
|
5039
5802
|
*/
|
|
5040
5803
|
nextToken?: string;
|
|
5041
5804
|
/**
|
|
5805
|
+
* @public
|
|
5042
5806
|
* <p>An array of major or minor versions of a service template with detail data.</p>
|
|
5043
5807
|
*/
|
|
5044
5808
|
templateVersions: ServiceTemplateVersionSummary[] | undefined;
|
|
@@ -5048,33 +5812,40 @@ export interface ListServiceTemplateVersionsOutput {
|
|
|
5048
5812
|
*/
|
|
5049
5813
|
export interface UpdateServiceTemplateVersionInput {
|
|
5050
5814
|
/**
|
|
5815
|
+
* @public
|
|
5051
5816
|
* <p>The name of the service template.</p>
|
|
5052
5817
|
*/
|
|
5053
5818
|
templateName: string | undefined;
|
|
5054
5819
|
/**
|
|
5820
|
+
* @public
|
|
5055
5821
|
* <p>To update a major version of a service template, include <code>major
|
|
5056
5822
|
* Version</code>.</p>
|
|
5057
5823
|
*/
|
|
5058
5824
|
majorVersion: string | undefined;
|
|
5059
5825
|
/**
|
|
5826
|
+
* @public
|
|
5060
5827
|
* <p>To update a minor version of a service template, include <code>minorVersion</code>.</p>
|
|
5061
5828
|
*/
|
|
5062
5829
|
minorVersion: string | undefined;
|
|
5063
5830
|
/**
|
|
5831
|
+
* @public
|
|
5064
5832
|
* <p>A description of a service template version to update.</p>
|
|
5065
5833
|
*/
|
|
5066
5834
|
description?: string;
|
|
5067
5835
|
/**
|
|
5836
|
+
* @public
|
|
5068
5837
|
* <p>The status of the service template minor version to update.</p>
|
|
5069
5838
|
*/
|
|
5070
5839
|
status?: TemplateVersionStatus | string;
|
|
5071
5840
|
/**
|
|
5841
|
+
* @public
|
|
5072
5842
|
* <p>An array of environment template objects that are compatible with this service template
|
|
5073
5843
|
* version. A service instance based on this service template version can run in environments
|
|
5074
5844
|
* based on compatible templates.</p>
|
|
5075
5845
|
*/
|
|
5076
5846
|
compatibleEnvironmentTemplates?: CompatibleEnvironmentTemplateInput[];
|
|
5077
5847
|
/**
|
|
5848
|
+
* @public
|
|
5078
5849
|
* <p>An array of supported component sources. Components with supported sources can be attached
|
|
5079
5850
|
* to service instances based on this service template version.</p>
|
|
5080
5851
|
* <note>
|
|
@@ -5093,6 +5864,7 @@ export interface UpdateServiceTemplateVersionInput {
|
|
|
5093
5864
|
*/
|
|
5094
5865
|
export interface UpdateServiceTemplateVersionOutput {
|
|
5095
5866
|
/**
|
|
5867
|
+
* @public
|
|
5096
5868
|
* <p>The service template version detail data that's returned by Proton.</p>
|
|
5097
5869
|
*/
|
|
5098
5870
|
serviceTemplateVersion: ServiceTemplateVersion | undefined;
|
|
@@ -5102,10 +5874,12 @@ export interface UpdateServiceTemplateVersionOutput {
|
|
|
5102
5874
|
*/
|
|
5103
5875
|
export interface TagResourceInput {
|
|
5104
5876
|
/**
|
|
5877
|
+
* @public
|
|
5105
5878
|
* <p>The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.</p>
|
|
5106
5879
|
*/
|
|
5107
5880
|
resourceArn: string | undefined;
|
|
5108
5881
|
/**
|
|
5882
|
+
* @public
|
|
5109
5883
|
* <p>A list of customer tags to apply to the Proton resource.</p>
|
|
5110
5884
|
*/
|
|
5111
5885
|
tags: Tag[] | undefined;
|
|
@@ -5120,26 +5894,32 @@ export interface TagResourceOutput {
|
|
|
5120
5894
|
*/
|
|
5121
5895
|
export interface CreateTemplateSyncConfigInput {
|
|
5122
5896
|
/**
|
|
5897
|
+
* @public
|
|
5123
5898
|
* <p>The name of your registered template.</p>
|
|
5124
5899
|
*/
|
|
5125
5900
|
templateName: string | undefined;
|
|
5126
5901
|
/**
|
|
5902
|
+
* @public
|
|
5127
5903
|
* <p>The type of the registered template.</p>
|
|
5128
5904
|
*/
|
|
5129
5905
|
templateType: TemplateType | string | undefined;
|
|
5130
5906
|
/**
|
|
5907
|
+
* @public
|
|
5131
5908
|
* <p>The provider type for your repository.</p>
|
|
5132
5909
|
*/
|
|
5133
5910
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
5134
5911
|
/**
|
|
5912
|
+
* @public
|
|
5135
5913
|
* <p>The repository name (for example, <code>myrepos/myrepo</code>).</p>
|
|
5136
5914
|
*/
|
|
5137
5915
|
repositoryName: string | undefined;
|
|
5138
5916
|
/**
|
|
5917
|
+
* @public
|
|
5139
5918
|
* <p>The repository branch for your template.</p>
|
|
5140
5919
|
*/
|
|
5141
5920
|
branch: string | undefined;
|
|
5142
5921
|
/**
|
|
5922
|
+
* @public
|
|
5143
5923
|
* <p>A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this
|
|
5144
5924
|
* repository directory.</p>
|
|
5145
5925
|
*/
|
|
@@ -5151,26 +5931,32 @@ export interface CreateTemplateSyncConfigInput {
|
|
|
5151
5931
|
*/
|
|
5152
5932
|
export interface TemplateSyncConfig {
|
|
5153
5933
|
/**
|
|
5934
|
+
* @public
|
|
5154
5935
|
* <p>The template name.</p>
|
|
5155
5936
|
*/
|
|
5156
5937
|
templateName: string | undefined;
|
|
5157
5938
|
/**
|
|
5939
|
+
* @public
|
|
5158
5940
|
* <p>The template type.</p>
|
|
5159
5941
|
*/
|
|
5160
5942
|
templateType: TemplateType | string | undefined;
|
|
5161
5943
|
/**
|
|
5944
|
+
* @public
|
|
5162
5945
|
* <p>The repository provider.</p>
|
|
5163
5946
|
*/
|
|
5164
5947
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
5165
5948
|
/**
|
|
5949
|
+
* @public
|
|
5166
5950
|
* <p>The repository name (for example, <code>myrepos/myrepo</code>).</p>
|
|
5167
5951
|
*/
|
|
5168
5952
|
repositoryName: string | undefined;
|
|
5169
5953
|
/**
|
|
5954
|
+
* @public
|
|
5170
5955
|
* <p>The repository branch.</p>
|
|
5171
5956
|
*/
|
|
5172
5957
|
branch: string | undefined;
|
|
5173
5958
|
/**
|
|
5959
|
+
* @public
|
|
5174
5960
|
* <p>A subdirectory path to your template bundle version.</p>
|
|
5175
5961
|
*/
|
|
5176
5962
|
subdirectory?: string;
|
|
@@ -5180,6 +5966,7 @@ export interface TemplateSyncConfig {
|
|
|
5180
5966
|
*/
|
|
5181
5967
|
export interface CreateTemplateSyncConfigOutput {
|
|
5182
5968
|
/**
|
|
5969
|
+
* @public
|
|
5183
5970
|
* <p>The template sync configuration detail data that's returned by Proton.</p>
|
|
5184
5971
|
*/
|
|
5185
5972
|
templateSyncConfig?: TemplateSyncConfig;
|
|
@@ -5189,10 +5976,12 @@ export interface CreateTemplateSyncConfigOutput {
|
|
|
5189
5976
|
*/
|
|
5190
5977
|
export interface DeleteTemplateSyncConfigInput {
|
|
5191
5978
|
/**
|
|
5979
|
+
* @public
|
|
5192
5980
|
* <p>The template name.</p>
|
|
5193
5981
|
*/
|
|
5194
5982
|
templateName: string | undefined;
|
|
5195
5983
|
/**
|
|
5984
|
+
* @public
|
|
5196
5985
|
* <p>The template type.</p>
|
|
5197
5986
|
*/
|
|
5198
5987
|
templateType: TemplateType | string | undefined;
|
|
@@ -5202,6 +5991,7 @@ export interface DeleteTemplateSyncConfigInput {
|
|
|
5202
5991
|
*/
|
|
5203
5992
|
export interface DeleteTemplateSyncConfigOutput {
|
|
5204
5993
|
/**
|
|
5994
|
+
* @public
|
|
5205
5995
|
* <p>The template sync configuration detail data that's returned by Proton.</p>
|
|
5206
5996
|
*/
|
|
5207
5997
|
templateSyncConfig?: TemplateSyncConfig;
|
|
@@ -5211,10 +6001,12 @@ export interface DeleteTemplateSyncConfigOutput {
|
|
|
5211
6001
|
*/
|
|
5212
6002
|
export interface GetTemplateSyncConfigInput {
|
|
5213
6003
|
/**
|
|
6004
|
+
* @public
|
|
5214
6005
|
* <p>The template name.</p>
|
|
5215
6006
|
*/
|
|
5216
6007
|
templateName: string | undefined;
|
|
5217
6008
|
/**
|
|
6009
|
+
* @public
|
|
5218
6010
|
* <p>The template type.</p>
|
|
5219
6011
|
*/
|
|
5220
6012
|
templateType: TemplateType | string | undefined;
|
|
@@ -5224,6 +6016,7 @@ export interface GetTemplateSyncConfigInput {
|
|
|
5224
6016
|
*/
|
|
5225
6017
|
export interface GetTemplateSyncConfigOutput {
|
|
5226
6018
|
/**
|
|
6019
|
+
* @public
|
|
5227
6020
|
* <p>The template sync configuration detail data that's returned by Proton.</p>
|
|
5228
6021
|
*/
|
|
5229
6022
|
templateSyncConfig?: TemplateSyncConfig;
|
|
@@ -5233,26 +6026,32 @@ export interface GetTemplateSyncConfigOutput {
|
|
|
5233
6026
|
*/
|
|
5234
6027
|
export interface UpdateTemplateSyncConfigInput {
|
|
5235
6028
|
/**
|
|
6029
|
+
* @public
|
|
5236
6030
|
* <p>The synced template name.</p>
|
|
5237
6031
|
*/
|
|
5238
6032
|
templateName: string | undefined;
|
|
5239
6033
|
/**
|
|
6034
|
+
* @public
|
|
5240
6035
|
* <p>The synced template type.</p>
|
|
5241
6036
|
*/
|
|
5242
6037
|
templateType: TemplateType | string | undefined;
|
|
5243
6038
|
/**
|
|
6039
|
+
* @public
|
|
5244
6040
|
* <p>The repository provider.</p>
|
|
5245
6041
|
*/
|
|
5246
6042
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
5247
6043
|
/**
|
|
6044
|
+
* @public
|
|
5248
6045
|
* <p>The repository name (for example, <code>myrepos/myrepo</code>).</p>
|
|
5249
6046
|
*/
|
|
5250
6047
|
repositoryName: string | undefined;
|
|
5251
6048
|
/**
|
|
6049
|
+
* @public
|
|
5252
6050
|
* <p>The repository branch for your template.</p>
|
|
5253
6051
|
*/
|
|
5254
6052
|
branch: string | undefined;
|
|
5255
6053
|
/**
|
|
6054
|
+
* @public
|
|
5256
6055
|
* <p>A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.</p>
|
|
5257
6056
|
*/
|
|
5258
6057
|
subdirectory?: string;
|
|
@@ -5262,6 +6061,7 @@ export interface UpdateTemplateSyncConfigInput {
|
|
|
5262
6061
|
*/
|
|
5263
6062
|
export interface UpdateTemplateSyncConfigOutput {
|
|
5264
6063
|
/**
|
|
6064
|
+
* @public
|
|
5265
6065
|
* <p>The template sync configuration detail data that's returned by Proton.</p>
|
|
5266
6066
|
*/
|
|
5267
6067
|
templateSyncConfig?: TemplateSyncConfig;
|
|
@@ -5271,10 +6071,12 @@ export interface UpdateTemplateSyncConfigOutput {
|
|
|
5271
6071
|
*/
|
|
5272
6072
|
export interface UntagResourceInput {
|
|
5273
6073
|
/**
|
|
6074
|
+
* @public
|
|
5274
6075
|
* <p>The Amazon Resource Name (ARN) of the resource to remove customer tags from.</p>
|
|
5275
6076
|
*/
|
|
5276
6077
|
resourceArn: string | undefined;
|
|
5277
6078
|
/**
|
|
6079
|
+
* @public
|
|
5278
6080
|
* <p>A list of customer tag keys that indicate the customer tags to be removed from the resource.</p>
|
|
5279
6081
|
*/
|
|
5280
6082
|
tagKeys: string[] | undefined;
|