@aws-sdk/client-proton 3.99.0 → 3.105.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/CHANGELOG.md +30 -0
- package/dist-cjs/Proton.js +120 -0
- package/dist-cjs/ProtonClient.js +2 -0
- package/dist-cjs/commands/CancelComponentDeploymentCommand.js +36 -0
- package/dist-cjs/commands/CreateComponentCommand.js +36 -0
- package/dist-cjs/commands/DeleteComponentCommand.js +36 -0
- package/dist-cjs/commands/GetComponentCommand.js +36 -0
- package/dist-cjs/commands/ListComponentOutputsCommand.js +36 -0
- package/dist-cjs/commands/ListComponentProvisionedResourcesCommand.js +36 -0
- package/dist-cjs/commands/ListComponentsCommand.js +36 -0
- package/dist-cjs/commands/UpdateComponentCommand.js +36 -0
- package/dist-cjs/commands/index.js +8 -0
- package/dist-cjs/models/models_0.js +169 -33
- package/dist-cjs/pagination/ListComponentOutputsPaginator.js +35 -0
- package/dist-cjs/pagination/ListComponentProvisionedResourcesPaginator.js +35 -0
- package/dist-cjs/pagination/ListComponentsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_json1_0.js +741 -34
- package/dist-cjs/waiters/index.js +2 -0
- package/dist-cjs/waiters/waitForComponentDeleted.js +39 -0
- package/dist-cjs/waiters/waitForComponentDeployed.js +45 -0
- package/dist-es/Proton.js +120 -0
- package/dist-es/ProtonClient.js +2 -0
- package/dist-es/commands/CancelComponentDeploymentCommand.js +39 -0
- package/dist-es/commands/CreateComponentCommand.js +39 -0
- package/dist-es/commands/DeleteComponentCommand.js +39 -0
- package/dist-es/commands/GetComponentCommand.js +39 -0
- package/dist-es/commands/ListComponentOutputsCommand.js +39 -0
- package/dist-es/commands/ListComponentProvisionedResourcesCommand.js +39 -0
- package/dist-es/commands/ListComponentsCommand.js +39 -0
- package/dist-es/commands/UpdateComponentCommand.js +39 -0
- package/dist-es/commands/index.js +8 -0
- package/dist-es/models/models_0.js +106 -25
- package/dist-es/pagination/ListComponentOutputsPaginator.js +74 -0
- package/dist-es/pagination/ListComponentProvisionedResourcesPaginator.js +74 -0
- package/dist-es/pagination/ListComponentsPaginator.js +75 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_0.js +899 -77
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForComponentDeleted.js +54 -0
- package/dist-es/waiters/waitForComponentDeployed.js +60 -0
- package/dist-types/Proton.d.ts +117 -46
- package/dist-types/ProtonClient.d.ts +10 -2
- package/dist-types/commands/CancelComponentDeploymentCommand.d.ts +38 -0
- package/dist-types/commands/CreateComponentCommand.d.ts +38 -0
- package/dist-types/commands/DeleteComponentCommand.d.ts +38 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +7 -1
- package/dist-types/commands/GetComponentCommand.d.ts +38 -0
- package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GetEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/GetEnvironmentTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetEnvironmentTemplateVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceInstanceCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceTemplateVersionCommand.d.ts +1 -1
- package/dist-types/commands/ListComponentOutputsCommand.d.ts +38 -0
- package/dist-types/commands/ListComponentProvisionedResourcesCommand.d.ts +38 -0
- package/dist-types/commands/ListComponentsCommand.d.ts +38 -0
- package/dist-types/commands/ListServiceInstanceOutputsCommand.d.ts +1 -1
- package/dist-types/commands/ListServiceInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListServicePipelineOutputsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateComponentCommand.d.ts +43 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +8 -34
- package/dist-types/commands/index.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +683 -124
- package/dist-types/pagination/ListComponentOutputsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListComponentProvisionedResourcesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListComponentsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +24 -0
- package/dist-types/ts3.4/Proton.d.ts +40 -0
- package/dist-types/ts3.4/ProtonClient.d.ts +10 -2
- package/dist-types/ts3.4/commands/CancelComponentDeploymentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateComponentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteComponentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetComponentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListComponentOutputsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListComponentProvisionedResourcesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateComponentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +8 -0
- package/dist-types/ts3.4/models/models_0.d.ts +305 -40
- package/dist-types/ts3.4/pagination/ListComponentOutputsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListComponentProvisionedResourcesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListComponentsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +24 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForComponentDeleted.d.ts +7 -0
- package/dist-types/ts3.4/waiters/waitForComponentDeployed.d.ts +7 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForComponentDeleted.d.ts +14 -0
- package/dist-types/waiters/waitForComponentDeployed.d.ts +14 -0
- package/package.json +4 -3
|
@@ -18,7 +18,7 @@ export declare enum EnvironmentAccountConnectionStatus {
|
|
|
18
18
|
REJECTED = "REJECTED"
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* <p>
|
|
21
|
+
* <p>Detailed data of an Proton environment account connection resource.</p>
|
|
22
22
|
*/
|
|
23
23
|
export interface EnvironmentAccountConnection {
|
|
24
24
|
/**
|
|
@@ -57,6 +57,16 @@ export interface EnvironmentAccountConnection {
|
|
|
57
57
|
* <p>The status of the environment account connection.</p>
|
|
58
58
|
*/
|
|
59
59
|
status: EnvironmentAccountConnectionStatus | string | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
62
|
+
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
63
|
+
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
64
|
+
* environments running in the account.</p>
|
|
65
|
+
* <p>For more information about components, see
|
|
66
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
67
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
68
|
+
*/
|
|
69
|
+
componentRoleArn?: string;
|
|
60
70
|
}
|
|
61
71
|
export declare namespace EnvironmentAccountConnection {
|
|
62
72
|
/**
|
|
@@ -272,17 +282,17 @@ export declare namespace UpdateAccountSettingsOutput {
|
|
|
272
282
|
*/
|
|
273
283
|
const filterSensitiveLog: (obj: UpdateAccountSettingsOutput) => any;
|
|
274
284
|
}
|
|
275
|
-
export interface
|
|
285
|
+
export interface CancelComponentDeploymentInput {
|
|
276
286
|
/**
|
|
277
|
-
* <p>The name of the
|
|
287
|
+
* <p>The name of the component with the deployment to cancel.</p>
|
|
278
288
|
*/
|
|
279
|
-
|
|
289
|
+
componentName: string | undefined;
|
|
280
290
|
}
|
|
281
|
-
export declare namespace
|
|
291
|
+
export declare namespace CancelComponentDeploymentInput {
|
|
282
292
|
/**
|
|
283
293
|
* @internal
|
|
284
294
|
*/
|
|
285
|
-
const filterSensitiveLog: (obj:
|
|
295
|
+
const filterSensitiveLog: (obj: CancelComponentDeploymentInput) => any;
|
|
286
296
|
}
|
|
287
297
|
export declare enum DeploymentStatus {
|
|
288
298
|
CANCELLED = "CANCELLED",
|
|
@@ -294,11 +304,101 @@ export declare enum DeploymentStatus {
|
|
|
294
304
|
IN_PROGRESS = "IN_PROGRESS",
|
|
295
305
|
SUCCEEDED = "SUCCEEDED"
|
|
296
306
|
}
|
|
307
|
+
/**
|
|
308
|
+
* <p>Detailed data of an Proton component resource.</p>
|
|
309
|
+
* <p>For more information about components, see
|
|
310
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
311
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
312
|
+
*/
|
|
313
|
+
export interface Component {
|
|
314
|
+
/**
|
|
315
|
+
* <p>The name of the component.</p>
|
|
316
|
+
*/
|
|
317
|
+
name: string | undefined;
|
|
318
|
+
/**
|
|
319
|
+
* <p>A description of the component.</p>
|
|
320
|
+
*/
|
|
321
|
+
description?: string;
|
|
322
|
+
/**
|
|
323
|
+
* <p>The Amazon Resource Name (ARN) of the component.</p>
|
|
324
|
+
*/
|
|
325
|
+
arn: string | undefined;
|
|
326
|
+
/**
|
|
327
|
+
* <p>The name of the Proton environment that this component is associated with.</p>
|
|
328
|
+
*/
|
|
329
|
+
environmentName: string | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>
|
|
332
|
+
*/
|
|
333
|
+
serviceName?: string;
|
|
334
|
+
/**
|
|
335
|
+
* <p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>
|
|
336
|
+
*/
|
|
337
|
+
serviceInstanceName?: string;
|
|
338
|
+
/**
|
|
339
|
+
* <p>The time when the component was created.</p>
|
|
340
|
+
*/
|
|
341
|
+
createdAt: Date | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The time when the component was last modified.</p>
|
|
344
|
+
*/
|
|
345
|
+
lastModifiedAt: Date | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* <p>The time when a deployment of the component was last attempted.</p>
|
|
348
|
+
*/
|
|
349
|
+
lastDeploymentAttemptedAt?: Date;
|
|
350
|
+
/**
|
|
351
|
+
* <p>The time when the component was last deployed successfully.</p>
|
|
352
|
+
*/
|
|
353
|
+
lastDeploymentSucceededAt?: Date;
|
|
354
|
+
/**
|
|
355
|
+
* <p>The component deployment status.</p>
|
|
356
|
+
*/
|
|
357
|
+
deploymentStatus: DeploymentStatus | string | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* <p>The message associated with the component deployment status.</p>
|
|
360
|
+
*/
|
|
361
|
+
deploymentStatusMessage?: string;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.</p>
|
|
364
|
+
*/
|
|
365
|
+
serviceSpec?: string;
|
|
366
|
+
}
|
|
367
|
+
export declare namespace Component {
|
|
368
|
+
/**
|
|
369
|
+
* @internal
|
|
370
|
+
*/
|
|
371
|
+
const filterSensitiveLog: (obj: Component) => any;
|
|
372
|
+
}
|
|
373
|
+
export interface CancelComponentDeploymentOutput {
|
|
374
|
+
/**
|
|
375
|
+
* <p>The detailed data of the component with the deployment that is being canceled.</p>
|
|
376
|
+
*/
|
|
377
|
+
component: Component | undefined;
|
|
378
|
+
}
|
|
379
|
+
export declare namespace CancelComponentDeploymentOutput {
|
|
380
|
+
/**
|
|
381
|
+
* @internal
|
|
382
|
+
*/
|
|
383
|
+
const filterSensitiveLog: (obj: CancelComponentDeploymentOutput) => any;
|
|
384
|
+
}
|
|
385
|
+
export interface CancelEnvironmentDeploymentInput {
|
|
386
|
+
/**
|
|
387
|
+
* <p>The name of the environment with the deployment to cancel.</p>
|
|
388
|
+
*/
|
|
389
|
+
environmentName: string | undefined;
|
|
390
|
+
}
|
|
391
|
+
export declare namespace CancelEnvironmentDeploymentInput {
|
|
392
|
+
/**
|
|
393
|
+
* @internal
|
|
394
|
+
*/
|
|
395
|
+
const filterSensitiveLog: (obj: CancelEnvironmentDeploymentInput) => any;
|
|
396
|
+
}
|
|
297
397
|
export declare enum Provisioning {
|
|
298
398
|
CUSTOMER_MANAGED = "CUSTOMER_MANAGED"
|
|
299
399
|
}
|
|
300
400
|
/**
|
|
301
|
-
* <p>
|
|
401
|
+
* <p>Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.</p>
|
|
302
402
|
*/
|
|
303
403
|
export interface Environment {
|
|
304
404
|
/**
|
|
@@ -369,6 +469,15 @@ export interface Environment {
|
|
|
369
469
|
* <p>The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.</p>
|
|
370
470
|
*/
|
|
371
471
|
provisioningRepository?: RepositoryBranch;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
474
|
+
* determines the scope of infrastructure that a component can provision.</p>
|
|
475
|
+
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
476
|
+
* <p>For more information about components, see
|
|
477
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
478
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
479
|
+
*/
|
|
480
|
+
componentRoleArn?: string;
|
|
372
481
|
}
|
|
373
482
|
export declare namespace Environment {
|
|
374
483
|
/**
|
|
@@ -405,7 +514,7 @@ export declare namespace CancelServiceInstanceDeploymentInput {
|
|
|
405
514
|
const filterSensitiveLog: (obj: CancelServiceInstanceDeploymentInput) => any;
|
|
406
515
|
}
|
|
407
516
|
/**
|
|
408
|
-
* <p>
|
|
517
|
+
* <p>Detailed data of an Proton service instance resource.</p>
|
|
409
518
|
*/
|
|
410
519
|
export interface ServiceInstance {
|
|
411
520
|
/**
|
|
@@ -453,7 +562,7 @@ export interface ServiceInstance {
|
|
|
453
562
|
*/
|
|
454
563
|
deploymentStatus: DeploymentStatus | string | undefined;
|
|
455
564
|
/**
|
|
456
|
-
* <p>
|
|
565
|
+
* <p>The message associated with the service instance deployment status.</p>
|
|
457
566
|
*/
|
|
458
567
|
deploymentStatusMessage?: string;
|
|
459
568
|
/**
|
|
@@ -492,7 +601,7 @@ export declare namespace CancelServicePipelineDeploymentInput {
|
|
|
492
601
|
const filterSensitiveLog: (obj: CancelServicePipelineDeploymentInput) => any;
|
|
493
602
|
}
|
|
494
603
|
/**
|
|
495
|
-
* <p>
|
|
604
|
+
* <p>Detailed data of an Proton service instance pipeline resource.</p>
|
|
496
605
|
*/
|
|
497
606
|
export interface ServicePipeline {
|
|
498
607
|
/**
|
|
@@ -554,6 +663,120 @@ export declare namespace CancelServicePipelineDeploymentOutput {
|
|
|
554
663
|
*/
|
|
555
664
|
const filterSensitiveLog: (obj: CancelServicePipelineDeploymentOutput) => any;
|
|
556
665
|
}
|
|
666
|
+
export interface ListComponentOutputsInput {
|
|
667
|
+
/**
|
|
668
|
+
* <p>The name of the component whose outputs you want.</p>
|
|
669
|
+
*/
|
|
670
|
+
componentName: string | undefined;
|
|
671
|
+
/**
|
|
672
|
+
* <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>
|
|
673
|
+
*/
|
|
674
|
+
nextToken?: string;
|
|
675
|
+
}
|
|
676
|
+
export declare namespace ListComponentOutputsInput {
|
|
677
|
+
/**
|
|
678
|
+
* @internal
|
|
679
|
+
*/
|
|
680
|
+
const filterSensitiveLog: (obj: ListComponentOutputsInput) => any;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* <p>An infrastructure as code defined resource output.</p>
|
|
684
|
+
*/
|
|
685
|
+
export interface Output {
|
|
686
|
+
/**
|
|
687
|
+
* <p>The output key.</p>
|
|
688
|
+
*/
|
|
689
|
+
key?: string;
|
|
690
|
+
/**
|
|
691
|
+
* <p>The output value.</p>
|
|
692
|
+
*/
|
|
693
|
+
valueString?: string;
|
|
694
|
+
}
|
|
695
|
+
export declare namespace Output {
|
|
696
|
+
/**
|
|
697
|
+
* @internal
|
|
698
|
+
*/
|
|
699
|
+
const filterSensitiveLog: (obj: Output) => any;
|
|
700
|
+
}
|
|
701
|
+
export interface ListComponentOutputsOutput {
|
|
702
|
+
/**
|
|
703
|
+
* <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>
|
|
704
|
+
*/
|
|
705
|
+
nextToken?: string;
|
|
706
|
+
/**
|
|
707
|
+
* <p>An array of component Infrastructure as Code (IaC) outputs.</p>
|
|
708
|
+
*/
|
|
709
|
+
outputs: Output[] | undefined;
|
|
710
|
+
}
|
|
711
|
+
export declare namespace ListComponentOutputsOutput {
|
|
712
|
+
/**
|
|
713
|
+
* @internal
|
|
714
|
+
*/
|
|
715
|
+
const filterSensitiveLog: (obj: ListComponentOutputsOutput) => any;
|
|
716
|
+
}
|
|
717
|
+
export interface ListComponentProvisionedResourcesInput {
|
|
718
|
+
/**
|
|
719
|
+
* <p>The name of the component whose provisioned resources you want.</p>
|
|
720
|
+
*/
|
|
721
|
+
componentName: string | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources
|
|
724
|
+
* that was previously requested.</p>
|
|
725
|
+
*/
|
|
726
|
+
nextToken?: string;
|
|
727
|
+
}
|
|
728
|
+
export declare namespace ListComponentProvisionedResourcesInput {
|
|
729
|
+
/**
|
|
730
|
+
* @internal
|
|
731
|
+
*/
|
|
732
|
+
const filterSensitiveLog: (obj: ListComponentProvisionedResourcesInput) => any;
|
|
733
|
+
}
|
|
734
|
+
export declare enum ProvisionedResourceEngine {
|
|
735
|
+
CLOUDFORMATION = "CLOUDFORMATION",
|
|
736
|
+
TERRAFORM = "TERRAFORM"
|
|
737
|
+
}
|
|
738
|
+
/**
|
|
739
|
+
* <p>Detail data for a provisioned resource.</p>
|
|
740
|
+
*/
|
|
741
|
+
export interface ProvisionedResource {
|
|
742
|
+
/**
|
|
743
|
+
* <p>The provisioned resource name.</p>
|
|
744
|
+
*/
|
|
745
|
+
name?: string;
|
|
746
|
+
/**
|
|
747
|
+
* <p>The provisioned resource identifier.</p>
|
|
748
|
+
*/
|
|
749
|
+
identifier?: string;
|
|
750
|
+
/**
|
|
751
|
+
* <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
|
|
752
|
+
* be used for self-managed provisioning.</p>
|
|
753
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton Administrator Guide</i>.</p>
|
|
754
|
+
*/
|
|
755
|
+
provisioningEngine?: ProvisionedResourceEngine | string;
|
|
756
|
+
}
|
|
757
|
+
export declare namespace ProvisionedResource {
|
|
758
|
+
/**
|
|
759
|
+
* @internal
|
|
760
|
+
*/
|
|
761
|
+
const filterSensitiveLog: (obj: ProvisionedResource) => any;
|
|
762
|
+
}
|
|
763
|
+
export interface ListComponentProvisionedResourcesOutput {
|
|
764
|
+
/**
|
|
765
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of
|
|
766
|
+
* provisioned resources.</p>
|
|
767
|
+
*/
|
|
768
|
+
nextToken?: string;
|
|
769
|
+
/**
|
|
770
|
+
* <p>An array of provisioned resources for a component.</p>
|
|
771
|
+
*/
|
|
772
|
+
provisionedResources: ProvisionedResource[] | undefined;
|
|
773
|
+
}
|
|
774
|
+
export declare namespace ListComponentProvisionedResourcesOutput {
|
|
775
|
+
/**
|
|
776
|
+
* @internal
|
|
777
|
+
*/
|
|
778
|
+
const filterSensitiveLog: (obj: ListComponentProvisionedResourcesOutput) => any;
|
|
779
|
+
}
|
|
557
780
|
/**
|
|
558
781
|
* <p>A description of a resource tag.</p>
|
|
559
782
|
*/
|
|
@@ -573,6 +796,313 @@ export declare namespace Tag {
|
|
|
573
796
|
*/
|
|
574
797
|
const filterSensitiveLog: (obj: Tag) => any;
|
|
575
798
|
}
|
|
799
|
+
export interface CreateComponentInput {
|
|
800
|
+
/**
|
|
801
|
+
* <p>The customer-provided name of the component.</p>
|
|
802
|
+
*/
|
|
803
|
+
name: string | undefined;
|
|
804
|
+
/**
|
|
805
|
+
* <p>An optional customer-provided description of the component.</p>
|
|
806
|
+
*/
|
|
807
|
+
description?: string;
|
|
808
|
+
/**
|
|
809
|
+
* <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
|
|
810
|
+
* service instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>
|
|
811
|
+
*/
|
|
812
|
+
serviceName?: string;
|
|
813
|
+
/**
|
|
814
|
+
* <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
|
|
815
|
+
* instance. Specify both <code>serviceInstanceName</code> and <code>serviceName</code> or neither of them.</p>
|
|
816
|
+
*/
|
|
817
|
+
serviceInstanceName?: string;
|
|
818
|
+
/**
|
|
819
|
+
* <p>The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify
|
|
820
|
+
* <code>serviceInstanceName</code> and <code>serviceName</code>.</p>
|
|
821
|
+
*/
|
|
822
|
+
environmentName?: string;
|
|
823
|
+
/**
|
|
824
|
+
* <p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p>
|
|
825
|
+
* <note>
|
|
826
|
+
* <p>Components support a single IaC file, even if you use Terraform as your template language.</p>
|
|
827
|
+
* </note>
|
|
828
|
+
*/
|
|
829
|
+
templateFile: string | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <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
|
|
832
|
+
* component provisions.</p>
|
|
833
|
+
*/
|
|
834
|
+
manifest: string | undefined;
|
|
835
|
+
/**
|
|
836
|
+
* <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
|
|
837
|
+
* instance.</p>
|
|
838
|
+
*/
|
|
839
|
+
serviceSpec?: string;
|
|
840
|
+
/**
|
|
841
|
+
* <p>An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.</p>
|
|
842
|
+
* <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
|
|
843
|
+
*/
|
|
844
|
+
tags?: Tag[];
|
|
845
|
+
}
|
|
846
|
+
export declare namespace CreateComponentInput {
|
|
847
|
+
/**
|
|
848
|
+
* @internal
|
|
849
|
+
*/
|
|
850
|
+
const filterSensitiveLog: (obj: CreateComponentInput) => any;
|
|
851
|
+
}
|
|
852
|
+
export interface CreateComponentOutput {
|
|
853
|
+
/**
|
|
854
|
+
* <p>The detailed data of the created component.</p>
|
|
855
|
+
*/
|
|
856
|
+
component: Component | undefined;
|
|
857
|
+
}
|
|
858
|
+
export declare namespace CreateComponentOutput {
|
|
859
|
+
/**
|
|
860
|
+
* @internal
|
|
861
|
+
*/
|
|
862
|
+
const filterSensitiveLog: (obj: CreateComponentOutput) => any;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* <p>A quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-limits.html">Proton Quotas</a> in the <i>Proton Administrator
|
|
866
|
+
* Guide</i>.</p>
|
|
867
|
+
*/
|
|
868
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
869
|
+
readonly name: "ServiceQuotaExceededException";
|
|
870
|
+
readonly $fault: "client";
|
|
871
|
+
/**
|
|
872
|
+
* @internal
|
|
873
|
+
*/
|
|
874
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
875
|
+
}
|
|
876
|
+
export interface DeleteComponentInput {
|
|
877
|
+
/**
|
|
878
|
+
* <p>The name of the component to delete.</p>
|
|
879
|
+
*/
|
|
880
|
+
name: string | undefined;
|
|
881
|
+
}
|
|
882
|
+
export declare namespace DeleteComponentInput {
|
|
883
|
+
/**
|
|
884
|
+
* @internal
|
|
885
|
+
*/
|
|
886
|
+
const filterSensitiveLog: (obj: DeleteComponentInput) => any;
|
|
887
|
+
}
|
|
888
|
+
export interface DeleteComponentOutput {
|
|
889
|
+
/**
|
|
890
|
+
* <p>The detailed data of the component being deleted.</p>
|
|
891
|
+
*/
|
|
892
|
+
component?: Component;
|
|
893
|
+
}
|
|
894
|
+
export declare namespace DeleteComponentOutput {
|
|
895
|
+
/**
|
|
896
|
+
* @internal
|
|
897
|
+
*/
|
|
898
|
+
const filterSensitiveLog: (obj: DeleteComponentOutput) => any;
|
|
899
|
+
}
|
|
900
|
+
export interface GetComponentInput {
|
|
901
|
+
/**
|
|
902
|
+
* <p>The name of the component that you want to get the detailed data for.</p>
|
|
903
|
+
*/
|
|
904
|
+
name: string | undefined;
|
|
905
|
+
}
|
|
906
|
+
export declare namespace GetComponentInput {
|
|
907
|
+
/**
|
|
908
|
+
* @internal
|
|
909
|
+
*/
|
|
910
|
+
const filterSensitiveLog: (obj: GetComponentInput) => any;
|
|
911
|
+
}
|
|
912
|
+
export interface GetComponentOutput {
|
|
913
|
+
/**
|
|
914
|
+
* <p>The detailed data of the requested component.</p>
|
|
915
|
+
*/
|
|
916
|
+
component?: Component;
|
|
917
|
+
}
|
|
918
|
+
export declare namespace GetComponentOutput {
|
|
919
|
+
/**
|
|
920
|
+
* @internal
|
|
921
|
+
*/
|
|
922
|
+
const filterSensitiveLog: (obj: GetComponentOutput) => any;
|
|
923
|
+
}
|
|
924
|
+
export interface ListComponentsInput {
|
|
925
|
+
/**
|
|
926
|
+
* <p>A token that indicates the location of the next component in the array of components, after the list of components that was previously
|
|
927
|
+
* requested.</p>
|
|
928
|
+
*/
|
|
929
|
+
nextToken?: string;
|
|
930
|
+
/**
|
|
931
|
+
* <p>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances
|
|
932
|
+
* running in it.</p>
|
|
933
|
+
*/
|
|
934
|
+
environmentName?: string;
|
|
935
|
+
/**
|
|
936
|
+
* <p>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</p>
|
|
937
|
+
*/
|
|
938
|
+
serviceName?: string;
|
|
939
|
+
/**
|
|
940
|
+
* <p>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</p>
|
|
941
|
+
*/
|
|
942
|
+
serviceInstanceName?: string;
|
|
943
|
+
/**
|
|
944
|
+
* <p>The maximum number of components to list.</p>
|
|
945
|
+
*/
|
|
946
|
+
maxResults?: number;
|
|
947
|
+
}
|
|
948
|
+
export declare namespace ListComponentsInput {
|
|
949
|
+
/**
|
|
950
|
+
* @internal
|
|
951
|
+
*/
|
|
952
|
+
const filterSensitiveLog: (obj: ListComponentsInput) => any;
|
|
953
|
+
}
|
|
954
|
+
/**
|
|
955
|
+
* <p>Summary data of an Proton component resource.</p>
|
|
956
|
+
* <p>For more information about components, see
|
|
957
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
958
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
959
|
+
*/
|
|
960
|
+
export interface ComponentSummary {
|
|
961
|
+
/**
|
|
962
|
+
* <p>The name of the component.</p>
|
|
963
|
+
*/
|
|
964
|
+
name: string | undefined;
|
|
965
|
+
/**
|
|
966
|
+
* <p>The Amazon Resource Name (ARN) of the component.</p>
|
|
967
|
+
*/
|
|
968
|
+
arn: string | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* <p>The name of the Proton environment that this component is associated with.</p>
|
|
971
|
+
*/
|
|
972
|
+
environmentName: string | undefined;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Provided when a component is attached to a service instance.</p>
|
|
975
|
+
*/
|
|
976
|
+
serviceName?: string;
|
|
977
|
+
/**
|
|
978
|
+
* <p>The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.</p>
|
|
979
|
+
*/
|
|
980
|
+
serviceInstanceName?: string;
|
|
981
|
+
/**
|
|
982
|
+
* <p>The time when the component was created.</p>
|
|
983
|
+
*/
|
|
984
|
+
createdAt: Date | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>The time when the component was last modified.</p>
|
|
987
|
+
*/
|
|
988
|
+
lastModifiedAt: Date | undefined;
|
|
989
|
+
/**
|
|
990
|
+
* <p>The time when a deployment of the component was last attempted.</p>
|
|
991
|
+
*/
|
|
992
|
+
lastDeploymentAttemptedAt?: Date;
|
|
993
|
+
/**
|
|
994
|
+
* <p>The time when the component was last deployed successfully.</p>
|
|
995
|
+
*/
|
|
996
|
+
lastDeploymentSucceededAt?: Date;
|
|
997
|
+
/**
|
|
998
|
+
* <p>The component deployment status.</p>
|
|
999
|
+
*/
|
|
1000
|
+
deploymentStatus: DeploymentStatus | string | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The message associated with the component deployment status.</p>
|
|
1003
|
+
*/
|
|
1004
|
+
deploymentStatusMessage?: string;
|
|
1005
|
+
}
|
|
1006
|
+
export declare namespace ComponentSummary {
|
|
1007
|
+
/**
|
|
1008
|
+
* @internal
|
|
1009
|
+
*/
|
|
1010
|
+
const filterSensitiveLog: (obj: ComponentSummary) => any;
|
|
1011
|
+
}
|
|
1012
|
+
export interface ListComponentsOutput {
|
|
1013
|
+
/**
|
|
1014
|
+
* <p>A token that indicates the location of the next component in the array of components, after the current requested list of components.</p>
|
|
1015
|
+
*/
|
|
1016
|
+
nextToken?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* <p>An array of components with summary data.</p>
|
|
1019
|
+
*/
|
|
1020
|
+
components: ComponentSummary[] | undefined;
|
|
1021
|
+
}
|
|
1022
|
+
export declare namespace ListComponentsOutput {
|
|
1023
|
+
/**
|
|
1024
|
+
* @internal
|
|
1025
|
+
*/
|
|
1026
|
+
const filterSensitiveLog: (obj: ListComponentsOutput) => any;
|
|
1027
|
+
}
|
|
1028
|
+
export declare enum ComponentDeploymentUpdateType {
|
|
1029
|
+
CURRENT_VERSION = "CURRENT_VERSION",
|
|
1030
|
+
NONE = "NONE"
|
|
1031
|
+
}
|
|
1032
|
+
export interface UpdateComponentInput {
|
|
1033
|
+
/**
|
|
1034
|
+
* <p>The name of the component to update.</p>
|
|
1035
|
+
*/
|
|
1036
|
+
name: string | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* <p>The deployment type. It defines the mode for updating a component, as follows:</p>
|
|
1039
|
+
* <dl>
|
|
1040
|
+
* <dt/>
|
|
1041
|
+
* <dd>
|
|
1042
|
+
* <p>
|
|
1043
|
+
* <code>NONE</code>
|
|
1044
|
+
* </p>
|
|
1045
|
+
* <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. You can only specify
|
|
1046
|
+
* <code>description</code> in this mode.</p>
|
|
1047
|
+
* </dd>
|
|
1048
|
+
* <dt/>
|
|
1049
|
+
* <dd>
|
|
1050
|
+
* <p>
|
|
1051
|
+
* <code>CURRENT_VERSION</code>
|
|
1052
|
+
* </p>
|
|
1053
|
+
* <p>In this mode, the component is deployed and updated with the new <code>serviceSpec</code>, <code>templateSource</code>, and/or <code>type</code>
|
|
1054
|
+
* that you provide. Only requested parameters are updated.</p>
|
|
1055
|
+
* </dd>
|
|
1056
|
+
* </dl>
|
|
1057
|
+
*/
|
|
1058
|
+
deploymentType: ComponentDeploymentUpdateType | string | undefined;
|
|
1059
|
+
/**
|
|
1060
|
+
* <p>An optional customer-provided description of the component.</p>
|
|
1061
|
+
*/
|
|
1062
|
+
description?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* <p>The name of the service that <code>serviceInstanceName</code> is associated with. Don't specify to keep the component's current service instance
|
|
1065
|
+
* attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both
|
|
1066
|
+
* <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>
|
|
1067
|
+
*/
|
|
1068
|
+
serviceName?: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* <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.
|
|
1071
|
+
* Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both
|
|
1072
|
+
* <code>serviceInstanceName</code> and <code>serviceName</code> or for neither of them.</p>
|
|
1073
|
+
*/
|
|
1074
|
+
serviceInstanceName?: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* <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
|
|
1077
|
+
* instance.</p>
|
|
1078
|
+
*/
|
|
1079
|
+
serviceSpec?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</p>
|
|
1082
|
+
* <note>
|
|
1083
|
+
* <p>Components support a single IaC file, even if you use Terraform as your template language.</p>
|
|
1084
|
+
* </note>
|
|
1085
|
+
*/
|
|
1086
|
+
templateFile?: string;
|
|
1087
|
+
}
|
|
1088
|
+
export declare namespace UpdateComponentInput {
|
|
1089
|
+
/**
|
|
1090
|
+
* @internal
|
|
1091
|
+
*/
|
|
1092
|
+
const filterSensitiveLog: (obj: UpdateComponentInput) => any;
|
|
1093
|
+
}
|
|
1094
|
+
export interface UpdateComponentOutput {
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>The detailed data of the updated component.</p>
|
|
1097
|
+
*/
|
|
1098
|
+
component: Component | undefined;
|
|
1099
|
+
}
|
|
1100
|
+
export declare namespace UpdateComponentOutput {
|
|
1101
|
+
/**
|
|
1102
|
+
* @internal
|
|
1103
|
+
*/
|
|
1104
|
+
const filterSensitiveLog: (obj: UpdateComponentOutput) => any;
|
|
1105
|
+
}
|
|
576
1106
|
export interface CreateEnvironmentAccountConnectionInput {
|
|
577
1107
|
/**
|
|
578
1108
|
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first
|
|
@@ -600,6 +1130,16 @@ export interface CreateEnvironmentAccountConnectionInput {
|
|
|
600
1130
|
* <i>Proton Administrator Guide</i>.</p>
|
|
601
1131
|
*/
|
|
602
1132
|
tags?: Tag[];
|
|
1133
|
+
/**
|
|
1134
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1135
|
+
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1136
|
+
* <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with any environments running in this
|
|
1137
|
+
* account.</p>
|
|
1138
|
+
* <p>For more information about components, see
|
|
1139
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1140
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1141
|
+
*/
|
|
1142
|
+
componentRoleArn?: string;
|
|
603
1143
|
}
|
|
604
1144
|
export declare namespace CreateEnvironmentAccountConnectionInput {
|
|
605
1145
|
/**
|
|
@@ -619,18 +1159,6 @@ export declare namespace CreateEnvironmentAccountConnectionOutput {
|
|
|
619
1159
|
*/
|
|
620
1160
|
const filterSensitiveLog: (obj: CreateEnvironmentAccountConnectionOutput) => any;
|
|
621
1161
|
}
|
|
622
|
-
/**
|
|
623
|
-
* <p>A quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-limits.html">Proton Quotas</a> in the <i>Proton Administrator
|
|
624
|
-
* Guide</i>.</p>
|
|
625
|
-
*/
|
|
626
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
627
|
-
readonly name: "ServiceQuotaExceededException";
|
|
628
|
-
readonly $fault: "client";
|
|
629
|
-
/**
|
|
630
|
-
* @internal
|
|
631
|
-
*/
|
|
632
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
633
|
-
}
|
|
634
1162
|
export interface DeleteEnvironmentAccountConnectionInput {
|
|
635
1163
|
/**
|
|
636
1164
|
* <p>The ID of the environment account connection to delete.</p>
|
|
@@ -645,7 +1173,7 @@ export declare namespace DeleteEnvironmentAccountConnectionInput {
|
|
|
645
1173
|
}
|
|
646
1174
|
export interface DeleteEnvironmentAccountConnectionOutput {
|
|
647
1175
|
/**
|
|
648
|
-
* <p>The
|
|
1176
|
+
* <p>The detailed data of the environment account connection being deleted.</p>
|
|
649
1177
|
*/
|
|
650
1178
|
environmentAccountConnection?: EnvironmentAccountConnection;
|
|
651
1179
|
}
|
|
@@ -657,7 +1185,7 @@ export declare namespace DeleteEnvironmentAccountConnectionOutput {
|
|
|
657
1185
|
}
|
|
658
1186
|
export interface GetEnvironmentAccountConnectionInput {
|
|
659
1187
|
/**
|
|
660
|
-
* <p>The ID of the environment account connection.</p>
|
|
1188
|
+
* <p>The ID of the environment account connection that you want to get the detailed data for.</p>
|
|
661
1189
|
*/
|
|
662
1190
|
id: string | undefined;
|
|
663
1191
|
}
|
|
@@ -669,7 +1197,7 @@ export declare namespace GetEnvironmentAccountConnectionInput {
|
|
|
669
1197
|
}
|
|
670
1198
|
export interface GetEnvironmentAccountConnectionOutput {
|
|
671
1199
|
/**
|
|
672
|
-
* <p>The
|
|
1200
|
+
* <p>The detailed data of the requested environment account connection.</p>
|
|
673
1201
|
*/
|
|
674
1202
|
environmentAccountConnection: EnvironmentAccountConnection | undefined;
|
|
675
1203
|
}
|
|
@@ -713,7 +1241,7 @@ export declare namespace ListEnvironmentAccountConnectionsInput {
|
|
|
713
1241
|
const filterSensitiveLog: (obj: ListEnvironmentAccountConnectionsInput) => any;
|
|
714
1242
|
}
|
|
715
1243
|
/**
|
|
716
|
-
* <p>
|
|
1244
|
+
* <p>Summary data of an Proton environment account connection resource.</p>
|
|
717
1245
|
*/
|
|
718
1246
|
export interface EnvironmentAccountConnectionSummary {
|
|
719
1247
|
/**
|
|
@@ -752,6 +1280,16 @@ export interface EnvironmentAccountConnectionSummary {
|
|
|
752
1280
|
* <p>The status of the environment account connection.</p>
|
|
753
1281
|
*/
|
|
754
1282
|
status: EnvironmentAccountConnectionStatus | string | undefined;
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1285
|
+
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1286
|
+
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
1287
|
+
* environments running in the account.</p>
|
|
1288
|
+
* <p>For more information about components, see
|
|
1289
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1290
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1291
|
+
*/
|
|
1292
|
+
componentRoleArn?: string;
|
|
755
1293
|
}
|
|
756
1294
|
export declare namespace EnvironmentAccountConnectionSummary {
|
|
757
1295
|
/**
|
|
@@ -808,7 +1346,17 @@ export interface UpdateEnvironmentAccountConnectionInput {
|
|
|
808
1346
|
/**
|
|
809
1347
|
* <p>The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.</p>
|
|
810
1348
|
*/
|
|
811
|
-
roleArn
|
|
1349
|
+
roleArn?: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated
|
|
1352
|
+
* environment account. It determines the scope of infrastructure that a component can provision in the account.</p>
|
|
1353
|
+
* <p>The environment account connection must have a <code>componentRoleArn</code> to allow directly defined components to be associated with any
|
|
1354
|
+
* environments running in the account.</p>
|
|
1355
|
+
* <p>For more information about components, see
|
|
1356
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1357
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1358
|
+
*/
|
|
1359
|
+
componentRoleArn?: string;
|
|
812
1360
|
}
|
|
813
1361
|
export declare namespace UpdateEnvironmentAccountConnectionInput {
|
|
814
1362
|
/**
|
|
@@ -845,25 +1393,6 @@ export declare namespace ListEnvironmentOutputsInput {
|
|
|
845
1393
|
*/
|
|
846
1394
|
const filterSensitiveLog: (obj: ListEnvironmentOutputsInput) => any;
|
|
847
1395
|
}
|
|
848
|
-
/**
|
|
849
|
-
* <p>An infrastructure as code defined resource output.</p>
|
|
850
|
-
*/
|
|
851
|
-
export interface Output {
|
|
852
|
-
/**
|
|
853
|
-
* <p>The output key.</p>
|
|
854
|
-
*/
|
|
855
|
-
key?: string;
|
|
856
|
-
/**
|
|
857
|
-
* <p>The output value.</p>
|
|
858
|
-
*/
|
|
859
|
-
valueString?: string;
|
|
860
|
-
}
|
|
861
|
-
export declare namespace Output {
|
|
862
|
-
/**
|
|
863
|
-
* @internal
|
|
864
|
-
*/
|
|
865
|
-
const filterSensitiveLog: (obj: Output) => any;
|
|
866
|
-
}
|
|
867
1396
|
export interface ListEnvironmentOutputsOutput {
|
|
868
1397
|
/**
|
|
869
1398
|
* <p>A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of
|
|
@@ -898,35 +1427,6 @@ export declare namespace ListEnvironmentProvisionedResourcesInput {
|
|
|
898
1427
|
*/
|
|
899
1428
|
const filterSensitiveLog: (obj: ListEnvironmentProvisionedResourcesInput) => any;
|
|
900
1429
|
}
|
|
901
|
-
export declare enum ProvisionedResourceEngine {
|
|
902
|
-
CLOUDFORMATION = "CLOUDFORMATION",
|
|
903
|
-
TERRAFORM = "TERRAFORM"
|
|
904
|
-
}
|
|
905
|
-
/**
|
|
906
|
-
* <p>Detail data for a provisioned resource.</p>
|
|
907
|
-
*/
|
|
908
|
-
export interface ProvisionedResource {
|
|
909
|
-
/**
|
|
910
|
-
* <p>The provisioned resource name.</p>
|
|
911
|
-
*/
|
|
912
|
-
name?: string;
|
|
913
|
-
/**
|
|
914
|
-
* <p>The provisioned resource identifier.</p>
|
|
915
|
-
*/
|
|
916
|
-
identifier?: string;
|
|
917
|
-
/**
|
|
918
|
-
* <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
|
|
919
|
-
* be used for self-managed provisioning.</p>
|
|
920
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton Administrator Guide</i>.</p>
|
|
921
|
-
*/
|
|
922
|
-
provisioningEngine?: ProvisionedResourceEngine | string;
|
|
923
|
-
}
|
|
924
|
-
export declare namespace ProvisionedResource {
|
|
925
|
-
/**
|
|
926
|
-
* @internal
|
|
927
|
-
*/
|
|
928
|
-
const filterSensitiveLog: (obj: ProvisionedResource) => any;
|
|
929
|
-
}
|
|
930
1430
|
export interface ListEnvironmentProvisionedResourcesOutput {
|
|
931
1431
|
/**
|
|
932
1432
|
* <p>A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested
|
|
@@ -995,6 +1495,15 @@ export interface CreateEnvironmentInput {
|
|
|
995
1495
|
* <code>protonServiceRoleArn</code> parameters.</p>
|
|
996
1496
|
*/
|
|
997
1497
|
provisioningRepository?: RepositoryBranchInput;
|
|
1498
|
+
/**
|
|
1499
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
1500
|
+
* determines the scope of infrastructure that a component can provision.</p>
|
|
1501
|
+
* <p>You must specify <code>componentRoleArn</code> to allow directly defined components to be associated with this environment.</p>
|
|
1502
|
+
* <p>For more information about components, see
|
|
1503
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1504
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1505
|
+
*/
|
|
1506
|
+
componentRoleArn?: string;
|
|
998
1507
|
}
|
|
999
1508
|
export declare namespace CreateEnvironmentInput {
|
|
1000
1509
|
/**
|
|
@@ -1028,7 +1537,7 @@ export declare namespace DeleteEnvironmentInput {
|
|
|
1028
1537
|
}
|
|
1029
1538
|
export interface DeleteEnvironmentOutput {
|
|
1030
1539
|
/**
|
|
1031
|
-
* <p>The
|
|
1540
|
+
* <p>The detailed data of the environment being deleted.</p>
|
|
1032
1541
|
*/
|
|
1033
1542
|
environment?: Environment;
|
|
1034
1543
|
}
|
|
@@ -1040,7 +1549,7 @@ export declare namespace DeleteEnvironmentOutput {
|
|
|
1040
1549
|
}
|
|
1041
1550
|
export interface GetEnvironmentInput {
|
|
1042
1551
|
/**
|
|
1043
|
-
* <p>The name of the environment that you want to get the
|
|
1552
|
+
* <p>The name of the environment that you want to get the detailed data for.</p>
|
|
1044
1553
|
*/
|
|
1045
1554
|
name: string | undefined;
|
|
1046
1555
|
}
|
|
@@ -1052,7 +1561,7 @@ export declare namespace GetEnvironmentInput {
|
|
|
1052
1561
|
}
|
|
1053
1562
|
export interface GetEnvironmentOutput {
|
|
1054
1563
|
/**
|
|
1055
|
-
* <p>The
|
|
1564
|
+
* <p>The detailed data of the requested environment.</p>
|
|
1056
1565
|
*/
|
|
1057
1566
|
environment: Environment | undefined;
|
|
1058
1567
|
}
|
|
@@ -1103,7 +1612,7 @@ export declare namespace ListEnvironmentsInput {
|
|
|
1103
1612
|
const filterSensitiveLog: (obj: ListEnvironmentsInput) => any;
|
|
1104
1613
|
}
|
|
1105
1614
|
/**
|
|
1106
|
-
* <p>
|
|
1615
|
+
* <p>Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.</p>
|
|
1107
1616
|
*/
|
|
1108
1617
|
export interface EnvironmentSummary {
|
|
1109
1618
|
/**
|
|
@@ -1166,6 +1675,15 @@ export interface EnvironmentSummary {
|
|
|
1166
1675
|
* <p>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</p>
|
|
1167
1676
|
*/
|
|
1168
1677
|
provisioning?: Provisioning | string;
|
|
1678
|
+
/**
|
|
1679
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
1680
|
+
* determines the scope of infrastructure that a component can provision.</p>
|
|
1681
|
+
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
1682
|
+
* <p>For more information about components, see
|
|
1683
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1684
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1685
|
+
*/
|
|
1686
|
+
componentRoleArn?: string;
|
|
1169
1687
|
}
|
|
1170
1688
|
export declare namespace EnvironmentSummary {
|
|
1171
1689
|
/**
|
|
@@ -1267,6 +1785,15 @@ export interface UpdateEnvironmentInput {
|
|
|
1267
1785
|
* <p>The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.</p>
|
|
1268
1786
|
*/
|
|
1269
1787
|
provisioningRepository?: RepositoryBranchInput;
|
|
1788
|
+
/**
|
|
1789
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It
|
|
1790
|
+
* determines the scope of infrastructure that a component can provision.</p>
|
|
1791
|
+
* <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p>
|
|
1792
|
+
* <p>For more information about components, see
|
|
1793
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
1794
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
1795
|
+
*/
|
|
1796
|
+
componentRoleArn?: string;
|
|
1270
1797
|
}
|
|
1271
1798
|
export declare namespace UpdateEnvironmentInput {
|
|
1272
1799
|
/**
|
|
@@ -1392,7 +1919,7 @@ export declare namespace DeleteEnvironmentTemplateInput {
|
|
|
1392
1919
|
}
|
|
1393
1920
|
export interface DeleteEnvironmentTemplateOutput {
|
|
1394
1921
|
/**
|
|
1395
|
-
* <p>The
|
|
1922
|
+
* <p>The detailed data of the environment template being deleted.</p>
|
|
1396
1923
|
*/
|
|
1397
1924
|
environmentTemplate?: EnvironmentTemplate;
|
|
1398
1925
|
}
|
|
@@ -1404,7 +1931,7 @@ export declare namespace DeleteEnvironmentTemplateOutput {
|
|
|
1404
1931
|
}
|
|
1405
1932
|
export interface GetEnvironmentTemplateInput {
|
|
1406
1933
|
/**
|
|
1407
|
-
* <p>The name of the environment template that you want to get the
|
|
1934
|
+
* <p>The name of the environment template that you want to get the detailed data for.</p>
|
|
1408
1935
|
*/
|
|
1409
1936
|
name: string | undefined;
|
|
1410
1937
|
}
|
|
@@ -1416,7 +1943,7 @@ export declare namespace GetEnvironmentTemplateInput {
|
|
|
1416
1943
|
}
|
|
1417
1944
|
export interface GetEnvironmentTemplateOutput {
|
|
1418
1945
|
/**
|
|
1419
|
-
* <p>The
|
|
1946
|
+
* <p>The detailed data of the requested environment template.</p>
|
|
1420
1947
|
*/
|
|
1421
1948
|
environmentTemplate: EnvironmentTemplate | undefined;
|
|
1422
1949
|
}
|
|
@@ -1710,7 +2237,7 @@ export declare namespace DeleteEnvironmentTemplateVersionInput {
|
|
|
1710
2237
|
}
|
|
1711
2238
|
export interface DeleteEnvironmentTemplateVersionOutput {
|
|
1712
2239
|
/**
|
|
1713
|
-
* <p>The
|
|
2240
|
+
* <p>The detailed data of the environment template version being deleted.</p>
|
|
1714
2241
|
*/
|
|
1715
2242
|
environmentTemplateVersion?: EnvironmentTemplateVersion;
|
|
1716
2243
|
}
|
|
@@ -1722,15 +2249,15 @@ export declare namespace DeleteEnvironmentTemplateVersionOutput {
|
|
|
1722
2249
|
}
|
|
1723
2250
|
export interface GetEnvironmentTemplateVersionInput {
|
|
1724
2251
|
/**
|
|
1725
|
-
* <p>The name of the environment template
|
|
2252
|
+
* <p>The name of the environment template a version of which you want to get detailed data for..</p>
|
|
1726
2253
|
*/
|
|
1727
2254
|
templateName: string | undefined;
|
|
1728
2255
|
/**
|
|
1729
|
-
* <p>To
|
|
2256
|
+
* <p>To get environment template major version detail data, include <code>major Version</code>.</p>
|
|
1730
2257
|
*/
|
|
1731
2258
|
majorVersion: string | undefined;
|
|
1732
2259
|
/**
|
|
1733
|
-
* <p>To
|
|
2260
|
+
* <p>To get environment template minor version detail data, include <code>minorVersion</code>.</p>
|
|
1734
2261
|
*/
|
|
1735
2262
|
minorVersion: string | undefined;
|
|
1736
2263
|
}
|
|
@@ -1742,7 +2269,7 @@ export declare namespace GetEnvironmentTemplateVersionInput {
|
|
|
1742
2269
|
}
|
|
1743
2270
|
export interface GetEnvironmentTemplateVersionOutput {
|
|
1744
2271
|
/**
|
|
1745
|
-
* <p>The
|
|
2272
|
+
* <p>The detailed data of the requested environment template version.</p>
|
|
1746
2273
|
*/
|
|
1747
2274
|
environmentTemplateVersion: EnvironmentTemplateVersion | undefined;
|
|
1748
2275
|
}
|
|
@@ -2340,7 +2867,7 @@ export declare namespace CreateRepositoryInput {
|
|
|
2340
2867
|
const filterSensitiveLog: (obj: CreateRepositoryInput) => any;
|
|
2341
2868
|
}
|
|
2342
2869
|
/**
|
|
2343
|
-
* <p>
|
|
2870
|
+
* <p>Detailed data of a repository that has been registered with Proton.</p>
|
|
2344
2871
|
*/
|
|
2345
2872
|
export interface Repository {
|
|
2346
2873
|
/**
|
|
@@ -2455,7 +2982,7 @@ export declare namespace ListRepositoriesInput {
|
|
|
2455
2982
|
const filterSensitiveLog: (obj: ListRepositoriesInput) => any;
|
|
2456
2983
|
}
|
|
2457
2984
|
/**
|
|
2458
|
-
* <p>
|
|
2985
|
+
* <p>Summary data of a repository that has been registered with Proton.</p>
|
|
2459
2986
|
*/
|
|
2460
2987
|
export interface RepositorySummary {
|
|
2461
2988
|
/**
|
|
@@ -2495,11 +3022,11 @@ export declare namespace ListRepositoriesOutput {
|
|
|
2495
3022
|
}
|
|
2496
3023
|
export interface ListServiceInstanceOutputsInput {
|
|
2497
3024
|
/**
|
|
2498
|
-
* <p>The service instance
|
|
3025
|
+
* <p>The name of the service instance whose outputs you want.</p>
|
|
2499
3026
|
*/
|
|
2500
3027
|
serviceInstanceName: string | undefined;
|
|
2501
3028
|
/**
|
|
2502
|
-
* <p>The service
|
|
3029
|
+
* <p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>
|
|
2503
3030
|
*/
|
|
2504
3031
|
serviceName: string | undefined;
|
|
2505
3032
|
/**
|
|
@@ -2519,7 +3046,7 @@ export interface ListServiceInstanceOutputsOutput {
|
|
|
2519
3046
|
*/
|
|
2520
3047
|
nextToken?: string;
|
|
2521
3048
|
/**
|
|
2522
|
-
* <p>An array of service instance
|
|
3049
|
+
* <p>An array of service instance Infrastructure as Code (IaC) outputs.</p>
|
|
2523
3050
|
*/
|
|
2524
3051
|
outputs: Output[] | undefined;
|
|
2525
3052
|
}
|
|
@@ -2531,11 +3058,11 @@ export declare namespace ListServiceInstanceOutputsOutput {
|
|
|
2531
3058
|
}
|
|
2532
3059
|
export interface ListServiceInstanceProvisionedResourcesInput {
|
|
2533
3060
|
/**
|
|
2534
|
-
* <p>The service
|
|
3061
|
+
* <p>The name of the service that <code>serviceInstanceName</code> is associated to.</p>
|
|
2535
3062
|
*/
|
|
2536
3063
|
serviceName: string | undefined;
|
|
2537
3064
|
/**
|
|
2538
|
-
* <p>The service instance
|
|
3065
|
+
* <p>The name of the service instance whose provisioned resources you want.</p>
|
|
2539
3066
|
*/
|
|
2540
3067
|
serviceInstanceName: string | undefined;
|
|
2541
3068
|
/**
|
|
@@ -2569,7 +3096,7 @@ export declare namespace ListServiceInstanceProvisionedResourcesOutput {
|
|
|
2569
3096
|
}
|
|
2570
3097
|
export interface GetServiceInstanceInput {
|
|
2571
3098
|
/**
|
|
2572
|
-
* <p>The name of a service instance that you want to get the
|
|
3099
|
+
* <p>The name of a service instance that you want to get the detailed data for.</p>
|
|
2573
3100
|
*/
|
|
2574
3101
|
name: string | undefined;
|
|
2575
3102
|
/**
|
|
@@ -2585,7 +3112,7 @@ export declare namespace GetServiceInstanceInput {
|
|
|
2585
3112
|
}
|
|
2586
3113
|
export interface GetServiceInstanceOutput {
|
|
2587
3114
|
/**
|
|
2588
|
-
* <p>The
|
|
3115
|
+
* <p>The detailed data of the requested service instance.</p>
|
|
2589
3116
|
*/
|
|
2590
3117
|
serviceInstance: ServiceInstance | undefined;
|
|
2591
3118
|
}
|
|
@@ -2617,7 +3144,7 @@ export declare namespace ListServiceInstancesInput {
|
|
|
2617
3144
|
const filterSensitiveLog: (obj: ListServiceInstancesInput) => any;
|
|
2618
3145
|
}
|
|
2619
3146
|
/**
|
|
2620
|
-
* <p>
|
|
3147
|
+
* <p>Summary data of an Proton service instance resource.</p>
|
|
2621
3148
|
*/
|
|
2622
3149
|
export interface ServiceInstanceSummary {
|
|
2623
3150
|
/**
|
|
@@ -2682,7 +3209,7 @@ export interface ListServiceInstancesOutput {
|
|
|
2682
3209
|
*/
|
|
2683
3210
|
nextToken?: string;
|
|
2684
3211
|
/**
|
|
2685
|
-
* <p>An array of service instances with
|
|
3212
|
+
* <p>An array of service instances with summary data.</p>
|
|
2686
3213
|
*/
|
|
2687
3214
|
serviceInstances: ServiceInstanceSummary[] | undefined;
|
|
2688
3215
|
}
|
|
@@ -2702,8 +3229,7 @@ export interface UpdateServiceInstanceInput {
|
|
|
2702
3229
|
*/
|
|
2703
3230
|
serviceName: string | undefined;
|
|
2704
3231
|
/**
|
|
2705
|
-
* <p>The deployment type
|
|
2706
|
-
* <p>There are four modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p>
|
|
3232
|
+
* <p>The deployment type. It defines the mode for updating a service instance, as follows:</p>
|
|
2707
3233
|
* <dl>
|
|
2708
3234
|
* <dt/>
|
|
2709
3235
|
* <dd>
|
|
@@ -2718,7 +3244,7 @@ export interface UpdateServiceInstanceInput {
|
|
|
2718
3244
|
* <code>CURRENT_VERSION</code>
|
|
2719
3245
|
* </p>
|
|
2720
3246
|
* <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
2721
|
-
* <i>Don’t</i> include major or minor version parameters when you use this
|
|
3247
|
+
* <i>Don’t</i> include major or minor version parameters when you use this deployment type.</p>
|
|
2722
3248
|
* </dd>
|
|
2723
3249
|
* <dt/>
|
|
2724
3250
|
* <dd>
|
|
@@ -2772,7 +3298,7 @@ export declare namespace UpdateServiceInstanceOutput {
|
|
|
2772
3298
|
}
|
|
2773
3299
|
export interface ListServicePipelineOutputsInput {
|
|
2774
3300
|
/**
|
|
2775
|
-
* <p>The service
|
|
3301
|
+
* <p>The name of the service whose pipeline's outputs you want.</p>
|
|
2776
3302
|
*/
|
|
2777
3303
|
serviceName: string | undefined;
|
|
2778
3304
|
/**
|
|
@@ -2792,7 +3318,7 @@ export interface ListServicePipelineOutputsOutput {
|
|
|
2792
3318
|
*/
|
|
2793
3319
|
nextToken?: string;
|
|
2794
3320
|
/**
|
|
2795
|
-
* <p>An array of outputs.</p>
|
|
3321
|
+
* <p>An array of service pipeline Infrastructure as Code (IaC) outputs.</p>
|
|
2796
3322
|
*/
|
|
2797
3323
|
outputs: Output[] | undefined;
|
|
2798
3324
|
}
|
|
@@ -2804,7 +3330,7 @@ export declare namespace ListServicePipelineOutputsOutput {
|
|
|
2804
3330
|
}
|
|
2805
3331
|
export interface ListServicePipelineProvisionedResourcesInput {
|
|
2806
3332
|
/**
|
|
2807
|
-
* <p>The service
|
|
3333
|
+
* <p>The name of the service whose pipeline's provisioned resources you want.</p>
|
|
2808
3334
|
*/
|
|
2809
3335
|
serviceName: string | undefined;
|
|
2810
3336
|
/**
|
|
@@ -2985,7 +3511,7 @@ export declare enum ServiceStatus {
|
|
|
2985
3511
|
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
|
|
2986
3512
|
}
|
|
2987
3513
|
/**
|
|
2988
|
-
* <p>
|
|
3514
|
+
* <p>Detailed data of an Proton service resource.</p>
|
|
2989
3515
|
*/
|
|
2990
3516
|
export interface Service {
|
|
2991
3517
|
/**
|
|
@@ -2993,7 +3519,7 @@ export interface Service {
|
|
|
2993
3519
|
*/
|
|
2994
3520
|
name: string | undefined;
|
|
2995
3521
|
/**
|
|
2996
|
-
* <p>A description of
|
|
3522
|
+
* <p>A description of the service.</p>
|
|
2997
3523
|
*/
|
|
2998
3524
|
description?: string;
|
|
2999
3525
|
/**
|
|
@@ -3075,7 +3601,7 @@ export declare namespace DeleteServiceInput {
|
|
|
3075
3601
|
}
|
|
3076
3602
|
export interface DeleteServiceOutput {
|
|
3077
3603
|
/**
|
|
3078
|
-
* <p>The
|
|
3604
|
+
* <p>The detailed data of the service being deleted.</p>
|
|
3079
3605
|
*/
|
|
3080
3606
|
service?: Service;
|
|
3081
3607
|
}
|
|
@@ -3087,7 +3613,7 @@ export declare namespace DeleteServiceOutput {
|
|
|
3087
3613
|
}
|
|
3088
3614
|
export interface GetServiceInput {
|
|
3089
3615
|
/**
|
|
3090
|
-
* <p>The name of the service that you want to get the
|
|
3616
|
+
* <p>The name of the service that you want to get the detailed data for.</p>
|
|
3091
3617
|
*/
|
|
3092
3618
|
name: string | undefined;
|
|
3093
3619
|
}
|
|
@@ -3099,7 +3625,7 @@ export declare namespace GetServiceInput {
|
|
|
3099
3625
|
}
|
|
3100
3626
|
export interface GetServiceOutput {
|
|
3101
3627
|
/**
|
|
3102
|
-
* <p>The
|
|
3628
|
+
* <p>The detailed data of the requested service.</p>
|
|
3103
3629
|
*/
|
|
3104
3630
|
service?: Service;
|
|
3105
3631
|
}
|
|
@@ -3126,7 +3652,7 @@ export declare namespace ListServicesInput {
|
|
|
3126
3652
|
const filterSensitiveLog: (obj: ListServicesInput) => any;
|
|
3127
3653
|
}
|
|
3128
3654
|
/**
|
|
3129
|
-
* <p>
|
|
3655
|
+
* <p>Summary data of an Proton service resource.</p>
|
|
3130
3656
|
*/
|
|
3131
3657
|
export interface ServiceSummary {
|
|
3132
3658
|
/**
|
|
@@ -3254,7 +3780,7 @@ export declare namespace CreateServiceTemplateInput {
|
|
|
3254
3780
|
const filterSensitiveLog: (obj: CreateServiceTemplateInput) => any;
|
|
3255
3781
|
}
|
|
3256
3782
|
/**
|
|
3257
|
-
* <p>
|
|
3783
|
+
* <p>Detailed data of an Proton service template resource.</p>
|
|
3258
3784
|
*/
|
|
3259
3785
|
export interface ServiceTemplate {
|
|
3260
3786
|
/**
|
|
@@ -3327,7 +3853,7 @@ export declare namespace DeleteServiceTemplateInput {
|
|
|
3327
3853
|
}
|
|
3328
3854
|
export interface DeleteServiceTemplateOutput {
|
|
3329
3855
|
/**
|
|
3330
|
-
* <p>The
|
|
3856
|
+
* <p>The detailed data of the service template being deleted.</p>
|
|
3331
3857
|
*/
|
|
3332
3858
|
serviceTemplate?: ServiceTemplate;
|
|
3333
3859
|
}
|
|
@@ -3339,7 +3865,7 @@ export declare namespace DeleteServiceTemplateOutput {
|
|
|
3339
3865
|
}
|
|
3340
3866
|
export interface GetServiceTemplateInput {
|
|
3341
3867
|
/**
|
|
3342
|
-
* <p>The name of the service template that you want to get
|
|
3868
|
+
* <p>The name of the service template that you want to get detailed data for.</p>
|
|
3343
3869
|
*/
|
|
3344
3870
|
name: string | undefined;
|
|
3345
3871
|
}
|
|
@@ -3351,7 +3877,7 @@ export declare namespace GetServiceTemplateInput {
|
|
|
3351
3877
|
}
|
|
3352
3878
|
export interface GetServiceTemplateOutput {
|
|
3353
3879
|
/**
|
|
3354
|
-
* <p>The
|
|
3880
|
+
* <p>The detailed data of the requested service template.</p>
|
|
3355
3881
|
*/
|
|
3356
3882
|
serviceTemplate: ServiceTemplate | undefined;
|
|
3357
3883
|
}
|
|
@@ -3379,7 +3905,7 @@ export declare namespace ListServiceTemplatesInput {
|
|
|
3379
3905
|
const filterSensitiveLog: (obj: ListServiceTemplatesInput) => any;
|
|
3380
3906
|
}
|
|
3381
3907
|
/**
|
|
3382
|
-
* <p>
|
|
3908
|
+
* <p>Summary data of an Proton service template resource.</p>
|
|
3383
3909
|
*/
|
|
3384
3910
|
export interface ServiceTemplateSummary {
|
|
3385
3911
|
/**
|
|
@@ -3490,6 +4016,9 @@ export declare namespace CompatibleEnvironmentTemplateInput {
|
|
|
3490
4016
|
*/
|
|
3491
4017
|
const filterSensitiveLog: (obj: CompatibleEnvironmentTemplateInput) => any;
|
|
3492
4018
|
}
|
|
4019
|
+
export declare enum ServiceTemplateSupportedComponentSourceType {
|
|
4020
|
+
DIRECTLY_DEFINED = "DIRECTLY_DEFINED"
|
|
4021
|
+
}
|
|
3493
4022
|
export interface CreateServiceTemplateVersionInput {
|
|
3494
4023
|
/**
|
|
3495
4024
|
* <p>When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request
|
|
@@ -3515,7 +4044,8 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
3515
4044
|
*/
|
|
3516
4045
|
source: TemplateVersionSourceInput | undefined;
|
|
3517
4046
|
/**
|
|
3518
|
-
* <p>An array of
|
|
4047
|
+
* <p>An array of environment template objects that are compatible with the new service template version. A service instance based on this service template
|
|
4048
|
+
* version can run in environments based on compatible templates.</p>
|
|
3519
4049
|
*/
|
|
3520
4050
|
compatibleEnvironmentTemplates: CompatibleEnvironmentTemplateInput[] | undefined;
|
|
3521
4051
|
/**
|
|
@@ -3523,6 +4053,14 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
3523
4053
|
* <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
|
|
3524
4054
|
*/
|
|
3525
4055
|
tags?: Tag[];
|
|
4056
|
+
/**
|
|
4057
|
+
* <p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template
|
|
4058
|
+
* version.</p>
|
|
4059
|
+
* <p>For more information about components, see
|
|
4060
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
4061
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
4062
|
+
*/
|
|
4063
|
+
supportedComponentSources?: (ServiceTemplateSupportedComponentSourceType | string)[];
|
|
3526
4064
|
}
|
|
3527
4065
|
export declare namespace CreateServiceTemplateVersionInput {
|
|
3528
4066
|
/**
|
|
@@ -3550,7 +4088,7 @@ export declare namespace CompatibleEnvironmentTemplate {
|
|
|
3550
4088
|
const filterSensitiveLog: (obj: CompatibleEnvironmentTemplate) => any;
|
|
3551
4089
|
}
|
|
3552
4090
|
/**
|
|
3553
|
-
* <p>
|
|
4091
|
+
* <p>Detailed data of an Proton service template version resource.</p>
|
|
3554
4092
|
*/
|
|
3555
4093
|
export interface ServiceTemplateVersion {
|
|
3556
4094
|
/**
|
|
@@ -3601,6 +4139,14 @@ export interface ServiceTemplateVersion {
|
|
|
3601
4139
|
* <p>The schema of the version of a service template.</p>
|
|
3602
4140
|
*/
|
|
3603
4141
|
schema?: string;
|
|
4142
|
+
/**
|
|
4143
|
+
* <p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template
|
|
4144
|
+
* version.</p>
|
|
4145
|
+
* <p>For more information about components, see
|
|
4146
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
4147
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
4148
|
+
*/
|
|
4149
|
+
supportedComponentSources?: (ServiceTemplateSupportedComponentSourceType | string)[];
|
|
3604
4150
|
}
|
|
3605
4151
|
export declare namespace ServiceTemplateVersion {
|
|
3606
4152
|
/**
|
|
@@ -3642,7 +4188,7 @@ export declare namespace DeleteServiceTemplateVersionInput {
|
|
|
3642
4188
|
}
|
|
3643
4189
|
export interface DeleteServiceTemplateVersionOutput {
|
|
3644
4190
|
/**
|
|
3645
|
-
* <p>The
|
|
4191
|
+
* <p>The detailed data of the service template version being deleted.</p>
|
|
3646
4192
|
*/
|
|
3647
4193
|
serviceTemplateVersion?: ServiceTemplateVersion;
|
|
3648
4194
|
}
|
|
@@ -3654,15 +4200,15 @@ export declare namespace DeleteServiceTemplateVersionOutput {
|
|
|
3654
4200
|
}
|
|
3655
4201
|
export interface GetServiceTemplateVersionInput {
|
|
3656
4202
|
/**
|
|
3657
|
-
* <p>The name of the service template.</p>
|
|
4203
|
+
* <p>The name of the service template a version of which you want to get detailed data for.</p>
|
|
3658
4204
|
*/
|
|
3659
4205
|
templateName: string | undefined;
|
|
3660
4206
|
/**
|
|
3661
|
-
* <p>To
|
|
4207
|
+
* <p>To get service template major version detail data, include <code>major Version</code>.</p>
|
|
3662
4208
|
*/
|
|
3663
4209
|
majorVersion: string | undefined;
|
|
3664
4210
|
/**
|
|
3665
|
-
* <p>To
|
|
4211
|
+
* <p>To get service template minor version detail data, include <code>minorVersion</code>.</p>
|
|
3666
4212
|
*/
|
|
3667
4213
|
minorVersion: string | undefined;
|
|
3668
4214
|
}
|
|
@@ -3674,7 +4220,7 @@ export declare namespace GetServiceTemplateVersionInput {
|
|
|
3674
4220
|
}
|
|
3675
4221
|
export interface GetServiceTemplateVersionOutput {
|
|
3676
4222
|
/**
|
|
3677
|
-
* <p>The
|
|
4223
|
+
* <p>The detailed data of the requested service template version.</p>
|
|
3678
4224
|
*/
|
|
3679
4225
|
serviceTemplateVersion: ServiceTemplateVersion | undefined;
|
|
3680
4226
|
}
|
|
@@ -3712,7 +4258,7 @@ export declare namespace ListServiceTemplateVersionsInput {
|
|
|
3712
4258
|
const filterSensitiveLog: (obj: ListServiceTemplateVersionsInput) => any;
|
|
3713
4259
|
}
|
|
3714
4260
|
/**
|
|
3715
|
-
* <p>
|
|
4261
|
+
* <p>Summary data of an Proton service template version resource.</p>
|
|
3716
4262
|
*/
|
|
3717
4263
|
export interface ServiceTemplateVersionSummary {
|
|
3718
4264
|
/**
|
|
@@ -3801,9 +4347,22 @@ export interface UpdateServiceTemplateVersionInput {
|
|
|
3801
4347
|
*/
|
|
3802
4348
|
status?: TemplateVersionStatus | string;
|
|
3803
4349
|
/**
|
|
3804
|
-
* <p>An array of
|
|
4350
|
+
* <p>An array of environment template objects that are compatible with this service template version. A service instance based on this service template
|
|
4351
|
+
* version can run in environments based on compatible templates.</p>
|
|
3805
4352
|
*/
|
|
3806
4353
|
compatibleEnvironmentTemplates?: CompatibleEnvironmentTemplateInput[];
|
|
4354
|
+
/**
|
|
4355
|
+
* <p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template
|
|
4356
|
+
* version.</p>
|
|
4357
|
+
* <note>
|
|
4358
|
+
* <p>A change to <code>supportedComponentSources</code> doesn't impact existing component attachments to instances based on this template version. A
|
|
4359
|
+
* change only affects later associations.</p>
|
|
4360
|
+
* </note>
|
|
4361
|
+
* <p>For more information about components, see
|
|
4362
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-components.html">Proton components</a> in the
|
|
4363
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
4364
|
+
*/
|
|
4365
|
+
supportedComponentSources?: (ServiceTemplateSupportedComponentSourceType | string)[];
|
|
3807
4366
|
}
|
|
3808
4367
|
export declare namespace UpdateServiceTemplateVersionInput {
|
|
3809
4368
|
/**
|