aws-sdk-amplify 1.35.0 → 1.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +88 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-amplify/client.rb +235 -48
- data/lib/aws-sdk-amplify/client_api.rb +35 -1
- data/lib/aws-sdk-amplify/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-amplify/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-amplify/endpoints.rb +534 -0
- data/lib/aws-sdk-amplify/plugins/endpoints.rb +142 -0
- data/lib/aws-sdk-amplify/types.rb +212 -544
- data/lib/aws-sdk-amplify.rb +5 -1
- metadata +8 -4
@@ -34,11 +34,15 @@ module Aws::Amplify
|
|
34
34
|
# @return [String]
|
35
35
|
#
|
36
36
|
# @!attribute [rw] repository
|
37
|
-
# The repository for the Amplify app.
|
37
|
+
# The Git repository for the Amplify app.
|
38
38
|
# @return [String]
|
39
39
|
#
|
40
40
|
# @!attribute [rw] platform
|
41
|
-
# The platform for the Amplify app.
|
41
|
+
# The platform for the Amplify app. For a static app, set the platform
|
42
|
+
# type to `WEB`. For a dynamic server-side rendered (SSR) app, set the
|
43
|
+
# platform type to `WEB_COMPUTE`. For an app requiring Amplify
|
44
|
+
# Hosting's original SSR support only, set the platform type to
|
45
|
+
# `WEB_DYNAMIC`.
|
42
46
|
# @return [String]
|
43
47
|
#
|
44
48
|
# @!attribute [rw] create_time
|
@@ -56,6 +60,14 @@ module Aws::Amplify
|
|
56
60
|
#
|
57
61
|
# @!attribute [rw] environment_variables
|
58
62
|
# The environment variables for the Amplify app.
|
63
|
+
#
|
64
|
+
# For a list of the environment variables that are accessible to
|
65
|
+
# Amplify by default, see [Amplify Environment variables][1] in the
|
66
|
+
# *Amplify Hosting User Guide*.
|
67
|
+
#
|
68
|
+
#
|
69
|
+
#
|
70
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html
|
59
71
|
# @return [Hash<String,String>]
|
60
72
|
#
|
61
73
|
# @!attribute [rw] default_domain
|
@@ -67,7 +79,7 @@ module Aws::Amplify
|
|
67
79
|
# @return [Boolean]
|
68
80
|
#
|
69
81
|
# @!attribute [rw] enable_branch_auto_deletion
|
70
|
-
# Automatically disconnect a branch in the Amplify
|
82
|
+
# Automatically disconnect a branch in the Amplify console when you
|
71
83
|
# delete a branch from your Git repository.
|
72
84
|
# @return [Boolean]
|
73
85
|
#
|
@@ -77,7 +89,8 @@ module Aws::Amplify
|
|
77
89
|
#
|
78
90
|
# @!attribute [rw] basic_auth_credentials
|
79
91
|
# The basic authorization credentials for branches for the Amplify
|
80
|
-
# app.
|
92
|
+
# app. You must base64-encode the authorization credentials and
|
93
|
+
# provide them in the format `user:password`.
|
81
94
|
# @return [String]
|
82
95
|
#
|
83
96
|
# @!attribute [rw] custom_rules
|
@@ -112,6 +125,18 @@ module Aws::Amplify
|
|
112
125
|
# Amplify app.
|
113
126
|
# @return [Types::AutoBranchCreationConfig]
|
114
127
|
#
|
128
|
+
# @!attribute [rw] repository_clone_method
|
129
|
+
# <note markdown="1"> This is for internal use.
|
130
|
+
#
|
131
|
+
# </note>
|
132
|
+
#
|
133
|
+
# The Amplify service uses this parameter to specify the
|
134
|
+
# authentication protocol to use to access the Git repository for an
|
135
|
+
# Amplify app. Amplify specifies `TOKEN` for a GitHub repository,
|
136
|
+
# `SIGV4` for an Amazon Web Services CodeCommit repository, and `SSH`
|
137
|
+
# for GitLab and Bitbucket repositories.
|
138
|
+
# @return [String]
|
139
|
+
#
|
115
140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/App AWS API Documentation
|
116
141
|
#
|
117
142
|
class App < Struct.new(
|
@@ -137,8 +162,9 @@ module Aws::Amplify
|
|
137
162
|
:custom_headers,
|
138
163
|
:enable_auto_branch_creation,
|
139
164
|
:auto_branch_creation_patterns,
|
140
|
-
:auto_branch_creation_config
|
141
|
-
|
165
|
+
:auto_branch_creation_config,
|
166
|
+
:repository_clone_method)
|
167
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec]
|
142
168
|
include Aws::Structure
|
143
169
|
end
|
144
170
|
|
@@ -163,24 +189,6 @@ module Aws::Amplify
|
|
163
189
|
|
164
190
|
# Describes the automated branch creation configuration.
|
165
191
|
#
|
166
|
-
# @note When making an API call, you may pass AutoBranchCreationConfig
|
167
|
-
# data as a hash:
|
168
|
-
#
|
169
|
-
# {
|
170
|
-
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
|
171
|
-
# framework: "Framework",
|
172
|
-
# enable_auto_build: false,
|
173
|
-
# environment_variables: {
|
174
|
-
# "EnvKey" => "EnvValue",
|
175
|
-
# },
|
176
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
177
|
-
# enable_basic_auth: false,
|
178
|
-
# enable_performance_mode: false,
|
179
|
-
# build_spec: "BuildSpec",
|
180
|
-
# enable_pull_request_preview: false,
|
181
|
-
# pull_request_environment_name: "PullRequestEnvironmentName",
|
182
|
-
# }
|
183
|
-
#
|
184
192
|
# @!attribute [rw] stage
|
185
193
|
# Describes the current stage for the autocreated branch.
|
186
194
|
# @return [String]
|
@@ -198,7 +206,9 @@ module Aws::Amplify
|
|
198
206
|
# @return [Hash<String,String>]
|
199
207
|
#
|
200
208
|
# @!attribute [rw] basic_auth_credentials
|
201
|
-
# The basic authorization credentials for the autocreated branch.
|
209
|
+
# The basic authorization credentials for the autocreated branch. You
|
210
|
+
# must base64-encode the authorization credentials and provide them in
|
211
|
+
# the format `user:password`.
|
202
212
|
# @return [String]
|
203
213
|
#
|
204
214
|
# @!attribute [rw] enable_basic_auth
|
@@ -239,7 +249,21 @@ module Aws::Amplify
|
|
239
249
|
:build_spec,
|
240
250
|
:enable_pull_request_preview,
|
241
251
|
:pull_request_environment_name)
|
242
|
-
SENSITIVE = [:basic_auth_credentials]
|
252
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec]
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
256
|
+
# Describes the backend properties associated with an Amplify `Branch`.
|
257
|
+
#
|
258
|
+
# @!attribute [rw] stack_arn
|
259
|
+
# The Amazon Resource Name (ARN) for the CloudFormation stack.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Backend AWS API Documentation
|
263
|
+
#
|
264
|
+
class Backend < Struct.new(
|
265
|
+
:stack_arn)
|
266
|
+
SENSITIVE = []
|
243
267
|
include Aws::Structure
|
244
268
|
end
|
245
269
|
|
@@ -384,6 +408,8 @@ module Aws::Amplify
|
|
384
408
|
#
|
385
409
|
# @!attribute [rw] basic_auth_credentials
|
386
410
|
# The basic authorization credentials for a branch of an Amplify app.
|
411
|
+
# You must base64-encode the authorization credentials and provide
|
412
|
+
# them in the format `user:password`.
|
387
413
|
# @return [String]
|
388
414
|
#
|
389
415
|
# @!attribute [rw] build_spec
|
@@ -420,6 +446,11 @@ module Aws::Amplify
|
|
420
446
|
# part of an Amplify app.
|
421
447
|
# @return [String]
|
422
448
|
#
|
449
|
+
# @!attribute [rw] backend
|
450
|
+
# Describes the backend properties associated with an Amplify
|
451
|
+
# `Branch`.
|
452
|
+
# @return [Types::Backend]
|
453
|
+
#
|
423
454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Branch AWS API Documentation
|
424
455
|
#
|
425
456
|
class Branch < Struct.new(
|
@@ -449,76 +480,32 @@ module Aws::Amplify
|
|
449
480
|
:pull_request_environment_name,
|
450
481
|
:destination_branch,
|
451
482
|
:source_branch,
|
452
|
-
:backend_environment_arn
|
453
|
-
|
483
|
+
:backend_environment_arn,
|
484
|
+
:backend)
|
485
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec]
|
454
486
|
include Aws::Structure
|
455
487
|
end
|
456
488
|
|
457
489
|
# The request structure used to create apps in Amplify.
|
458
490
|
#
|
459
|
-
# @note When making an API call, you may pass CreateAppRequest
|
460
|
-
# data as a hash:
|
461
|
-
#
|
462
|
-
# {
|
463
|
-
# name: "Name", # required
|
464
|
-
# description: "Description",
|
465
|
-
# repository: "Repository",
|
466
|
-
# platform: "WEB", # accepts WEB
|
467
|
-
# iam_service_role_arn: "ServiceRoleArn",
|
468
|
-
# oauth_token: "OauthToken",
|
469
|
-
# access_token: "AccessToken",
|
470
|
-
# environment_variables: {
|
471
|
-
# "EnvKey" => "EnvValue",
|
472
|
-
# },
|
473
|
-
# enable_branch_auto_build: false,
|
474
|
-
# enable_branch_auto_deletion: false,
|
475
|
-
# enable_basic_auth: false,
|
476
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
477
|
-
# custom_rules: [
|
478
|
-
# {
|
479
|
-
# source: "Source", # required
|
480
|
-
# target: "Target", # required
|
481
|
-
# status: "Status",
|
482
|
-
# condition: "Condition",
|
483
|
-
# },
|
484
|
-
# ],
|
485
|
-
# tags: {
|
486
|
-
# "TagKey" => "TagValue",
|
487
|
-
# },
|
488
|
-
# build_spec: "BuildSpec",
|
489
|
-
# custom_headers: "CustomHeaders",
|
490
|
-
# enable_auto_branch_creation: false,
|
491
|
-
# auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
|
492
|
-
# auto_branch_creation_config: {
|
493
|
-
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
|
494
|
-
# framework: "Framework",
|
495
|
-
# enable_auto_build: false,
|
496
|
-
# environment_variables: {
|
497
|
-
# "EnvKey" => "EnvValue",
|
498
|
-
# },
|
499
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
500
|
-
# enable_basic_auth: false,
|
501
|
-
# enable_performance_mode: false,
|
502
|
-
# build_spec: "BuildSpec",
|
503
|
-
# enable_pull_request_preview: false,
|
504
|
-
# pull_request_environment_name: "PullRequestEnvironmentName",
|
505
|
-
# },
|
506
|
-
# }
|
507
|
-
#
|
508
491
|
# @!attribute [rw] name
|
509
|
-
# The name
|
492
|
+
# The name of the Amplify app.
|
510
493
|
# @return [String]
|
511
494
|
#
|
512
495
|
# @!attribute [rw] description
|
513
|
-
# The description
|
496
|
+
# The description of the Amplify app.
|
514
497
|
# @return [String]
|
515
498
|
#
|
516
499
|
# @!attribute [rw] repository
|
517
|
-
# The repository for
|
500
|
+
# The Git repository for the Amplify app.
|
518
501
|
# @return [String]
|
519
502
|
#
|
520
503
|
# @!attribute [rw] platform
|
521
|
-
# The platform
|
504
|
+
# The platform for the Amplify app. For a static app, set the platform
|
505
|
+
# type to `WEB`. For a dynamic server-side rendered (SSR) app, set the
|
506
|
+
# platform type to `WEB_COMPUTE`. For an app requiring Amplify
|
507
|
+
# Hosting's original SSR support only, set the platform type to
|
508
|
+
# `WEB_DYNAMIC`.
|
522
509
|
# @return [String]
|
523
510
|
#
|
524
511
|
# @!attribute [rw] iam_service_role_arn
|
@@ -529,17 +516,61 @@ module Aws::Amplify
|
|
529
516
|
# @!attribute [rw] oauth_token
|
530
517
|
# The OAuth token for a third-party source control system for an
|
531
518
|
# Amplify app. The OAuth token is used to create a webhook and a
|
532
|
-
# read-only deploy key. The OAuth token is not
|
519
|
+
# read-only deploy key using SSH cloning. The OAuth token is not
|
520
|
+
# stored.
|
521
|
+
#
|
522
|
+
# Use `oauthToken` for repository providers other than GitHub, such as
|
523
|
+
# Bitbucket or CodeCommit. To authorize access to GitHub as your
|
524
|
+
# repository provider, use `accessToken`.
|
525
|
+
#
|
526
|
+
# You must specify either `oauthToken` or `accessToken` when you
|
527
|
+
# create a new app.
|
528
|
+
#
|
529
|
+
# Existing Amplify apps deployed from a GitHub repository using OAuth
|
530
|
+
# continue to work with CI/CD. However, we strongly recommend that you
|
531
|
+
# migrate these apps to use the GitHub App. For more information, see
|
532
|
+
# [Migrating an existing OAuth app to the Amplify GitHub App][1] in
|
533
|
+
# the *Amplify User Guide* .
|
534
|
+
#
|
535
|
+
#
|
536
|
+
#
|
537
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
|
533
538
|
# @return [String]
|
534
539
|
#
|
535
540
|
# @!attribute [rw] access_token
|
536
|
-
# The personal access token for a
|
537
|
-
#
|
538
|
-
#
|
541
|
+
# The personal access token for a GitHub repository for an Amplify
|
542
|
+
# app. The personal access token is used to authorize access to a
|
543
|
+
# GitHub repository using the Amplify GitHub App. The token is not
|
544
|
+
# stored.
|
545
|
+
#
|
546
|
+
# Use `accessToken` for GitHub repositories only. To authorize access
|
547
|
+
# to a repository provider such as Bitbucket or CodeCommit, use
|
548
|
+
# `oauthToken`.
|
549
|
+
#
|
550
|
+
# You must specify either `accessToken` or `oauthToken` when you
|
551
|
+
# create a new app.
|
552
|
+
#
|
553
|
+
# Existing Amplify apps deployed from a GitHub repository using OAuth
|
554
|
+
# continue to work with CI/CD. However, we strongly recommend that you
|
555
|
+
# migrate these apps to use the GitHub App. For more information, see
|
556
|
+
# [Migrating an existing OAuth app to the Amplify GitHub App][1] in
|
557
|
+
# the *Amplify User Guide* .
|
558
|
+
#
|
559
|
+
#
|
560
|
+
#
|
561
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
|
539
562
|
# @return [String]
|
540
563
|
#
|
541
564
|
# @!attribute [rw] environment_variables
|
542
565
|
# The environment variables map for an Amplify app.
|
566
|
+
#
|
567
|
+
# For a list of the environment variables that are accessible to
|
568
|
+
# Amplify by default, see [Amplify Environment variables][1] in the
|
569
|
+
# *Amplify Hosting User Guide*.
|
570
|
+
#
|
571
|
+
#
|
572
|
+
#
|
573
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html
|
543
574
|
# @return [Hash<String,String>]
|
544
575
|
#
|
545
576
|
# @!attribute [rw] enable_branch_auto_build
|
@@ -547,7 +578,7 @@ module Aws::Amplify
|
|
547
578
|
# @return [Boolean]
|
548
579
|
#
|
549
580
|
# @!attribute [rw] enable_branch_auto_deletion
|
550
|
-
# Automatically disconnects a branch in the Amplify
|
581
|
+
# Automatically disconnects a branch in the Amplify console when you
|
551
582
|
# delete a branch from your Git repository.
|
552
583
|
# @return [Boolean]
|
553
584
|
#
|
@@ -557,7 +588,9 @@ module Aws::Amplify
|
|
557
588
|
# @return [Boolean]
|
558
589
|
#
|
559
590
|
# @!attribute [rw] basic_auth_credentials
|
560
|
-
# The credentials for basic authorization for an Amplify app.
|
591
|
+
# The credentials for basic authorization for an Amplify app. You must
|
592
|
+
# base64-encode the authorization credentials and provide them in the
|
593
|
+
# format `user:password`.
|
561
594
|
# @return [String]
|
562
595
|
#
|
563
596
|
# @!attribute [rw] custom_rules
|
@@ -610,7 +643,7 @@ module Aws::Amplify
|
|
610
643
|
:enable_auto_branch_creation,
|
611
644
|
:auto_branch_creation_patterns,
|
612
645
|
:auto_branch_creation_config)
|
613
|
-
SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials]
|
646
|
+
SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
|
614
647
|
include Aws::Structure
|
615
648
|
end
|
616
649
|
|
@@ -629,16 +662,6 @@ module Aws::Amplify
|
|
629
662
|
|
630
663
|
# The request structure for the backend environment create request.
|
631
664
|
#
|
632
|
-
# @note When making an API call, you may pass CreateBackendEnvironmentRequest
|
633
|
-
# data as a hash:
|
634
|
-
#
|
635
|
-
# {
|
636
|
-
# app_id: "AppId", # required
|
637
|
-
# environment_name: "EnvironmentName", # required
|
638
|
-
# stack_name: "StackName",
|
639
|
-
# deployment_artifacts: "DeploymentArtifacts",
|
640
|
-
# }
|
641
|
-
#
|
642
665
|
# @!attribute [rw] app_id
|
643
666
|
# The unique ID for an Amplify app.
|
644
667
|
# @return [String]
|
@@ -682,34 +705,6 @@ module Aws::Amplify
|
|
682
705
|
|
683
706
|
# The request structure for the create branch request.
|
684
707
|
#
|
685
|
-
# @note When making an API call, you may pass CreateBranchRequest
|
686
|
-
# data as a hash:
|
687
|
-
#
|
688
|
-
# {
|
689
|
-
# app_id: "AppId", # required
|
690
|
-
# branch_name: "BranchName", # required
|
691
|
-
# description: "Description",
|
692
|
-
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
|
693
|
-
# framework: "Framework",
|
694
|
-
# enable_notification: false,
|
695
|
-
# enable_auto_build: false,
|
696
|
-
# environment_variables: {
|
697
|
-
# "EnvKey" => "EnvValue",
|
698
|
-
# },
|
699
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
700
|
-
# enable_basic_auth: false,
|
701
|
-
# enable_performance_mode: false,
|
702
|
-
# tags: {
|
703
|
-
# "TagKey" => "TagValue",
|
704
|
-
# },
|
705
|
-
# build_spec: "BuildSpec",
|
706
|
-
# ttl: "TTL",
|
707
|
-
# display_name: "DisplayName",
|
708
|
-
# enable_pull_request_preview: false,
|
709
|
-
# pull_request_environment_name: "PullRequestEnvironmentName",
|
710
|
-
# backend_environment_arn: "BackendEnvironmentArn",
|
711
|
-
# }
|
712
|
-
#
|
713
708
|
# @!attribute [rw] app_id
|
714
709
|
# The unique ID for an Amplify app.
|
715
710
|
# @return [String]
|
@@ -743,7 +738,9 @@ module Aws::Amplify
|
|
743
738
|
# @return [Hash<String,String>]
|
744
739
|
#
|
745
740
|
# @!attribute [rw] basic_auth_credentials
|
746
|
-
# The basic authorization credentials for the branch.
|
741
|
+
# The basic authorization credentials for the branch. You must
|
742
|
+
# base64-encode the authorization credentials and provide them in the
|
743
|
+
# format `user:password`.
|
747
744
|
# @return [String]
|
748
745
|
#
|
749
746
|
# @!attribute [rw] enable_basic_auth
|
@@ -789,6 +786,11 @@ module Aws::Amplify
|
|
789
786
|
# part of an Amplify app.
|
790
787
|
# @return [String]
|
791
788
|
#
|
789
|
+
# @!attribute [rw] backend
|
790
|
+
# The backend for a `Branch` of an Amplify app. Use for a backend
|
791
|
+
# created from an CloudFormation stack.
|
792
|
+
# @return [Types::Backend]
|
793
|
+
#
|
792
794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchRequest AWS API Documentation
|
793
795
|
#
|
794
796
|
class CreateBranchRequest < Struct.new(
|
@@ -809,8 +811,9 @@ module Aws::Amplify
|
|
809
811
|
:display_name,
|
810
812
|
:enable_pull_request_preview,
|
811
813
|
:pull_request_environment_name,
|
812
|
-
:backend_environment_arn
|
813
|
-
|
814
|
+
:backend_environment_arn,
|
815
|
+
:backend)
|
816
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec]
|
814
817
|
include Aws::Structure
|
815
818
|
end
|
816
819
|
|
@@ -831,23 +834,12 @@ module Aws::Amplify
|
|
831
834
|
|
832
835
|
# The request structure for the create a new deployment request.
|
833
836
|
#
|
834
|
-
# @note When making an API call, you may pass CreateDeploymentRequest
|
835
|
-
# data as a hash:
|
836
|
-
#
|
837
|
-
# {
|
838
|
-
# app_id: "AppId", # required
|
839
|
-
# branch_name: "BranchName", # required
|
840
|
-
# file_map: {
|
841
|
-
# "FileName" => "MD5Hash",
|
842
|
-
# },
|
843
|
-
# }
|
844
|
-
#
|
845
837
|
# @!attribute [rw] app_id
|
846
838
|
# The unique ID for an Amplify app.
|
847
839
|
# @return [String]
|
848
840
|
#
|
849
841
|
# @!attribute [rw] branch_name
|
850
|
-
# The name
|
842
|
+
# The name of the branch to use for the job.
|
851
843
|
# @return [String]
|
852
844
|
#
|
853
845
|
# @!attribute [rw] file_map
|
@@ -896,23 +888,6 @@ module Aws::Amplify
|
|
896
888
|
|
897
889
|
# The request structure for the create domain association request.
|
898
890
|
#
|
899
|
-
# @note When making an API call, you may pass CreateDomainAssociationRequest
|
900
|
-
# data as a hash:
|
901
|
-
#
|
902
|
-
# {
|
903
|
-
# app_id: "AppId", # required
|
904
|
-
# domain_name: "DomainName", # required
|
905
|
-
# enable_auto_sub_domain: false,
|
906
|
-
# sub_domain_settings: [ # required
|
907
|
-
# {
|
908
|
-
# prefix: "DomainPrefix", # required
|
909
|
-
# branch_name: "BranchName", # required
|
910
|
-
# },
|
911
|
-
# ],
|
912
|
-
# auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
|
913
|
-
# auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
|
914
|
-
# }
|
915
|
-
#
|
916
891
|
# @!attribute [rw] app_id
|
917
892
|
# The unique ID for an Amplify app.
|
918
893
|
# @return [String]
|
@@ -969,15 +944,6 @@ module Aws::Amplify
|
|
969
944
|
|
970
945
|
# The request structure for the create webhook request.
|
971
946
|
#
|
972
|
-
# @note When making an API call, you may pass CreateWebhookRequest
|
973
|
-
# data as a hash:
|
974
|
-
#
|
975
|
-
# {
|
976
|
-
# app_id: "AppId", # required
|
977
|
-
# branch_name: "BranchName", # required
|
978
|
-
# description: "Description",
|
979
|
-
# }
|
980
|
-
#
|
981
947
|
# @!attribute [rw] app_id
|
982
948
|
# The unique ID for an Amplify app.
|
983
949
|
# @return [String]
|
@@ -1017,16 +983,6 @@ module Aws::Amplify
|
|
1017
983
|
|
1018
984
|
# Describes a custom rewrite or redirect rule.
|
1019
985
|
#
|
1020
|
-
# @note When making an API call, you may pass CustomRule
|
1021
|
-
# data as a hash:
|
1022
|
-
#
|
1023
|
-
# {
|
1024
|
-
# source: "Source", # required
|
1025
|
-
# target: "Target", # required
|
1026
|
-
# status: "Status",
|
1027
|
-
# condition: "Condition",
|
1028
|
-
# }
|
1029
|
-
#
|
1030
986
|
# @!attribute [rw] source
|
1031
987
|
# The source pattern for a URL rewrite or redirect rule.
|
1032
988
|
# @return [String]
|
@@ -1078,13 +1034,6 @@ module Aws::Amplify
|
|
1078
1034
|
|
1079
1035
|
# Describes the request structure for the delete app request.
|
1080
1036
|
#
|
1081
|
-
# @note When making an API call, you may pass DeleteAppRequest
|
1082
|
-
# data as a hash:
|
1083
|
-
#
|
1084
|
-
# {
|
1085
|
-
# app_id: "AppId", # required
|
1086
|
-
# }
|
1087
|
-
#
|
1088
1037
|
# @!attribute [rw] app_id
|
1089
1038
|
# The unique ID for an Amplify app.
|
1090
1039
|
# @return [String]
|
@@ -1114,14 +1063,6 @@ module Aws::Amplify
|
|
1114
1063
|
|
1115
1064
|
# The request structure for the delete backend environment request.
|
1116
1065
|
#
|
1117
|
-
# @note When making an API call, you may pass DeleteBackendEnvironmentRequest
|
1118
|
-
# data as a hash:
|
1119
|
-
#
|
1120
|
-
# {
|
1121
|
-
# app_id: "AppId", # required
|
1122
|
-
# environment_name: "EnvironmentName", # required
|
1123
|
-
# }
|
1124
|
-
#
|
1125
1066
|
# @!attribute [rw] app_id
|
1126
1067
|
# The unique ID of an Amplify app.
|
1127
1068
|
# @return [String]
|
@@ -1155,20 +1096,12 @@ module Aws::Amplify
|
|
1155
1096
|
|
1156
1097
|
# The request structure for the delete branch request.
|
1157
1098
|
#
|
1158
|
-
# @note When making an API call, you may pass DeleteBranchRequest
|
1159
|
-
# data as a hash:
|
1160
|
-
#
|
1161
|
-
# {
|
1162
|
-
# app_id: "AppId", # required
|
1163
|
-
# branch_name: "BranchName", # required
|
1164
|
-
# }
|
1165
|
-
#
|
1166
1099
|
# @!attribute [rw] app_id
|
1167
1100
|
# The unique ID for an Amplify app.
|
1168
1101
|
# @return [String]
|
1169
1102
|
#
|
1170
1103
|
# @!attribute [rw] branch_name
|
1171
|
-
# The name
|
1104
|
+
# The name of the branch.
|
1172
1105
|
# @return [String]
|
1173
1106
|
#
|
1174
1107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranchRequest AWS API Documentation
|
@@ -1197,14 +1130,6 @@ module Aws::Amplify
|
|
1197
1130
|
|
1198
1131
|
# The request structure for the delete domain association request.
|
1199
1132
|
#
|
1200
|
-
# @note When making an API call, you may pass DeleteDomainAssociationRequest
|
1201
|
-
# data as a hash:
|
1202
|
-
#
|
1203
|
-
# {
|
1204
|
-
# app_id: "AppId", # required
|
1205
|
-
# domain_name: "DomainName", # required
|
1206
|
-
# }
|
1207
|
-
#
|
1208
1133
|
# @!attribute [rw] app_id
|
1209
1134
|
# The unique id for an Amplify app.
|
1210
1135
|
# @return [String]
|
@@ -1237,21 +1162,12 @@ module Aws::Amplify
|
|
1237
1162
|
|
1238
1163
|
# The request structure for the delete job request.
|
1239
1164
|
#
|
1240
|
-
# @note When making an API call, you may pass DeleteJobRequest
|
1241
|
-
# data as a hash:
|
1242
|
-
#
|
1243
|
-
# {
|
1244
|
-
# app_id: "AppId", # required
|
1245
|
-
# branch_name: "BranchName", # required
|
1246
|
-
# job_id: "JobId", # required
|
1247
|
-
# }
|
1248
|
-
#
|
1249
1165
|
# @!attribute [rw] app_id
|
1250
1166
|
# The unique ID for an Amplify app.
|
1251
1167
|
# @return [String]
|
1252
1168
|
#
|
1253
1169
|
# @!attribute [rw] branch_name
|
1254
|
-
# The name
|
1170
|
+
# The name of the branch to use for the job.
|
1255
1171
|
# @return [String]
|
1256
1172
|
#
|
1257
1173
|
# @!attribute [rw] job_id
|
@@ -1284,13 +1200,6 @@ module Aws::Amplify
|
|
1284
1200
|
|
1285
1201
|
# The request structure for the delete webhook request.
|
1286
1202
|
#
|
1287
|
-
# @note When making an API call, you may pass DeleteWebhookRequest
|
1288
|
-
# data as a hash:
|
1289
|
-
#
|
1290
|
-
# {
|
1291
|
-
# webhook_id: "WebhookId", # required
|
1292
|
-
# }
|
1293
|
-
#
|
1294
1203
|
# @!attribute [rw] webhook_id
|
1295
1204
|
# The unique ID for a webhook.
|
1296
1205
|
# @return [String]
|
@@ -1390,16 +1299,6 @@ module Aws::Amplify
|
|
1390
1299
|
|
1391
1300
|
# The request structure for the generate access logs request.
|
1392
1301
|
#
|
1393
|
-
# @note When making an API call, you may pass GenerateAccessLogsRequest
|
1394
|
-
# data as a hash:
|
1395
|
-
#
|
1396
|
-
# {
|
1397
|
-
# start_time: Time.now,
|
1398
|
-
# end_time: Time.now,
|
1399
|
-
# domain_name: "DomainName", # required
|
1400
|
-
# app_id: "AppId", # required
|
1401
|
-
# }
|
1402
|
-
#
|
1403
1302
|
# @!attribute [rw] start_time
|
1404
1303
|
# The time at which the logs should start. The time range specified is
|
1405
1304
|
# inclusive of the start time.
|
@@ -1445,13 +1344,6 @@ module Aws::Amplify
|
|
1445
1344
|
|
1446
1345
|
# The request structure for the get app request.
|
1447
1346
|
#
|
1448
|
-
# @note When making an API call, you may pass GetAppRequest
|
1449
|
-
# data as a hash:
|
1450
|
-
#
|
1451
|
-
# {
|
1452
|
-
# app_id: "AppId", # required
|
1453
|
-
# }
|
1454
|
-
#
|
1455
1347
|
# @!attribute [rw] app_id
|
1456
1348
|
# The unique ID for an Amplify app.
|
1457
1349
|
# @return [String]
|
@@ -1479,13 +1371,6 @@ module Aws::Amplify
|
|
1479
1371
|
|
1480
1372
|
# Returns the request structure for the get artifact request.
|
1481
1373
|
#
|
1482
|
-
# @note When making an API call, you may pass GetArtifactUrlRequest
|
1483
|
-
# data as a hash:
|
1484
|
-
#
|
1485
|
-
# {
|
1486
|
-
# artifact_id: "ArtifactId", # required
|
1487
|
-
# }
|
1488
|
-
#
|
1489
1374
|
# @!attribute [rw] artifact_id
|
1490
1375
|
# The unique ID for an artifact.
|
1491
1376
|
# @return [String]
|
@@ -1519,14 +1404,6 @@ module Aws::Amplify
|
|
1519
1404
|
|
1520
1405
|
# The request structure for the get backend environment request.
|
1521
1406
|
#
|
1522
|
-
# @note When making an API call, you may pass GetBackendEnvironmentRequest
|
1523
|
-
# data as a hash:
|
1524
|
-
#
|
1525
|
-
# {
|
1526
|
-
# app_id: "AppId", # required
|
1527
|
-
# environment_name: "EnvironmentName", # required
|
1528
|
-
# }
|
1529
|
-
#
|
1530
1407
|
# @!attribute [rw] app_id
|
1531
1408
|
# The unique id for an Amplify app.
|
1532
1409
|
# @return [String]
|
@@ -1560,20 +1437,12 @@ module Aws::Amplify
|
|
1560
1437
|
|
1561
1438
|
# The request structure for the get branch request.
|
1562
1439
|
#
|
1563
|
-
# @note When making an API call, you may pass GetBranchRequest
|
1564
|
-
# data as a hash:
|
1565
|
-
#
|
1566
|
-
# {
|
1567
|
-
# app_id: "AppId", # required
|
1568
|
-
# branch_name: "BranchName", # required
|
1569
|
-
# }
|
1570
|
-
#
|
1571
1440
|
# @!attribute [rw] app_id
|
1572
1441
|
# The unique ID for an Amplify app.
|
1573
1442
|
# @return [String]
|
1574
1443
|
#
|
1575
1444
|
# @!attribute [rw] branch_name
|
1576
|
-
# The name
|
1445
|
+
# The name of the branch.
|
1577
1446
|
# @return [String]
|
1578
1447
|
#
|
1579
1448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranchRequest AWS API Documentation
|
@@ -1600,14 +1469,6 @@ module Aws::Amplify
|
|
1600
1469
|
|
1601
1470
|
# The request structure for the get domain association request.
|
1602
1471
|
#
|
1603
|
-
# @note When making an API call, you may pass GetDomainAssociationRequest
|
1604
|
-
# data as a hash:
|
1605
|
-
#
|
1606
|
-
# {
|
1607
|
-
# app_id: "AppId", # required
|
1608
|
-
# domain_name: "DomainName", # required
|
1609
|
-
# }
|
1610
|
-
#
|
1611
1472
|
# @!attribute [rw] app_id
|
1612
1473
|
# The unique id for an Amplify app.
|
1613
1474
|
# @return [String]
|
@@ -1642,21 +1503,12 @@ module Aws::Amplify
|
|
1642
1503
|
|
1643
1504
|
# The request structure for the get job request.
|
1644
1505
|
#
|
1645
|
-
# @note When making an API call, you may pass GetJobRequest
|
1646
|
-
# data as a hash:
|
1647
|
-
#
|
1648
|
-
# {
|
1649
|
-
# app_id: "AppId", # required
|
1650
|
-
# branch_name: "BranchName", # required
|
1651
|
-
# job_id: "JobId", # required
|
1652
|
-
# }
|
1653
|
-
#
|
1654
1506
|
# @!attribute [rw] app_id
|
1655
1507
|
# The unique ID for an Amplify app.
|
1656
1508
|
# @return [String]
|
1657
1509
|
#
|
1658
1510
|
# @!attribute [rw] branch_name
|
1659
|
-
# The branch
|
1511
|
+
# The name of the branch to use for the job.
|
1660
1512
|
# @return [String]
|
1661
1513
|
#
|
1662
1514
|
# @!attribute [rw] job_id
|
@@ -1687,13 +1539,6 @@ module Aws::Amplify
|
|
1687
1539
|
|
1688
1540
|
# The request structure for the get webhook request.
|
1689
1541
|
#
|
1690
|
-
# @note When making an API call, you may pass GetWebhookRequest
|
1691
|
-
# data as a hash:
|
1692
|
-
#
|
1693
|
-
# {
|
1694
|
-
# webhook_id: "WebhookId", # required
|
1695
|
-
# }
|
1696
|
-
#
|
1697
1542
|
# @!attribute [rw] webhook_id
|
1698
1543
|
# The unique ID for a webhook.
|
1699
1544
|
# @return [String]
|
@@ -1826,14 +1671,6 @@ module Aws::Amplify
|
|
1826
1671
|
|
1827
1672
|
# The request structure for the list apps request.
|
1828
1673
|
#
|
1829
|
-
# @note When making an API call, you may pass ListAppsRequest
|
1830
|
-
# data as a hash:
|
1831
|
-
#
|
1832
|
-
# {
|
1833
|
-
# next_token: "NextToken",
|
1834
|
-
# max_results: 1,
|
1835
|
-
# }
|
1836
|
-
#
|
1837
1674
|
# @!attribute [rw] next_token
|
1838
1675
|
# A pagination token. If non-null, the pagination token is returned in
|
1839
1676
|
# a result. Pass its value in another request to retrieve more
|
@@ -1876,17 +1713,6 @@ module Aws::Amplify
|
|
1876
1713
|
|
1877
1714
|
# Describes the request structure for the list artifacts request.
|
1878
1715
|
#
|
1879
|
-
# @note When making an API call, you may pass ListArtifactsRequest
|
1880
|
-
# data as a hash:
|
1881
|
-
#
|
1882
|
-
# {
|
1883
|
-
# app_id: "AppId", # required
|
1884
|
-
# branch_name: "BranchName", # required
|
1885
|
-
# job_id: "JobId", # required
|
1886
|
-
# next_token: "NextToken",
|
1887
|
-
# max_results: 1,
|
1888
|
-
# }
|
1889
|
-
#
|
1890
1716
|
# @!attribute [rw] app_id
|
1891
1717
|
# The unique ID for an Amplify app.
|
1892
1718
|
# @return [String]
|
@@ -1943,16 +1769,6 @@ module Aws::Amplify
|
|
1943
1769
|
|
1944
1770
|
# The request structure for the list backend environments request.
|
1945
1771
|
#
|
1946
|
-
# @note When making an API call, you may pass ListBackendEnvironmentsRequest
|
1947
|
-
# data as a hash:
|
1948
|
-
#
|
1949
|
-
# {
|
1950
|
-
# app_id: "AppId", # required
|
1951
|
-
# environment_name: "EnvironmentName",
|
1952
|
-
# next_token: "NextToken",
|
1953
|
-
# max_results: 1,
|
1954
|
-
# }
|
1955
|
-
#
|
1956
1772
|
# @!attribute [rw] app_id
|
1957
1773
|
# The unique ID for an Amplify app.
|
1958
1774
|
# @return [String]
|
@@ -2005,15 +1821,6 @@ module Aws::Amplify
|
|
2005
1821
|
|
2006
1822
|
# The request structure for the list branches request.
|
2007
1823
|
#
|
2008
|
-
# @note When making an API call, you may pass ListBranchesRequest
|
2009
|
-
# data as a hash:
|
2010
|
-
#
|
2011
|
-
# {
|
2012
|
-
# app_id: "AppId", # required
|
2013
|
-
# next_token: "NextToken",
|
2014
|
-
# max_results: 1,
|
2015
|
-
# }
|
2016
|
-
#
|
2017
1824
|
# @!attribute [rw] app_id
|
2018
1825
|
# The unique ID for an Amplify app.
|
2019
1826
|
# @return [String]
|
@@ -2060,15 +1867,6 @@ module Aws::Amplify
|
|
2060
1867
|
|
2061
1868
|
# The request structure for the list domain associations request.
|
2062
1869
|
#
|
2063
|
-
# @note When making an API call, you may pass ListDomainAssociationsRequest
|
2064
|
-
# data as a hash:
|
2065
|
-
#
|
2066
|
-
# {
|
2067
|
-
# app_id: "AppId", # required
|
2068
|
-
# next_token: "NextToken",
|
2069
|
-
# max_results: 1,
|
2070
|
-
# }
|
2071
|
-
#
|
2072
1870
|
# @!attribute [rw] app_id
|
2073
1871
|
# The unique ID for an Amplify app.
|
2074
1872
|
# @return [String]
|
@@ -2115,22 +1913,12 @@ module Aws::Amplify
|
|
2115
1913
|
|
2116
1914
|
# The request structure for the list jobs request.
|
2117
1915
|
#
|
2118
|
-
# @note When making an API call, you may pass ListJobsRequest
|
2119
|
-
# data as a hash:
|
2120
|
-
#
|
2121
|
-
# {
|
2122
|
-
# app_id: "AppId", # required
|
2123
|
-
# branch_name: "BranchName", # required
|
2124
|
-
# next_token: "NextToken",
|
2125
|
-
# max_results: 1,
|
2126
|
-
# }
|
2127
|
-
#
|
2128
1916
|
# @!attribute [rw] app_id
|
2129
1917
|
# The unique ID for an Amplify app.
|
2130
1918
|
# @return [String]
|
2131
1919
|
#
|
2132
1920
|
# @!attribute [rw] branch_name
|
2133
|
-
# The name for
|
1921
|
+
# The name of the branch to use for the request.
|
2134
1922
|
# @return [String]
|
2135
1923
|
#
|
2136
1924
|
# @!attribute [rw] next_token
|
@@ -2177,13 +1965,6 @@ module Aws::Amplify
|
|
2177
1965
|
|
2178
1966
|
# The request structure to use to list tags for a resource.
|
2179
1967
|
#
|
2180
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2181
|
-
# data as a hash:
|
2182
|
-
#
|
2183
|
-
# {
|
2184
|
-
# resource_arn: "ResourceArn", # required
|
2185
|
-
# }
|
2186
|
-
#
|
2187
1968
|
# @!attribute [rw] resource_arn
|
2188
1969
|
# The Amazon Resource Name (ARN) to use to list tags.
|
2189
1970
|
# @return [String]
|
@@ -2212,15 +1993,6 @@ module Aws::Amplify
|
|
2212
1993
|
|
2213
1994
|
# The request structure for the list webhooks request.
|
2214
1995
|
#
|
2215
|
-
# @note When making an API call, you may pass ListWebhooksRequest
|
2216
|
-
# data as a hash:
|
2217
|
-
#
|
2218
|
-
# {
|
2219
|
-
# app_id: "AppId", # required
|
2220
|
-
# next_token: "NextToken",
|
2221
|
-
# max_results: 1,
|
2222
|
-
# }
|
2223
|
-
#
|
2224
1996
|
# @!attribute [rw] app_id
|
2225
1997
|
# The unique ID for an Amplify app.
|
2226
1998
|
# @return [String]
|
@@ -2328,22 +2100,12 @@ module Aws::Amplify
|
|
2328
2100
|
|
2329
2101
|
# The request structure for the start a deployment request.
|
2330
2102
|
#
|
2331
|
-
# @note When making an API call, you may pass StartDeploymentRequest
|
2332
|
-
# data as a hash:
|
2333
|
-
#
|
2334
|
-
# {
|
2335
|
-
# app_id: "AppId", # required
|
2336
|
-
# branch_name: "BranchName", # required
|
2337
|
-
# job_id: "JobId",
|
2338
|
-
# source_url: "SourceUrl",
|
2339
|
-
# }
|
2340
|
-
#
|
2341
2103
|
# @!attribute [rw] app_id
|
2342
2104
|
# The unique ID for an Amplify app.
|
2343
2105
|
# @return [String]
|
2344
2106
|
#
|
2345
2107
|
# @!attribute [rw] branch_name
|
2346
|
-
# The name
|
2108
|
+
# The name of the branch to use for the job.
|
2347
2109
|
# @return [String]
|
2348
2110
|
#
|
2349
2111
|
# @!attribute [rw] job_id
|
@@ -2385,26 +2147,12 @@ module Aws::Amplify
|
|
2385
2147
|
|
2386
2148
|
# The request structure for the start job request.
|
2387
2149
|
#
|
2388
|
-
# @note When making an API call, you may pass StartJobRequest
|
2389
|
-
# data as a hash:
|
2390
|
-
#
|
2391
|
-
# {
|
2392
|
-
# app_id: "AppId", # required
|
2393
|
-
# branch_name: "BranchName", # required
|
2394
|
-
# job_id: "JobId",
|
2395
|
-
# job_type: "RELEASE", # required, accepts RELEASE, RETRY, MANUAL, WEB_HOOK
|
2396
|
-
# job_reason: "JobReason",
|
2397
|
-
# commit_id: "CommitId",
|
2398
|
-
# commit_message: "CommitMessage",
|
2399
|
-
# commit_time: Time.now,
|
2400
|
-
# }
|
2401
|
-
#
|
2402
2150
|
# @!attribute [rw] app_id
|
2403
2151
|
# The unique ID for an Amplify app.
|
2404
2152
|
# @return [String]
|
2405
2153
|
#
|
2406
2154
|
# @!attribute [rw] branch_name
|
2407
|
-
# The branch
|
2155
|
+
# The name of the branch to use for the job.
|
2408
2156
|
# @return [String]
|
2409
2157
|
#
|
2410
2158
|
# @!attribute [rw] job_id
|
@@ -2415,13 +2163,14 @@ module Aws::Amplify
|
|
2415
2163
|
# @!attribute [rw] job_type
|
2416
2164
|
# Describes the type for the job. The job type `RELEASE` starts a new
|
2417
2165
|
# job with the latest change from the specified branch. This value is
|
2418
|
-
# available only for apps that are connected to a repository.
|
2419
|
-
#
|
2420
|
-
#
|
2166
|
+
# available only for apps that are connected to a repository.
|
2167
|
+
#
|
2168
|
+
# The job type `RETRY` retries an existing job. If the job type value
|
2169
|
+
# is `RETRY`, the `jobId` is also required.
|
2421
2170
|
# @return [String]
|
2422
2171
|
#
|
2423
2172
|
# @!attribute [rw] job_reason
|
2424
|
-
# A descriptive reason for starting
|
2173
|
+
# A descriptive reason for starting the job.
|
2425
2174
|
# @return [String]
|
2426
2175
|
#
|
2427
2176
|
# @!attribute [rw] commit_id
|
@@ -2533,21 +2282,12 @@ module Aws::Amplify
|
|
2533
2282
|
|
2534
2283
|
# The request structure for the stop job request.
|
2535
2284
|
#
|
2536
|
-
# @note When making an API call, you may pass StopJobRequest
|
2537
|
-
# data as a hash:
|
2538
|
-
#
|
2539
|
-
# {
|
2540
|
-
# app_id: "AppId", # required
|
2541
|
-
# branch_name: "BranchName", # required
|
2542
|
-
# job_id: "JobId", # required
|
2543
|
-
# }
|
2544
|
-
#
|
2545
2285
|
# @!attribute [rw] app_id
|
2546
2286
|
# The unique ID for an Amplify app.
|
2547
2287
|
# @return [String]
|
2548
2288
|
#
|
2549
2289
|
# @!attribute [rw] branch_name
|
2550
|
-
# The name
|
2290
|
+
# The name of the branch to use for the stop job request.
|
2551
2291
|
# @return [String]
|
2552
2292
|
#
|
2553
2293
|
# @!attribute [rw] job_id
|
@@ -2604,14 +2344,6 @@ module Aws::Amplify
|
|
2604
2344
|
|
2605
2345
|
# Describes the settings for the subdomain.
|
2606
2346
|
#
|
2607
|
-
# @note When making an API call, you may pass SubDomainSetting
|
2608
|
-
# data as a hash:
|
2609
|
-
#
|
2610
|
-
# {
|
2611
|
-
# prefix: "DomainPrefix", # required
|
2612
|
-
# branch_name: "BranchName", # required
|
2613
|
-
# }
|
2614
|
-
#
|
2615
2347
|
# @!attribute [rw] prefix
|
2616
2348
|
# The prefix setting for the subdomain.
|
2617
2349
|
# @return [String]
|
@@ -2631,16 +2363,6 @@ module Aws::Amplify
|
|
2631
2363
|
|
2632
2364
|
# The request structure to tag a resource with a tag key and value.
|
2633
2365
|
#
|
2634
|
-
# @note When making an API call, you may pass TagResourceRequest
|
2635
|
-
# data as a hash:
|
2636
|
-
#
|
2637
|
-
# {
|
2638
|
-
# resource_arn: "ResourceArn", # required
|
2639
|
-
# tags: { # required
|
2640
|
-
# "TagKey" => "TagValue",
|
2641
|
-
# },
|
2642
|
-
# }
|
2643
|
-
#
|
2644
2366
|
# @!attribute [rw] resource_arn
|
2645
2367
|
# The Amazon Resource Name (ARN) to use to tag a resource.
|
2646
2368
|
# @return [String]
|
@@ -2679,14 +2401,6 @@ module Aws::Amplify
|
|
2679
2401
|
|
2680
2402
|
# The request structure for the untag resource request.
|
2681
2403
|
#
|
2682
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
2683
|
-
# data as a hash:
|
2684
|
-
#
|
2685
|
-
# {
|
2686
|
-
# resource_arn: "ResourceArn", # required
|
2687
|
-
# tag_keys: ["TagKey"], # required
|
2688
|
-
# }
|
2689
|
-
#
|
2690
2404
|
# @!attribute [rw] resource_arn
|
2691
2405
|
# The Amazon Resource Name (ARN) to use to untag a resource.
|
2692
2406
|
# @return [String]
|
@@ -2712,53 +2426,6 @@ module Aws::Amplify
|
|
2712
2426
|
|
2713
2427
|
# The request structure for the update app request.
|
2714
2428
|
#
|
2715
|
-
# @note When making an API call, you may pass UpdateAppRequest
|
2716
|
-
# data as a hash:
|
2717
|
-
#
|
2718
|
-
# {
|
2719
|
-
# app_id: "AppId", # required
|
2720
|
-
# name: "Name",
|
2721
|
-
# description: "Description",
|
2722
|
-
# platform: "WEB", # accepts WEB
|
2723
|
-
# iam_service_role_arn: "ServiceRoleArn",
|
2724
|
-
# environment_variables: {
|
2725
|
-
# "EnvKey" => "EnvValue",
|
2726
|
-
# },
|
2727
|
-
# enable_branch_auto_build: false,
|
2728
|
-
# enable_branch_auto_deletion: false,
|
2729
|
-
# enable_basic_auth: false,
|
2730
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
2731
|
-
# custom_rules: [
|
2732
|
-
# {
|
2733
|
-
# source: "Source", # required
|
2734
|
-
# target: "Target", # required
|
2735
|
-
# status: "Status",
|
2736
|
-
# condition: "Condition",
|
2737
|
-
# },
|
2738
|
-
# ],
|
2739
|
-
# build_spec: "BuildSpec",
|
2740
|
-
# custom_headers: "CustomHeaders",
|
2741
|
-
# enable_auto_branch_creation: false,
|
2742
|
-
# auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
|
2743
|
-
# auto_branch_creation_config: {
|
2744
|
-
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
|
2745
|
-
# framework: "Framework",
|
2746
|
-
# enable_auto_build: false,
|
2747
|
-
# environment_variables: {
|
2748
|
-
# "EnvKey" => "EnvValue",
|
2749
|
-
# },
|
2750
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
2751
|
-
# enable_basic_auth: false,
|
2752
|
-
# enable_performance_mode: false,
|
2753
|
-
# build_spec: "BuildSpec",
|
2754
|
-
# enable_pull_request_preview: false,
|
2755
|
-
# pull_request_environment_name: "PullRequestEnvironmentName",
|
2756
|
-
# },
|
2757
|
-
# repository: "Repository",
|
2758
|
-
# oauth_token: "OauthToken",
|
2759
|
-
# access_token: "AccessToken",
|
2760
|
-
# }
|
2761
|
-
#
|
2762
2429
|
# @!attribute [rw] app_id
|
2763
2430
|
# The unique ID for an Amplify app.
|
2764
2431
|
# @return [String]
|
@@ -2772,7 +2439,11 @@ module Aws::Amplify
|
|
2772
2439
|
# @return [String]
|
2773
2440
|
#
|
2774
2441
|
# @!attribute [rw] platform
|
2775
|
-
# The platform for
|
2442
|
+
# The platform for the Amplify app. For a static app, set the platform
|
2443
|
+
# type to `WEB`. For a dynamic server-side rendered (SSR) app, set the
|
2444
|
+
# platform type to `WEB_COMPUTE`. For an app requiring Amplify
|
2445
|
+
# Hosting's original SSR support only, set the platform type to
|
2446
|
+
# `WEB_DYNAMIC`.
|
2776
2447
|
# @return [String]
|
2777
2448
|
#
|
2778
2449
|
# @!attribute [rw] iam_service_role_arn
|
@@ -2789,7 +2460,7 @@ module Aws::Amplify
|
|
2789
2460
|
# @return [Boolean]
|
2790
2461
|
#
|
2791
2462
|
# @!attribute [rw] enable_branch_auto_deletion
|
2792
|
-
# Automatically disconnects a branch in the Amplify
|
2463
|
+
# Automatically disconnects a branch in the Amplify console when you
|
2793
2464
|
# delete a branch from your Git repository.
|
2794
2465
|
# @return [Boolean]
|
2795
2466
|
#
|
@@ -2798,7 +2469,9 @@ module Aws::Amplify
|
|
2798
2469
|
# @return [Boolean]
|
2799
2470
|
#
|
2800
2471
|
# @!attribute [rw] basic_auth_credentials
|
2801
|
-
# The basic authorization credentials for an Amplify app.
|
2472
|
+
# The basic authorization credentials for an Amplify app. You must
|
2473
|
+
# base64-encode the authorization credentials and provide them in the
|
2474
|
+
# format `user:password`.
|
2802
2475
|
# @return [String]
|
2803
2476
|
#
|
2804
2477
|
# @!attribute [rw] custom_rules
|
@@ -2827,19 +2500,57 @@ module Aws::Amplify
|
|
2827
2500
|
# @return [Types::AutoBranchCreationConfig]
|
2828
2501
|
#
|
2829
2502
|
# @!attribute [rw] repository
|
2830
|
-
# The name of the repository for an Amplify app
|
2503
|
+
# The name of the Git repository for an Amplify app.
|
2831
2504
|
# @return [String]
|
2832
2505
|
#
|
2833
2506
|
# @!attribute [rw] oauth_token
|
2834
2507
|
# The OAuth token for a third-party source control system for an
|
2835
|
-
# Amplify app. The token is used to create a webhook and a
|
2836
|
-
# deploy key. The OAuth token is not
|
2508
|
+
# Amplify app. The OAuth token is used to create a webhook and a
|
2509
|
+
# read-only deploy key using SSH cloning. The OAuth token is not
|
2510
|
+
# stored.
|
2511
|
+
#
|
2512
|
+
# Use `oauthToken` for repository providers other than GitHub, such as
|
2513
|
+
# Bitbucket or CodeCommit.
|
2514
|
+
#
|
2515
|
+
# To authorize access to GitHub as your repository provider, use
|
2516
|
+
# `accessToken`.
|
2517
|
+
#
|
2518
|
+
# You must specify either `oauthToken` or `accessToken` when you
|
2519
|
+
# update an app.
|
2520
|
+
#
|
2521
|
+
# Existing Amplify apps deployed from a GitHub repository using OAuth
|
2522
|
+
# continue to work with CI/CD. However, we strongly recommend that you
|
2523
|
+
# migrate these apps to use the GitHub App. For more information, see
|
2524
|
+
# [Migrating an existing OAuth app to the Amplify GitHub App][1] in
|
2525
|
+
# the *Amplify User Guide* .
|
2526
|
+
#
|
2527
|
+
#
|
2528
|
+
#
|
2529
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
|
2837
2530
|
# @return [String]
|
2838
2531
|
#
|
2839
2532
|
# @!attribute [rw] access_token
|
2840
|
-
# The personal access token for a
|
2841
|
-
#
|
2842
|
-
#
|
2533
|
+
# The personal access token for a GitHub repository for an Amplify
|
2534
|
+
# app. The personal access token is used to authorize access to a
|
2535
|
+
# GitHub repository using the Amplify GitHub App. The token is not
|
2536
|
+
# stored.
|
2537
|
+
#
|
2538
|
+
# Use `accessToken` for GitHub repositories only. To authorize access
|
2539
|
+
# to a repository provider such as Bitbucket or CodeCommit, use
|
2540
|
+
# `oauthToken`.
|
2541
|
+
#
|
2542
|
+
# You must specify either `accessToken` or `oauthToken` when you
|
2543
|
+
# update an app.
|
2544
|
+
#
|
2545
|
+
# Existing Amplify apps deployed from a GitHub repository using OAuth
|
2546
|
+
# continue to work with CI/CD. However, we strongly recommend that you
|
2547
|
+
# migrate these apps to use the GitHub App. For more information, see
|
2548
|
+
# [Migrating an existing OAuth app to the Amplify GitHub App][1] in
|
2549
|
+
# the *Amplify User Guide* .
|
2550
|
+
#
|
2551
|
+
#
|
2552
|
+
#
|
2553
|
+
# [1]: https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth
|
2843
2554
|
# @return [String]
|
2844
2555
|
#
|
2845
2556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppRequest AWS API Documentation
|
@@ -2864,7 +2575,7 @@ module Aws::Amplify
|
|
2864
2575
|
:repository,
|
2865
2576
|
:oauth_token,
|
2866
2577
|
:access_token)
|
2867
|
-
SENSITIVE = [:basic_auth_credentials, :oauth_token, :access_token]
|
2578
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec, :oauth_token, :access_token]
|
2868
2579
|
include Aws::Structure
|
2869
2580
|
end
|
2870
2581
|
|
@@ -2884,37 +2595,12 @@ module Aws::Amplify
|
|
2884
2595
|
|
2885
2596
|
# The request structure for the update branch request.
|
2886
2597
|
#
|
2887
|
-
# @note When making an API call, you may pass UpdateBranchRequest
|
2888
|
-
# data as a hash:
|
2889
|
-
#
|
2890
|
-
# {
|
2891
|
-
# app_id: "AppId", # required
|
2892
|
-
# branch_name: "BranchName", # required
|
2893
|
-
# description: "Description",
|
2894
|
-
# framework: "Framework",
|
2895
|
-
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
|
2896
|
-
# enable_notification: false,
|
2897
|
-
# enable_auto_build: false,
|
2898
|
-
# environment_variables: {
|
2899
|
-
# "EnvKey" => "EnvValue",
|
2900
|
-
# },
|
2901
|
-
# basic_auth_credentials: "BasicAuthCredentials",
|
2902
|
-
# enable_basic_auth: false,
|
2903
|
-
# enable_performance_mode: false,
|
2904
|
-
# build_spec: "BuildSpec",
|
2905
|
-
# ttl: "TTL",
|
2906
|
-
# display_name: "DisplayName",
|
2907
|
-
# enable_pull_request_preview: false,
|
2908
|
-
# pull_request_environment_name: "PullRequestEnvironmentName",
|
2909
|
-
# backend_environment_arn: "BackendEnvironmentArn",
|
2910
|
-
# }
|
2911
|
-
#
|
2912
2598
|
# @!attribute [rw] app_id
|
2913
2599
|
# The unique ID for an Amplify app.
|
2914
2600
|
# @return [String]
|
2915
2601
|
#
|
2916
2602
|
# @!attribute [rw] branch_name
|
2917
|
-
# The name
|
2603
|
+
# The name of the branch.
|
2918
2604
|
# @return [String]
|
2919
2605
|
#
|
2920
2606
|
# @!attribute [rw] description
|
@@ -2942,7 +2628,9 @@ module Aws::Amplify
|
|
2942
2628
|
# @return [Hash<String,String>]
|
2943
2629
|
#
|
2944
2630
|
# @!attribute [rw] basic_auth_credentials
|
2945
|
-
# The basic authorization credentials for the branch.
|
2631
|
+
# The basic authorization credentials for the branch. You must
|
2632
|
+
# base64-encode the authorization credentials and provide them in the
|
2633
|
+
# format `user:password`.
|
2946
2634
|
# @return [String]
|
2947
2635
|
#
|
2948
2636
|
# @!attribute [rw] enable_basic_auth
|
@@ -2984,6 +2672,11 @@ module Aws::Amplify
|
|
2984
2672
|
# part of an Amplify app.
|
2985
2673
|
# @return [String]
|
2986
2674
|
#
|
2675
|
+
# @!attribute [rw] backend
|
2676
|
+
# The backend for a `Branch` of an Amplify app. Use for a backend
|
2677
|
+
# created from an CloudFormation stack.
|
2678
|
+
# @return [Types::Backend]
|
2679
|
+
#
|
2987
2680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest AWS API Documentation
|
2988
2681
|
#
|
2989
2682
|
class UpdateBranchRequest < Struct.new(
|
@@ -3003,8 +2696,9 @@ module Aws::Amplify
|
|
3003
2696
|
:display_name,
|
3004
2697
|
:enable_pull_request_preview,
|
3005
2698
|
:pull_request_environment_name,
|
3006
|
-
:backend_environment_arn
|
3007
|
-
|
2699
|
+
:backend_environment_arn,
|
2700
|
+
:backend)
|
2701
|
+
SENSITIVE = [:basic_auth_credentials, :build_spec]
|
3008
2702
|
include Aws::Structure
|
3009
2703
|
end
|
3010
2704
|
|
@@ -3025,23 +2719,6 @@ module Aws::Amplify
|
|
3025
2719
|
|
3026
2720
|
# The request structure for the update domain association request.
|
3027
2721
|
#
|
3028
|
-
# @note When making an API call, you may pass UpdateDomainAssociationRequest
|
3029
|
-
# data as a hash:
|
3030
|
-
#
|
3031
|
-
# {
|
3032
|
-
# app_id: "AppId", # required
|
3033
|
-
# domain_name: "DomainName", # required
|
3034
|
-
# enable_auto_sub_domain: false,
|
3035
|
-
# sub_domain_settings: [ # required
|
3036
|
-
# {
|
3037
|
-
# prefix: "DomainPrefix", # required
|
3038
|
-
# branch_name: "BranchName", # required
|
3039
|
-
# },
|
3040
|
-
# ],
|
3041
|
-
# auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
|
3042
|
-
# auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
|
3043
|
-
# }
|
3044
|
-
#
|
3045
2722
|
# @!attribute [rw] app_id
|
3046
2723
|
# The unique ID for an Amplify app.
|
3047
2724
|
# @return [String]
|
@@ -3098,15 +2775,6 @@ module Aws::Amplify
|
|
3098
2775
|
|
3099
2776
|
# The request structure for the update webhook request.
|
3100
2777
|
#
|
3101
|
-
# @note When making an API call, you may pass UpdateWebhookRequest
|
3102
|
-
# data as a hash:
|
3103
|
-
#
|
3104
|
-
# {
|
3105
|
-
# webhook_id: "WebhookId", # required
|
3106
|
-
# branch_name: "BranchName",
|
3107
|
-
# description: "Description",
|
3108
|
-
# }
|
3109
|
-
#
|
3110
2778
|
# @!attribute [rw] webhook_id
|
3111
2779
|
# The unique ID for a webhook.
|
3112
2780
|
# @return [String]
|