@aws-sdk/client-proton 3.55.0 → 3.63.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 +27 -0
- package/README.md +36 -46
- package/dist-cjs/protocols/Aws_json1_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +1 -1
- package/dist-types/Proton.d.ts +153 -162
- package/dist-types/ProtonClient.d.ts +36 -46
- package/dist-types/commands/AcceptEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/CancelEnvironmentDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CreateEnvironmentAccountConnectionCommand.d.ts +5 -5
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +7 -8
- package/dist-types/commands/CreateEnvironmentTemplateCommand.d.ts +5 -4
- package/dist-types/commands/CreateEnvironmentTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateRepositoryCommand.d.ts +5 -3
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -4
- package/dist-types/commands/CreateServiceTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +3 -4
- package/dist-types/commands/DeleteEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteEnvironmentTemplateVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteServiceTemplateVersionCommand.d.ts +6 -6
- package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GetRepositorySyncStatusCommand.d.ts +8 -1
- package/dist-types/commands/GetServiceInstanceCommand.d.ts +1 -2
- package/dist-types/commands/ListEnvironmentAccountConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -7
- package/dist-types/commands/RejectEnvironmentAccountConnectionCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +19 -18
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +5 -7
- package/dist-types/commands/UpdateServicePipelineCommand.d.ts +5 -7
- package/dist-types/models/models_0.d.ts +180 -227
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +18 -18
|
@@ -153,12 +153,6 @@ export declare enum RepositoryProvider {
|
|
|
153
153
|
}
|
|
154
154
|
/**
|
|
155
155
|
* <p>Detail data for a repository branch.</p>
|
|
156
|
-
* <important>
|
|
157
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
158
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
159
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
160
|
-
* Previews.</p>
|
|
161
|
-
* </important>
|
|
162
156
|
*/
|
|
163
157
|
export interface RepositoryBranch {
|
|
164
158
|
/**
|
|
@@ -185,21 +179,17 @@ export declare namespace RepositoryBranch {
|
|
|
185
179
|
const filterSensitiveLog: (obj: RepositoryBranch) => any;
|
|
186
180
|
}
|
|
187
181
|
/**
|
|
188
|
-
* <p>The Proton pipeline service role and repository data.</p>
|
|
182
|
+
* <p>The Proton pipeline service role and repository data shared across the Amazon Web Services account.</p>
|
|
189
183
|
*/
|
|
190
184
|
export interface AccountSettings {
|
|
191
185
|
/**
|
|
192
|
-
* <p>The Amazon Resource Name (ARN) of the Proton
|
|
186
|
+
* <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
|
|
187
|
+
* customer-owned automation for self-managed provisioning.</p>
|
|
193
188
|
*/
|
|
194
189
|
pipelineServiceRoleArn?: string;
|
|
195
190
|
/**
|
|
196
|
-
* <p>The repository
|
|
197
|
-
*
|
|
198
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
199
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
200
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
201
|
-
* Previews.</p>
|
|
202
|
-
* </important>
|
|
191
|
+
* <p>The repository configured in the Amazon Web Services account for pipeline provisioning. Required it if you have environments configured for self-managed
|
|
192
|
+
* provisioning with services that include pipelines.</p>
|
|
203
193
|
*/
|
|
204
194
|
pipelineProvisioningRepository?: RepositoryBranch;
|
|
205
195
|
}
|
|
@@ -231,12 +221,6 @@ export declare namespace GetAccountSettingsOutput {
|
|
|
231
221
|
}
|
|
232
222
|
/**
|
|
233
223
|
* <p>Detail input data for a repository branch.</p>
|
|
234
|
-
* <important>
|
|
235
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
236
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
237
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
238
|
-
* Previews.</p>
|
|
239
|
-
* </important>
|
|
240
224
|
*/
|
|
241
225
|
export interface RepositoryBranchInput {
|
|
242
226
|
/**
|
|
@@ -260,23 +244,13 @@ export declare namespace RepositoryBranchInput {
|
|
|
260
244
|
}
|
|
261
245
|
export interface UpdateAccountSettingsInput {
|
|
262
246
|
/**
|
|
263
|
-
* <p>The Amazon Resource Name (ARN) of the Proton
|
|
264
|
-
*
|
|
265
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
266
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
267
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
268
|
-
* Previews.</p>
|
|
269
|
-
* </important>
|
|
247
|
+
* <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
|
|
248
|
+
* customer-owned automation for self-managed provisioning.</p>
|
|
270
249
|
*/
|
|
271
250
|
pipelineServiceRoleArn?: string;
|
|
272
251
|
/**
|
|
273
|
-
* <p>
|
|
274
|
-
*
|
|
275
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
276
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
277
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
278
|
-
* Previews.</p>
|
|
279
|
-
* </important>
|
|
252
|
+
* <p>A repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include
|
|
253
|
+
* pipelines.</p>
|
|
280
254
|
*/
|
|
281
255
|
pipelineProvisioningRepository?: RepositoryBranchInput;
|
|
282
256
|
}
|
|
@@ -288,7 +262,7 @@ export declare namespace UpdateAccountSettingsInput {
|
|
|
288
262
|
}
|
|
289
263
|
export interface UpdateAccountSettingsOutput {
|
|
290
264
|
/**
|
|
291
|
-
* <p>The Proton pipeline service role repository
|
|
265
|
+
* <p>The Proton pipeline service role and repository data shared across the Amazon Web Services account.</p>
|
|
292
266
|
*/
|
|
293
267
|
accountSettings: AccountSettings | undefined;
|
|
294
268
|
}
|
|
@@ -356,11 +330,11 @@ export interface Environment {
|
|
|
356
330
|
*/
|
|
357
331
|
templateName: string | undefined;
|
|
358
332
|
/**
|
|
359
|
-
* <p>The
|
|
333
|
+
* <p>The major version of the environment template.</p>
|
|
360
334
|
*/
|
|
361
335
|
templateMajorVersion: string | undefined;
|
|
362
336
|
/**
|
|
363
|
-
* <p>The
|
|
337
|
+
* <p>The minor version of the environment template.</p>
|
|
364
338
|
*/
|
|
365
339
|
templateMinorVersion: string | undefined;
|
|
366
340
|
/**
|
|
@@ -392,13 +366,7 @@ export interface Environment {
|
|
|
392
366
|
*/
|
|
393
367
|
provisioning?: Provisioning | string;
|
|
394
368
|
/**
|
|
395
|
-
* <p>The repository that you
|
|
396
|
-
* <important>
|
|
397
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
398
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
399
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
400
|
-
* Previews.</p>
|
|
401
|
-
* </important>
|
|
369
|
+
* <p>The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.</p>
|
|
402
370
|
*/
|
|
403
371
|
provisioningRepository?: RepositoryBranch;
|
|
404
372
|
}
|
|
@@ -607,19 +575,19 @@ export declare namespace Tag {
|
|
|
607
575
|
}
|
|
608
576
|
export interface CreateEnvironmentAccountConnectionInput {
|
|
609
577
|
/**
|
|
610
|
-
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the
|
|
611
|
-
*
|
|
578
|
+
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first
|
|
579
|
+
* request created.</p>
|
|
612
580
|
*/
|
|
613
581
|
clientToken?: string;
|
|
614
582
|
/**
|
|
615
|
-
* <p>The ID of the management account that accepts or rejects the environment account connection. You create
|
|
616
|
-
*
|
|
617
|
-
*
|
|
583
|
+
* <p>The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this
|
|
584
|
+
* account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment
|
|
585
|
+
* infrastructure resources in the associated environment account.</p>
|
|
618
586
|
*/
|
|
619
587
|
managementAccountId: string | undefined;
|
|
620
588
|
/**
|
|
621
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision
|
|
622
|
-
*
|
|
589
|
+
* <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
|
|
590
|
+
* resources in the associated environment account.</p>
|
|
623
591
|
*/
|
|
624
592
|
roleArn: string | undefined;
|
|
625
593
|
/**
|
|
@@ -627,8 +595,9 @@ export interface CreateEnvironmentAccountConnectionInput {
|
|
|
627
595
|
*/
|
|
628
596
|
environmentName: string | undefined;
|
|
629
597
|
/**
|
|
630
|
-
* <p>
|
|
631
|
-
*
|
|
598
|
+
* <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>
|
|
599
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton resources and tagging</a> in the
|
|
600
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
632
601
|
*/
|
|
633
602
|
tags?: Tag[];
|
|
634
603
|
}
|
|
@@ -728,8 +697,8 @@ export interface ListEnvironmentAccountConnectionsInput {
|
|
|
728
697
|
*/
|
|
729
698
|
statuses?: (EnvironmentAccountConnectionStatus | string)[];
|
|
730
699
|
/**
|
|
731
|
-
* <p>A token
|
|
732
|
-
*
|
|
700
|
+
* <p>A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of
|
|
701
|
+
* environment account connections that was previously requested.</p>
|
|
733
702
|
*/
|
|
734
703
|
nextToken?: string;
|
|
735
704
|
/**
|
|
@@ -796,8 +765,8 @@ export interface ListEnvironmentAccountConnectionsOutput {
|
|
|
796
765
|
*/
|
|
797
766
|
environmentAccountConnections: EnvironmentAccountConnectionSummary[] | undefined;
|
|
798
767
|
/**
|
|
799
|
-
* <p>A token
|
|
800
|
-
*
|
|
768
|
+
* <p>A token that indicates the location of the next environment account connection in the array of environment account connections, after the current
|
|
769
|
+
* requested list of environment account connections.</p>
|
|
801
770
|
*/
|
|
802
771
|
nextToken?: string;
|
|
803
772
|
}
|
|
@@ -837,7 +806,7 @@ export interface UpdateEnvironmentAccountConnectionInput {
|
|
|
837
806
|
*/
|
|
838
807
|
id: string | undefined;
|
|
839
808
|
/**
|
|
840
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role that
|
|
809
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.</p>
|
|
841
810
|
*/
|
|
842
811
|
roleArn: string | undefined;
|
|
843
812
|
}
|
|
@@ -865,8 +834,8 @@ export interface ListEnvironmentOutputsInput {
|
|
|
865
834
|
*/
|
|
866
835
|
environmentName: string | undefined;
|
|
867
836
|
/**
|
|
868
|
-
* <p>A token
|
|
869
|
-
*
|
|
837
|
+
* <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
|
|
838
|
+
* previously requested.</p>
|
|
870
839
|
*/
|
|
871
840
|
nextToken?: string;
|
|
872
841
|
}
|
|
@@ -897,8 +866,8 @@ export declare namespace Output {
|
|
|
897
866
|
}
|
|
898
867
|
export interface ListEnvironmentOutputsOutput {
|
|
899
868
|
/**
|
|
900
|
-
* <p>A token
|
|
901
|
-
*
|
|
869
|
+
* <p>A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of
|
|
870
|
+
* environment outputs.</p>
|
|
902
871
|
*/
|
|
903
872
|
nextToken?: string;
|
|
904
873
|
/**
|
|
@@ -918,8 +887,8 @@ export interface ListEnvironmentProvisionedResourcesInput {
|
|
|
918
887
|
*/
|
|
919
888
|
environmentName: string | undefined;
|
|
920
889
|
/**
|
|
921
|
-
* <p>A token
|
|
922
|
-
*
|
|
890
|
+
* <p>A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of
|
|
891
|
+
* environment provisioned resources that was previously requested.</p>
|
|
923
892
|
*/
|
|
924
893
|
nextToken?: string;
|
|
925
894
|
}
|
|
@@ -946,13 +915,9 @@ export interface ProvisionedResource {
|
|
|
946
915
|
*/
|
|
947
916
|
identifier?: string;
|
|
948
917
|
/**
|
|
949
|
-
* <p>The resource provisioning engine
|
|
950
|
-
*
|
|
951
|
-
*
|
|
952
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
953
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
954
|
-
* Previews.</p>
|
|
955
|
-
* </important>
|
|
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>
|
|
956
921
|
*/
|
|
957
922
|
provisioningEngine?: ProvisionedResourceEngine | string;
|
|
958
923
|
}
|
|
@@ -964,8 +929,8 @@ export declare namespace ProvisionedResource {
|
|
|
964
929
|
}
|
|
965
930
|
export interface ListEnvironmentProvisionedResourcesOutput {
|
|
966
931
|
/**
|
|
967
|
-
* <p>A token
|
|
968
|
-
*
|
|
932
|
+
* <p>A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested
|
|
933
|
+
* list of environment provisioned resources.</p>
|
|
969
934
|
*/
|
|
970
935
|
nextToken?: string;
|
|
971
936
|
/**
|
|
@@ -1001,37 +966,33 @@ export interface CreateEnvironmentInput {
|
|
|
1001
966
|
*/
|
|
1002
967
|
description?: string;
|
|
1003
968
|
/**
|
|
1004
|
-
* <p>A
|
|
1005
|
-
*
|
|
1006
|
-
* Guide</i>.</p>
|
|
969
|
+
* <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/adminguide/ag-environments.html">Environments</a> in the <i>Proton Administrator
|
|
970
|
+
* Guide</i>.</p>
|
|
1007
971
|
*/
|
|
1008
972
|
spec: string | undefined;
|
|
1009
973
|
/**
|
|
1010
|
-
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
974
|
+
* <p>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</p>
|
|
975
|
+
* <p>To use Amazon Web Services-managed provisioning for the environment, specify either the <code>environmentAccountConnectionId</code> or
|
|
976
|
+
* <code>protonServiceRoleArn</code> parameter and omit the <code>provisioningRepository</code> parameter.</p>
|
|
1013
977
|
*/
|
|
1014
978
|
protonServiceRoleArn?: string;
|
|
1015
979
|
/**
|
|
1016
|
-
* <p>The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
980
|
+
* <p>The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment
|
|
981
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
982
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
983
|
+
* <p>To use Amazon Web Services-managed provisioning for the environment, specify either the <code>environmentAccountConnectionId</code> or
|
|
984
|
+
* <code>protonServiceRoleArn</code> parameter and omit the <code>provisioningRepository</code> parameter.</p>
|
|
1020
985
|
*/
|
|
1021
986
|
environmentAccountConnectionId?: string;
|
|
1022
987
|
/**
|
|
1023
|
-
* <p>
|
|
988
|
+
* <p>An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.</p>
|
|
989
|
+
* <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>
|
|
1024
990
|
*/
|
|
1025
991
|
tags?: Tag[];
|
|
1026
992
|
/**
|
|
1027
|
-
* <p>The repository that you
|
|
1028
|
-
*
|
|
1029
|
-
*
|
|
1030
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
1031
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
1032
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
1033
|
-
* Previews.</p>
|
|
1034
|
-
* </important>
|
|
993
|
+
* <p>The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.</p>
|
|
994
|
+
* <p>To use self-managed provisioning for the environment, specify this parameter and omit the <code>environmentAccountConnectionId</code> and
|
|
995
|
+
* <code>protonServiceRoleArn</code> parameters.</p>
|
|
1035
996
|
*/
|
|
1036
997
|
provisioningRepository?: RepositoryBranchInput;
|
|
1037
998
|
}
|
|
@@ -1122,8 +1083,8 @@ export declare namespace EnvironmentTemplateFilter {
|
|
|
1122
1083
|
}
|
|
1123
1084
|
export interface ListEnvironmentsInput {
|
|
1124
1085
|
/**
|
|
1125
|
-
* <p>A token
|
|
1126
|
-
*
|
|
1086
|
+
* <p>A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously
|
|
1087
|
+
* requested.</p>
|
|
1127
1088
|
*/
|
|
1128
1089
|
nextToken?: string;
|
|
1129
1090
|
/**
|
|
@@ -1214,8 +1175,7 @@ export declare namespace EnvironmentSummary {
|
|
|
1214
1175
|
}
|
|
1215
1176
|
export interface ListEnvironmentsOutput {
|
|
1216
1177
|
/**
|
|
1217
|
-
* <p>A token
|
|
1218
|
-
* environments.</p>
|
|
1178
|
+
* <p>A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.</p>
|
|
1219
1179
|
*/
|
|
1220
1180
|
nextToken?: string;
|
|
1221
1181
|
/**
|
|
@@ -1261,7 +1221,7 @@ export interface UpdateEnvironmentInput {
|
|
|
1261
1221
|
*/
|
|
1262
1222
|
protonServiceRoleArn?: string;
|
|
1263
1223
|
/**
|
|
1264
|
-
* <p>There are four modes for updating an environment
|
|
1224
|
+
* <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
|
|
1265
1225
|
* <dl>
|
|
1266
1226
|
* <dt/>
|
|
1267
1227
|
* <dd>
|
|
@@ -1276,42 +1236,35 @@ export interface UpdateEnvironmentInput {
|
|
|
1276
1236
|
* <code>CURRENT_VERSION</code>
|
|
1277
1237
|
* </p>
|
|
1278
1238
|
* <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
1279
|
-
*
|
|
1239
|
+
* <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
|
|
1280
1240
|
* </dd>
|
|
1281
1241
|
* <dt/>
|
|
1282
1242
|
* <dd>
|
|
1283
1243
|
* <p>
|
|
1284
1244
|
* <code>MINOR_VERSION</code>
|
|
1285
1245
|
* </p>
|
|
1286
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
1287
|
-
*
|
|
1246
|
+
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in
|
|
1247
|
+
* use, by default. You can also specify a different minor version of the current major version in use.</p>
|
|
1288
1248
|
* </dd>
|
|
1289
1249
|
* <dt/>
|
|
1290
1250
|
* <dd>
|
|
1291
1251
|
* <p>
|
|
1292
1252
|
* <code>MAJOR_VERSION</code>
|
|
1293
1253
|
* </p>
|
|
1294
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
1295
|
-
*
|
|
1296
|
-
* (optional).</p>
|
|
1254
|
+
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template,
|
|
1255
|
+
* by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</p>
|
|
1297
1256
|
* </dd>
|
|
1298
1257
|
* </dl>
|
|
1299
1258
|
*/
|
|
1300
1259
|
deploymentType: DeploymentUpdateType | string | undefined;
|
|
1301
1260
|
/**
|
|
1302
1261
|
* <p>The ID of the environment account connection.</p>
|
|
1303
|
-
* <p>You can only update to a new environment account connection if it was created in the same environment account that the current environment
|
|
1304
|
-
*
|
|
1262
|
+
* <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
|
|
1263
|
+
* connection was created in and is associated with the current environment.</p>
|
|
1305
1264
|
*/
|
|
1306
1265
|
environmentAccountConnectionId?: string;
|
|
1307
1266
|
/**
|
|
1308
|
-
* <p>The repository that you
|
|
1309
|
-
* <important>
|
|
1310
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
1311
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
1312
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
1313
|
-
* Previews.</p>
|
|
1314
|
-
* </important>
|
|
1267
|
+
* <p>The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.</p>
|
|
1315
1268
|
*/
|
|
1316
1269
|
provisioningRepository?: RepositoryBranchInput;
|
|
1317
1270
|
}
|
|
@@ -1355,7 +1308,8 @@ export interface CreateEnvironmentTemplateInput {
|
|
|
1355
1308
|
*/
|
|
1356
1309
|
provisioning?: Provisioning | string;
|
|
1357
1310
|
/**
|
|
1358
|
-
* <p>
|
|
1311
|
+
* <p>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</p>
|
|
1312
|
+
* <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>
|
|
1359
1313
|
*/
|
|
1360
1314
|
tags?: Tag[];
|
|
1361
1315
|
}
|
|
@@ -1474,8 +1428,8 @@ export declare namespace GetEnvironmentTemplateOutput {
|
|
|
1474
1428
|
}
|
|
1475
1429
|
export interface ListEnvironmentTemplatesInput {
|
|
1476
1430
|
/**
|
|
1477
|
-
* <p>A token
|
|
1478
|
-
*
|
|
1431
|
+
* <p>A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates
|
|
1432
|
+
* that was previously requested.</p>
|
|
1479
1433
|
*/
|
|
1480
1434
|
nextToken?: string;
|
|
1481
1435
|
/**
|
|
@@ -1534,8 +1488,8 @@ export declare namespace EnvironmentTemplateSummary {
|
|
|
1534
1488
|
}
|
|
1535
1489
|
export interface ListEnvironmentTemplatesOutput {
|
|
1536
1490
|
/**
|
|
1537
|
-
* <p>A token
|
|
1538
|
-
*
|
|
1491
|
+
* <p>A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of
|
|
1492
|
+
* environment templates.</p>
|
|
1539
1493
|
*/
|
|
1540
1494
|
nextToken?: string;
|
|
1541
1495
|
/**
|
|
@@ -1628,8 +1582,8 @@ export declare namespace TemplateVersionSourceInput {
|
|
|
1628
1582
|
}
|
|
1629
1583
|
export interface CreateEnvironmentTemplateVersionInput {
|
|
1630
1584
|
/**
|
|
1631
|
-
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment template version that the
|
|
1632
|
-
*
|
|
1585
|
+
* <p>When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first
|
|
1586
|
+
* request created.</p>
|
|
1633
1587
|
*/
|
|
1634
1588
|
clientToken?: string;
|
|
1635
1589
|
/**
|
|
@@ -1641,9 +1595,8 @@ export interface CreateEnvironmentTemplateVersionInput {
|
|
|
1641
1595
|
*/
|
|
1642
1596
|
description?: string;
|
|
1643
1597
|
/**
|
|
1644
|
-
* <p>To create a new minor version of the environment template, include
|
|
1645
|
-
* <p>To create a new major and minor version of the environment template, <
|
|
1646
|
-
* <code>major Version</code>.</p>
|
|
1598
|
+
* <p>To create a new minor version of the environment template, include <code>major Version</code>.</p>
|
|
1599
|
+
* <p>To create a new major and minor version of the environment template, exclude <code>major Version</code>.</p>
|
|
1647
1600
|
*/
|
|
1648
1601
|
majorVersion?: string;
|
|
1649
1602
|
/**
|
|
@@ -1651,7 +1604,8 @@ export interface CreateEnvironmentTemplateVersionInput {
|
|
|
1651
1604
|
*/
|
|
1652
1605
|
source: TemplateVersionSourceInput | undefined;
|
|
1653
1606
|
/**
|
|
1654
|
-
* <p>
|
|
1607
|
+
* <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>
|
|
1608
|
+
* <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>
|
|
1655
1609
|
*/
|
|
1656
1610
|
tags?: Tag[];
|
|
1657
1611
|
}
|
|
@@ -1800,8 +1754,8 @@ export declare namespace GetEnvironmentTemplateVersionOutput {
|
|
|
1800
1754
|
}
|
|
1801
1755
|
export interface ListEnvironmentTemplateVersionsInput {
|
|
1802
1756
|
/**
|
|
1803
|
-
* <p>A token
|
|
1804
|
-
*
|
|
1757
|
+
* <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
|
|
1758
|
+
* list of major or minor versions that was previously requested.</p>
|
|
1805
1759
|
*/
|
|
1806
1760
|
nextToken?: string;
|
|
1807
1761
|
/**
|
|
@@ -1830,7 +1784,7 @@ export declare namespace ListEnvironmentTemplateVersionsInput {
|
|
|
1830
1784
|
*/
|
|
1831
1785
|
export interface EnvironmentTemplateVersionSummary {
|
|
1832
1786
|
/**
|
|
1833
|
-
* <p>The name of the
|
|
1787
|
+
* <p>The name of the environment template.</p>
|
|
1834
1788
|
*/
|
|
1835
1789
|
templateName: string | undefined;
|
|
1836
1790
|
/**
|
|
@@ -1878,8 +1832,8 @@ export declare namespace EnvironmentTemplateVersionSummary {
|
|
|
1878
1832
|
}
|
|
1879
1833
|
export interface ListEnvironmentTemplateVersionsOutput {
|
|
1880
1834
|
/**
|
|
1881
|
-
* <p>A token
|
|
1882
|
-
*
|
|
1835
|
+
* <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
|
|
1836
|
+
* list of major or minor versions that was previously requested.</p>
|
|
1883
1837
|
*/
|
|
1884
1838
|
nextToken?: string;
|
|
1885
1839
|
/**
|
|
@@ -2063,7 +2017,7 @@ export interface GetTemplateSyncStatusInput {
|
|
|
2063
2017
|
*/
|
|
2064
2018
|
templateType: TemplateType | string | undefined;
|
|
2065
2019
|
/**
|
|
2066
|
-
* <p>The template version.</p>
|
|
2020
|
+
* <p>The template major version.</p>
|
|
2067
2021
|
*/
|
|
2068
2022
|
templateVersion: string | undefined;
|
|
2069
2023
|
}
|
|
@@ -2222,8 +2176,8 @@ export interface ListRepositorySyncDefinitionsInput {
|
|
|
2222
2176
|
*/
|
|
2223
2177
|
syncType: SyncType | string | undefined;
|
|
2224
2178
|
/**
|
|
2225
|
-
* <p>A token
|
|
2226
|
-
*
|
|
2179
|
+
* <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
|
|
2180
|
+
* sync definitions previously requested.</p>
|
|
2227
2181
|
*/
|
|
2228
2182
|
nextToken?: string;
|
|
2229
2183
|
}
|
|
@@ -2262,8 +2216,8 @@ export declare namespace RepositorySyncDefinition {
|
|
|
2262
2216
|
}
|
|
2263
2217
|
export interface ListRepositorySyncDefinitionsOutput {
|
|
2264
2218
|
/**
|
|
2265
|
-
* <p>A token
|
|
2266
|
-
*
|
|
2219
|
+
* <p>A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested
|
|
2220
|
+
* list of repository sync definitions.</p>
|
|
2267
2221
|
*/
|
|
2268
2222
|
nextToken?: string;
|
|
2269
2223
|
/**
|
|
@@ -2283,8 +2237,8 @@ export interface ListTagsForResourceInput {
|
|
|
2283
2237
|
*/
|
|
2284
2238
|
resourceArn: string | undefined;
|
|
2285
2239
|
/**
|
|
2286
|
-
* <p>A token
|
|
2287
|
-
*
|
|
2240
|
+
* <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 previously
|
|
2241
|
+
* requested.</p>
|
|
2288
2242
|
*/
|
|
2289
2243
|
nextToken?: string;
|
|
2290
2244
|
/**
|
|
@@ -2300,12 +2254,11 @@ export declare namespace ListTagsForResourceInput {
|
|
|
2300
2254
|
}
|
|
2301
2255
|
export interface ListTagsForResourceOutput {
|
|
2302
2256
|
/**
|
|
2303
|
-
* <p>
|
|
2257
|
+
* <p>A list of resource tags with detail data.</p>
|
|
2304
2258
|
*/
|
|
2305
2259
|
tags: Tag[] | undefined;
|
|
2306
2260
|
/**
|
|
2307
|
-
* <p>A token
|
|
2308
|
-
* tags.</p>
|
|
2261
|
+
* <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 tags.</p>
|
|
2309
2262
|
*/
|
|
2310
2263
|
nextToken?: string;
|
|
2311
2264
|
}
|
|
@@ -2362,17 +2315,23 @@ export interface CreateRepositoryInput {
|
|
|
2362
2315
|
*/
|
|
2363
2316
|
provider: RepositoryProvider | string | undefined;
|
|
2364
2317
|
/**
|
|
2365
|
-
* <p>The repository name
|
|
2318
|
+
* <p>The repository name (for example, <code>myrepos/myrepo</code>).</p>
|
|
2366
2319
|
*/
|
|
2367
2320
|
name: string | undefined;
|
|
2368
2321
|
/**
|
|
2369
|
-
* <p>The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see <a href="https://docs.aws.amazon.com/setting-up-for-service">Setting up for Proton</a> in the <i>Proton Administrator
|
|
2322
|
+
* <p>The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html">Setting up for Proton</a> in the <i>Proton Administrator
|
|
2323
|
+
* Guide</i>.</p>
|
|
2370
2324
|
*/
|
|
2371
2325
|
connectionArn: string | undefined;
|
|
2372
2326
|
/**
|
|
2373
2327
|
* <p>The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.</p>
|
|
2374
2328
|
*/
|
|
2375
2329
|
encryptionKey?: string;
|
|
2330
|
+
/**
|
|
2331
|
+
* <p>An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.</p>
|
|
2332
|
+
* <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>
|
|
2333
|
+
*/
|
|
2334
|
+
tags?: Tag[];
|
|
2376
2335
|
}
|
|
2377
2336
|
export declare namespace CreateRepositoryInput {
|
|
2378
2337
|
/**
|
|
@@ -2481,8 +2440,7 @@ export declare namespace GetRepositoryOutput {
|
|
|
2481
2440
|
}
|
|
2482
2441
|
export interface ListRepositoriesInput {
|
|
2483
2442
|
/**
|
|
2484
|
-
* <p>A token
|
|
2485
|
-
* requested.</p>
|
|
2443
|
+
* <p>A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.</p>
|
|
2486
2444
|
*/
|
|
2487
2445
|
nextToken?: string;
|
|
2488
2446
|
/**
|
|
@@ -2521,8 +2479,7 @@ export declare namespace RepositorySummary {
|
|
|
2521
2479
|
}
|
|
2522
2480
|
export interface ListRepositoriesOutput {
|
|
2523
2481
|
/**
|
|
2524
|
-
* <p>A token
|
|
2525
|
-
* </p>
|
|
2482
|
+
* <p>A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories. </p>
|
|
2526
2483
|
*/
|
|
2527
2484
|
nextToken?: string;
|
|
2528
2485
|
/**
|
|
@@ -2546,7 +2503,7 @@ export interface ListServiceInstanceOutputsInput {
|
|
|
2546
2503
|
*/
|
|
2547
2504
|
serviceName: string | undefined;
|
|
2548
2505
|
/**
|
|
2549
|
-
* <p>A token
|
|
2506
|
+
* <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>
|
|
2550
2507
|
*/
|
|
2551
2508
|
nextToken?: string;
|
|
2552
2509
|
}
|
|
@@ -2558,7 +2515,7 @@ export declare namespace ListServiceInstanceOutputsInput {
|
|
|
2558
2515
|
}
|
|
2559
2516
|
export interface ListServiceInstanceOutputsOutput {
|
|
2560
2517
|
/**
|
|
2561
|
-
* <p>A token
|
|
2518
|
+
* <p>A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.</p>
|
|
2562
2519
|
*/
|
|
2563
2520
|
nextToken?: string;
|
|
2564
2521
|
/**
|
|
@@ -2582,8 +2539,8 @@ export interface ListServiceInstanceProvisionedResourcesInput {
|
|
|
2582
2539
|
*/
|
|
2583
2540
|
serviceInstanceName: string | undefined;
|
|
2584
2541
|
/**
|
|
2585
|
-
* <p>A token
|
|
2586
|
-
*
|
|
2542
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources
|
|
2543
|
+
* that was previously requested.</p>
|
|
2587
2544
|
*/
|
|
2588
2545
|
nextToken?: string;
|
|
2589
2546
|
}
|
|
@@ -2595,8 +2552,8 @@ export declare namespace ListServiceInstanceProvisionedResourcesInput {
|
|
|
2595
2552
|
}
|
|
2596
2553
|
export interface ListServiceInstanceProvisionedResourcesOutput {
|
|
2597
2554
|
/**
|
|
2598
|
-
* <p>A token
|
|
2599
|
-
*
|
|
2555
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of
|
|
2556
|
+
* provisioned resources.</p>
|
|
2600
2557
|
*/
|
|
2601
2558
|
nextToken?: string;
|
|
2602
2559
|
/**
|
|
@@ -2644,8 +2601,8 @@ export interface ListServiceInstancesInput {
|
|
|
2644
2601
|
*/
|
|
2645
2602
|
serviceName?: string;
|
|
2646
2603
|
/**
|
|
2647
|
-
* <p>A token
|
|
2648
|
-
*
|
|
2604
|
+
* <p>A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously
|
|
2605
|
+
* requested.</p>
|
|
2649
2606
|
*/
|
|
2650
2607
|
nextToken?: string;
|
|
2651
2608
|
/**
|
|
@@ -2720,8 +2677,8 @@ export declare namespace ServiceInstanceSummary {
|
|
|
2720
2677
|
}
|
|
2721
2678
|
export interface ListServiceInstancesOutput {
|
|
2722
2679
|
/**
|
|
2723
|
-
* <p>A token
|
|
2724
|
-
*
|
|
2680
|
+
* <p>A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service
|
|
2681
|
+
* instances.</p>
|
|
2725
2682
|
*/
|
|
2726
2683
|
nextToken?: string;
|
|
2727
2684
|
/**
|
|
@@ -2746,8 +2703,7 @@ export interface UpdateServiceInstanceInput {
|
|
|
2746
2703
|
serviceName: string | undefined;
|
|
2747
2704
|
/**
|
|
2748
2705
|
* <p>The deployment type.</p>
|
|
2749
|
-
* <p>There are four modes for updating a service instance
|
|
2750
|
-
* mode.</p>
|
|
2706
|
+
* <p>There are four modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p>
|
|
2751
2707
|
* <dl>
|
|
2752
2708
|
* <dt/>
|
|
2753
2709
|
* <dd>
|
|
@@ -2762,15 +2718,15 @@ export interface UpdateServiceInstanceInput {
|
|
|
2762
2718
|
* <code>CURRENT_VERSION</code>
|
|
2763
2719
|
* </p>
|
|
2764
2720
|
* <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
2765
|
-
*
|
|
2721
|
+
* <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
|
|
2766
2722
|
* </dd>
|
|
2767
2723
|
* <dt/>
|
|
2768
2724
|
* <dd>
|
|
2769
2725
|
* <p>
|
|
2770
2726
|
* <code>MINOR_VERSION</code>
|
|
2771
2727
|
* </p>
|
|
2772
|
-
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major
|
|
2773
|
-
*
|
|
2728
|
+
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
2729
|
+
* in use, by default. You can also specify a different minor version of the current major version in use.</p>
|
|
2774
2730
|
* </dd>
|
|
2775
2731
|
* <dt/>
|
|
2776
2732
|
* <dd>
|
|
@@ -2778,8 +2734,7 @@ export interface UpdateServiceInstanceInput {
|
|
|
2778
2734
|
* <code>MAJOR_VERSION</code>
|
|
2779
2735
|
* </p>
|
|
2780
2736
|
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
2781
|
-
*
|
|
2782
|
-
* (optional).</p>
|
|
2737
|
+
* template, by default. You can specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
2783
2738
|
* </dd>
|
|
2784
2739
|
* </dl>
|
|
2785
2740
|
*/
|
|
@@ -2805,7 +2760,7 @@ export declare namespace UpdateServiceInstanceInput {
|
|
|
2805
2760
|
}
|
|
2806
2761
|
export interface UpdateServiceInstanceOutput {
|
|
2807
2762
|
/**
|
|
2808
|
-
* <p>The service instance summary data returned by Proton.</p>
|
|
2763
|
+
* <p>The service instance summary data that's returned by Proton.</p>
|
|
2809
2764
|
*/
|
|
2810
2765
|
serviceInstance: ServiceInstance | undefined;
|
|
2811
2766
|
}
|
|
@@ -2821,7 +2776,7 @@ export interface ListServicePipelineOutputsInput {
|
|
|
2821
2776
|
*/
|
|
2822
2777
|
serviceName: string | undefined;
|
|
2823
2778
|
/**
|
|
2824
|
-
* <p>A token
|
|
2779
|
+
* <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>
|
|
2825
2780
|
*/
|
|
2826
2781
|
nextToken?: string;
|
|
2827
2782
|
}
|
|
@@ -2833,7 +2788,7 @@ export declare namespace ListServicePipelineOutputsInput {
|
|
|
2833
2788
|
}
|
|
2834
2789
|
export interface ListServicePipelineOutputsOutput {
|
|
2835
2790
|
/**
|
|
2836
|
-
* <p>A token
|
|
2791
|
+
* <p>A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.</p>
|
|
2837
2792
|
*/
|
|
2838
2793
|
nextToken?: string;
|
|
2839
2794
|
/**
|
|
@@ -2853,8 +2808,8 @@ export interface ListServicePipelineProvisionedResourcesInput {
|
|
|
2853
2808
|
*/
|
|
2854
2809
|
serviceName: string | undefined;
|
|
2855
2810
|
/**
|
|
2856
|
-
* <p>A token
|
|
2857
|
-
*
|
|
2811
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources
|
|
2812
|
+
* that was previously requested.</p>
|
|
2858
2813
|
*/
|
|
2859
2814
|
nextToken?: string;
|
|
2860
2815
|
}
|
|
@@ -2866,8 +2821,8 @@ export declare namespace ListServicePipelineProvisionedResourcesInput {
|
|
|
2866
2821
|
}
|
|
2867
2822
|
export interface ListServicePipelineProvisionedResourcesOutput {
|
|
2868
2823
|
/**
|
|
2869
|
-
* <p>A token
|
|
2870
|
-
*
|
|
2824
|
+
* <p>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of
|
|
2825
|
+
* provisioned resources.</p>
|
|
2871
2826
|
*/
|
|
2872
2827
|
nextToken?: string;
|
|
2873
2828
|
/**
|
|
@@ -2892,8 +2847,7 @@ export interface UpdateServicePipelineInput {
|
|
|
2892
2847
|
spec: string | undefined;
|
|
2893
2848
|
/**
|
|
2894
2849
|
* <p>The deployment type.</p>
|
|
2895
|
-
* <p>There are four modes for updating a service pipeline
|
|
2896
|
-
* mode.</p>
|
|
2850
|
+
* <p>There are four modes for updating a service pipeline. The <code>deploymentType</code> field defines the mode.</p>
|
|
2897
2851
|
* <dl>
|
|
2898
2852
|
* <dt/>
|
|
2899
2853
|
* <dd>
|
|
@@ -2908,15 +2862,15 @@ export interface UpdateServicePipelineInput {
|
|
|
2908
2862
|
* <code>CURRENT_VERSION</code>
|
|
2909
2863
|
* </p>
|
|
2910
2864
|
* <p>In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
2911
|
-
*
|
|
2865
|
+
* <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
|
|
2912
2866
|
* </dd>
|
|
2913
2867
|
* <dt/>
|
|
2914
2868
|
* <dd>
|
|
2915
2869
|
* <p>
|
|
2916
2870
|
* <code>MINOR_VERSION</code>
|
|
2917
2871
|
* </p>
|
|
2918
|
-
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major
|
|
2919
|
-
*
|
|
2872
|
+
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
2873
|
+
* in use, by default. You can specify a different minor version of the current major version in use.</p>
|
|
2920
2874
|
* </dd>
|
|
2921
2875
|
* <dt/>
|
|
2922
2876
|
* <dd>
|
|
@@ -2924,8 +2878,7 @@ export interface UpdateServicePipelineInput {
|
|
|
2924
2878
|
* <code>MAJOR_VERSION</code>
|
|
2925
2879
|
* </p>
|
|
2926
2880
|
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
2927
|
-
*
|
|
2928
|
-
* (optional).</p>
|
|
2881
|
+
* template, by default. You can specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
2929
2882
|
* </dd>
|
|
2930
2883
|
* </dl>
|
|
2931
2884
|
*/
|
|
@@ -2947,7 +2900,7 @@ export declare namespace UpdateServicePipelineInput {
|
|
|
2947
2900
|
}
|
|
2948
2901
|
export interface UpdateServicePipelineOutput {
|
|
2949
2902
|
/**
|
|
2950
|
-
* <p>The pipeline details returned by Proton.</p>
|
|
2903
|
+
* <p>The pipeline details that are returned by Proton.</p>
|
|
2951
2904
|
*/
|
|
2952
2905
|
pipeline: ServicePipeline | undefined;
|
|
2953
2906
|
}
|
|
@@ -2979,32 +2932,33 @@ export interface CreateServiceInput {
|
|
|
2979
2932
|
*/
|
|
2980
2933
|
templateMinorVersion?: string;
|
|
2981
2934
|
/**
|
|
2982
|
-
* <p>A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format.
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
2985
|
-
*
|
|
2986
|
-
*
|
|
2935
|
+
* <p>A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format.
|
|
2936
|
+
* <i>Don’t</i> include pipeline inputs in the spec if your service template <i>doesn’t</i> include a service pipeline. For
|
|
2937
|
+
* more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html.html">Create a service</a> in the
|
|
2938
|
+
* <i>Proton Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html">Create a
|
|
2939
|
+
* service</a> in the <i>Proton User Guide</i>.</p>
|
|
2987
2940
|
*/
|
|
2988
2941
|
spec: string | undefined;
|
|
2989
2942
|
/**
|
|
2990
2943
|
* <p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol">Set up repository connection</a> in the <i>Proton
|
|
2991
|
-
*
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2944
|
+
* Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection">Setting up with
|
|
2945
|
+
* Proton</a> in the <i>Proton User Guide</i>. <i>Don't</i> include this parameter if your service template
|
|
2946
|
+
* <i>doesn't</i> include a service pipeline.</p>
|
|
2994
2947
|
*/
|
|
2995
2948
|
repositoryConnectionArn?: string;
|
|
2996
2949
|
/**
|
|
2997
|
-
* <p>The ID of the code repository. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include
|
|
2998
|
-
*
|
|
2950
|
+
* <p>The ID of the code repository. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a
|
|
2951
|
+
* service pipeline.</p>
|
|
2999
2952
|
*/
|
|
3000
2953
|
repositoryId?: string;
|
|
3001
2954
|
/**
|
|
3002
|
-
* <p>The name of the code repository branch that holds the code that's deployed in Proton. <i>Don't</i> include this parameter if
|
|
3003
|
-
*
|
|
2955
|
+
* <p>The name of the code repository branch that holds the code that's deployed in Proton. <i>Don't</i> include this parameter if your
|
|
2956
|
+
* service template <i>doesn't</i> include a service pipeline.</p>
|
|
3004
2957
|
*/
|
|
3005
2958
|
branchName?: string;
|
|
3006
2959
|
/**
|
|
3007
|
-
* <p>
|
|
2960
|
+
* <p>An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.</p>
|
|
2961
|
+
* <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>
|
|
3008
2962
|
*/
|
|
3009
2963
|
tags?: Tag[];
|
|
3010
2964
|
}
|
|
@@ -3076,8 +3030,8 @@ export interface Service {
|
|
|
3076
3030
|
pipeline?: ServicePipeline;
|
|
3077
3031
|
/**
|
|
3078
3032
|
* <p>The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol">Set up a repository connection</a> in the <i>Proton
|
|
3079
|
-
*
|
|
3080
|
-
*
|
|
3033
|
+
* Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection">Setting up with
|
|
3034
|
+
* Proton</a> in the <i>Proton User Guide</i>.</p>
|
|
3081
3035
|
*/
|
|
3082
3036
|
repositoryConnectionArn?: string;
|
|
3083
3037
|
/**
|
|
@@ -3157,8 +3111,7 @@ export declare namespace GetServiceOutput {
|
|
|
3157
3111
|
}
|
|
3158
3112
|
export interface ListServicesInput {
|
|
3159
3113
|
/**
|
|
3160
|
-
* <p>A token
|
|
3161
|
-
* requested.</p>
|
|
3114
|
+
* <p>A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.</p>
|
|
3162
3115
|
*/
|
|
3163
3116
|
nextToken?: string;
|
|
3164
3117
|
/**
|
|
@@ -3217,7 +3170,7 @@ export declare namespace ServiceSummary {
|
|
|
3217
3170
|
}
|
|
3218
3171
|
export interface ListServicesOutput {
|
|
3219
3172
|
/**
|
|
3220
|
-
* <p>A token
|
|
3173
|
+
* <p>A token that indicates the location of the next service in the array of services, after the current requested list of services.</p>
|
|
3221
3174
|
*/
|
|
3222
3175
|
nextToken?: string;
|
|
3223
3176
|
/**
|
|
@@ -3242,9 +3195,8 @@ export interface UpdateServiceInput {
|
|
|
3242
3195
|
description?: string;
|
|
3243
3196
|
/**
|
|
3244
3197
|
* <p>Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list.
|
|
3245
|
-
*
|
|
3246
|
-
*
|
|
3247
|
-
* the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html">Proton User Guide</a>.</p>
|
|
3198
|
+
* <i>Don't</i> include edits to the existing service instances or pipeline. For more information, see <i>Edit a service</i> in
|
|
3199
|
+
* the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html">Proton Administrator Guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html">Proton User Guide</a>.</p>
|
|
3248
3200
|
*/
|
|
3249
3201
|
spec?: string;
|
|
3250
3202
|
}
|
|
@@ -3284,14 +3236,14 @@ export interface CreateServiceTemplateInput {
|
|
|
3284
3236
|
*/
|
|
3285
3237
|
encryptionKey?: string;
|
|
3286
3238
|
/**
|
|
3287
|
-
* <p>Proton
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3290
|
-
* <i>Proton Administrator Guide</i>.</p>
|
|
3239
|
+
* <p>By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline
|
|
3240
|
+
* <i>isn't</i> provided for your service. After it's included, it <i>can't</i> be changed. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html">Service template bundles</a> in the <i>Proton Administrator
|
|
3241
|
+
* Guide</i>.</p>
|
|
3291
3242
|
*/
|
|
3292
3243
|
pipelineProvisioning?: Provisioning | string;
|
|
3293
3244
|
/**
|
|
3294
|
-
* <p>
|
|
3245
|
+
* <p>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</p>
|
|
3246
|
+
* <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>
|
|
3295
3247
|
*/
|
|
3296
3248
|
tags?: Tag[];
|
|
3297
3249
|
}
|
|
@@ -3338,8 +3290,8 @@ export interface ServiceTemplate {
|
|
|
3338
3290
|
*/
|
|
3339
3291
|
encryptionKey?: string;
|
|
3340
3292
|
/**
|
|
3341
|
-
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template. Otherwise, a service
|
|
3342
|
-
*
|
|
3293
|
+
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template. Otherwise, a service pipeline
|
|
3294
|
+
* <i>isn't</i> included in the service template.</p>
|
|
3343
3295
|
*/
|
|
3344
3296
|
pipelineProvisioning?: Provisioning | string;
|
|
3345
3297
|
}
|
|
@@ -3411,8 +3363,8 @@ export declare namespace GetServiceTemplateOutput {
|
|
|
3411
3363
|
}
|
|
3412
3364
|
export interface ListServiceTemplatesInput {
|
|
3413
3365
|
/**
|
|
3414
|
-
* <p>A token
|
|
3415
|
-
*
|
|
3366
|
+
* <p>A token that indicates the location of the next service template in the array of service templates, after the list of service templates previously
|
|
3367
|
+
* requested.</p>
|
|
3416
3368
|
*/
|
|
3417
3369
|
nextToken?: string;
|
|
3418
3370
|
/**
|
|
@@ -3459,8 +3411,8 @@ export interface ServiceTemplateSummary {
|
|
|
3459
3411
|
*/
|
|
3460
3412
|
recommendedVersion?: string;
|
|
3461
3413
|
/**
|
|
3462
|
-
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template, otherwise a service
|
|
3463
|
-
*
|
|
3414
|
+
* <p>If <code>pipelineProvisioning</code> is <code>true</code>, a service pipeline is included in the service template, otherwise a service pipeline
|
|
3415
|
+
* <i>isn't</i> included in the service template.</p>
|
|
3464
3416
|
*/
|
|
3465
3417
|
pipelineProvisioning?: Provisioning | string;
|
|
3466
3418
|
}
|
|
@@ -3472,8 +3424,8 @@ export declare namespace ServiceTemplateSummary {
|
|
|
3472
3424
|
}
|
|
3473
3425
|
export interface ListServiceTemplatesOutput {
|
|
3474
3426
|
/**
|
|
3475
|
-
* <p>A token
|
|
3476
|
-
*
|
|
3427
|
+
* <p>A token that indicates the location of the next service template in the array of service templates, after the current requested list of service
|
|
3428
|
+
* templates.</p>
|
|
3477
3429
|
*/
|
|
3478
3430
|
nextToken?: string;
|
|
3479
3431
|
/**
|
|
@@ -3493,7 +3445,7 @@ export interface UpdateServiceTemplateInput {
|
|
|
3493
3445
|
*/
|
|
3494
3446
|
name: string | undefined;
|
|
3495
3447
|
/**
|
|
3496
|
-
* <p>The name of the service template to update
|
|
3448
|
+
* <p>The name of the service template to update that's displayed in the developer interface.</p>
|
|
3497
3449
|
*/
|
|
3498
3450
|
displayName?: string;
|
|
3499
3451
|
/**
|
|
@@ -3540,8 +3492,8 @@ export declare namespace CompatibleEnvironmentTemplateInput {
|
|
|
3540
3492
|
}
|
|
3541
3493
|
export interface CreateServiceTemplateVersionInput {
|
|
3542
3494
|
/**
|
|
3543
|
-
* <p>When included, if two identical requests are made with the same client token, Proton returns the service template version that the first
|
|
3544
|
-
*
|
|
3495
|
+
* <p>When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request
|
|
3496
|
+
* created.</p>
|
|
3545
3497
|
*/
|
|
3546
3498
|
clientToken?: string;
|
|
3547
3499
|
/**
|
|
@@ -3567,7 +3519,8 @@ export interface CreateServiceTemplateVersionInput {
|
|
|
3567
3519
|
*/
|
|
3568
3520
|
compatibleEnvironmentTemplates: CompatibleEnvironmentTemplateInput[] | undefined;
|
|
3569
3521
|
/**
|
|
3570
|
-
* <p>
|
|
3522
|
+
* <p>An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.</p>
|
|
3523
|
+
* <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>
|
|
3571
3524
|
*/
|
|
3572
3525
|
tags?: Tag[];
|
|
3573
3526
|
}
|
|
@@ -3733,8 +3686,8 @@ export declare namespace GetServiceTemplateVersionOutput {
|
|
|
3733
3686
|
}
|
|
3734
3687
|
export interface ListServiceTemplateVersionsInput {
|
|
3735
3688
|
/**
|
|
3736
|
-
* <p>A token
|
|
3737
|
-
*
|
|
3689
|
+
* <p>A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the list
|
|
3690
|
+
* of major or minor versions that was previously requested.</p>
|
|
3738
3691
|
*/
|
|
3739
3692
|
nextToken?: string;
|
|
3740
3693
|
/**
|
|
@@ -3811,8 +3764,8 @@ export declare namespace ServiceTemplateVersionSummary {
|
|
|
3811
3764
|
}
|
|
3812
3765
|
export interface ListServiceTemplateVersionsOutput {
|
|
3813
3766
|
/**
|
|
3814
|
-
* <p>A token
|
|
3815
|
-
*
|
|
3767
|
+
* <p>A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the
|
|
3768
|
+
* current requested list of service major or minor versions.</p>
|
|
3816
3769
|
*/
|
|
3817
3770
|
nextToken?: string;
|
|
3818
3771
|
/**
|
|
@@ -3872,11 +3825,11 @@ export declare namespace UpdateServiceTemplateVersionOutput {
|
|
|
3872
3825
|
}
|
|
3873
3826
|
export interface TagResourceInput {
|
|
3874
3827
|
/**
|
|
3875
|
-
* <p>The Amazon Resource Name (ARN) of the resource
|
|
3828
|
+
* <p>The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.</p>
|
|
3876
3829
|
*/
|
|
3877
3830
|
resourceArn: string | undefined;
|
|
3878
3831
|
/**
|
|
3879
|
-
* <p>
|
|
3832
|
+
* <p>A list of customer tags to apply to the Proton resource.</p>
|
|
3880
3833
|
*/
|
|
3881
3834
|
tags: Tag[] | undefined;
|
|
3882
3835
|
}
|
|
@@ -3908,7 +3861,7 @@ export interface CreateTemplateSyncConfigInput {
|
|
|
3908
3861
|
*/
|
|
3909
3862
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
3910
3863
|
/**
|
|
3911
|
-
* <p>The name of your repository
|
|
3864
|
+
* <p>The name of your repository (for example, <code>myrepos/myrepo</code>).</p>
|
|
3912
3865
|
*/
|
|
3913
3866
|
repositoryName: string | undefined;
|
|
3914
3867
|
/**
|
|
@@ -3916,8 +3869,8 @@ export interface CreateTemplateSyncConfigInput {
|
|
|
3916
3869
|
*/
|
|
3917
3870
|
branch: string | undefined;
|
|
3918
3871
|
/**
|
|
3919
|
-
* <p>A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this
|
|
3920
|
-
*
|
|
3872
|
+
* <p>A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository
|
|
3873
|
+
* directory.</p>
|
|
3921
3874
|
*/
|
|
3922
3875
|
subdirectory?: string;
|
|
3923
3876
|
}
|
|
@@ -4044,7 +3997,7 @@ export interface UpdateTemplateSyncConfigInput {
|
|
|
4044
3997
|
*/
|
|
4045
3998
|
repositoryProvider: RepositoryProvider | string | undefined;
|
|
4046
3999
|
/**
|
|
4047
|
-
* <p>The name of the repository
|
|
4000
|
+
* <p>The name of the repository (for example, <code>myrepos/myrepo</code>).</p>
|
|
4048
4001
|
*/
|
|
4049
4002
|
repositoryName: string | undefined;
|
|
4050
4003
|
/**
|
|
@@ -4076,11 +4029,11 @@ export declare namespace UpdateTemplateSyncConfigOutput {
|
|
|
4076
4029
|
}
|
|
4077
4030
|
export interface UntagResourceInput {
|
|
4078
4031
|
/**
|
|
4079
|
-
* <p>The Amazon Resource Name (ARN) of the resource
|
|
4032
|
+
* <p>The Amazon Resource Name (ARN) of the resource to remove customer tags from.</p>
|
|
4080
4033
|
*/
|
|
4081
4034
|
resourceArn: string | undefined;
|
|
4082
4035
|
/**
|
|
4083
|
-
* <p>
|
|
4036
|
+
* <p>A list of customer tag keys that indicate the customer tags to be removed from the resource.</p>
|
|
4084
4037
|
*/
|
|
4085
4038
|
tagKeys: string[] | undefined;
|
|
4086
4039
|
}
|