aws-sdk-proton 1.15.0 → 1.17.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-proton/client.rb +908 -227
- data/lib/aws-sdk-proton/client_api.rb +270 -3
- data/lib/aws-sdk-proton/types.rb +1015 -172
- data/lib/aws-sdk-proton/waiters.rb +91 -0
- data/lib/aws-sdk-proton.rb +1 -1
- metadata +2 -2
@@ -367,11 +367,11 @@ module Aws::Proton
|
|
367
367
|
# infrastructure resources in the associated environment account.
|
368
368
|
#
|
369
369
|
# For more information, see [Environment account connections][1] in the
|
370
|
-
# *Proton
|
370
|
+
# *Proton User guide*.
|
371
371
|
#
|
372
372
|
#
|
373
373
|
#
|
374
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
374
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
375
375
|
#
|
376
376
|
# @option params [required, String] :id
|
377
377
|
# The ID of the environment account connection.
|
@@ -389,6 +389,7 @@ module Aws::Proton
|
|
389
389
|
# @example Response structure
|
390
390
|
#
|
391
391
|
# resp.environment_account_connection.arn #=> String
|
392
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
392
393
|
# resp.environment_account_connection.environment_account_id #=> String
|
393
394
|
# resp.environment_account_connection.environment_name #=> String
|
394
395
|
# resp.environment_account_connection.id #=> String
|
@@ -407,9 +408,57 @@ module Aws::Proton
|
|
407
408
|
req.send_request(options)
|
408
409
|
end
|
409
410
|
|
411
|
+
# Attempts to cancel a component deployment (for a component that is in
|
412
|
+
# the `IN_PROGRESS` deployment status).
|
413
|
+
#
|
414
|
+
# For more information about components, see [Proton components][1] in
|
415
|
+
# the *Proton User Guide*.
|
416
|
+
#
|
417
|
+
#
|
418
|
+
#
|
419
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
420
|
+
#
|
421
|
+
# @option params [required, String] :component_name
|
422
|
+
# The name of the component with the deployment to cancel.
|
423
|
+
#
|
424
|
+
# @return [Types::CancelComponentDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
|
+
#
|
426
|
+
# * {Types::CancelComponentDeploymentOutput#component #component} => Types::Component
|
427
|
+
#
|
428
|
+
# @example Request syntax with placeholder values
|
429
|
+
#
|
430
|
+
# resp = client.cancel_component_deployment({
|
431
|
+
# component_name: "ResourceName", # required
|
432
|
+
# })
|
433
|
+
#
|
434
|
+
# @example Response structure
|
435
|
+
#
|
436
|
+
# resp.component.arn #=> String
|
437
|
+
# resp.component.created_at #=> Time
|
438
|
+
# resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
439
|
+
# resp.component.deployment_status_message #=> String
|
440
|
+
# resp.component.description #=> String
|
441
|
+
# resp.component.environment_name #=> String
|
442
|
+
# resp.component.last_deployment_attempted_at #=> Time
|
443
|
+
# resp.component.last_deployment_succeeded_at #=> Time
|
444
|
+
# resp.component.last_modified_at #=> Time
|
445
|
+
# resp.component.name #=> String
|
446
|
+
# resp.component.service_instance_name #=> String
|
447
|
+
# resp.component.service_name #=> String
|
448
|
+
# resp.component.service_spec #=> String
|
449
|
+
#
|
450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelComponentDeployment AWS API Documentation
|
451
|
+
#
|
452
|
+
# @overload cancel_component_deployment(params = {})
|
453
|
+
# @param [Hash] params ({})
|
454
|
+
def cancel_component_deployment(params = {}, options = {})
|
455
|
+
req = build_request(:cancel_component_deployment, params)
|
456
|
+
req.send_request(options)
|
457
|
+
end
|
458
|
+
|
410
459
|
# Attempts to cancel an environment deployment on an UpdateEnvironment
|
411
460
|
# action, if the deployment is `IN_PROGRESS`. For more information, see
|
412
|
-
# [Update an environment][1] in the *Proton
|
461
|
+
# [Update an environment][1] in the *Proton User guide*.
|
413
462
|
#
|
414
463
|
# The following list includes potential cancellation scenarios.
|
415
464
|
#
|
@@ -425,7 +474,7 @@ module Aws::Proton
|
|
425
474
|
#
|
426
475
|
#
|
427
476
|
#
|
428
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
477
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html
|
429
478
|
#
|
430
479
|
# @option params [required, String] :environment_name
|
431
480
|
# The name of the environment with the deployment to cancel.
|
@@ -443,6 +492,7 @@ module Aws::Proton
|
|
443
492
|
# @example Response structure
|
444
493
|
#
|
445
494
|
# resp.environment.arn #=> String
|
495
|
+
# resp.environment.component_role_arn #=> String
|
446
496
|
# resp.environment.created_at #=> Time
|
447
497
|
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
448
498
|
# resp.environment.deployment_status_message #=> String
|
@@ -474,8 +524,8 @@ module Aws::Proton
|
|
474
524
|
|
475
525
|
# Attempts to cancel a service instance deployment on an
|
476
526
|
# UpdateServiceInstance action, if the deployment is `IN_PROGRESS`. For
|
477
|
-
# more information, see
|
478
|
-
#
|
527
|
+
# more information, see [Update a service instance][1] in the *Proton
|
528
|
+
# User guide*.
|
479
529
|
#
|
480
530
|
# The following list includes potential cancellation scenarios.
|
481
531
|
#
|
@@ -491,8 +541,7 @@ module Aws::Proton
|
|
491
541
|
#
|
492
542
|
#
|
493
543
|
#
|
494
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
495
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html
|
544
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html
|
496
545
|
#
|
497
546
|
# @option params [required, String] :service_instance_name
|
498
547
|
# The name of the service instance with the deployment to cancel.
|
@@ -539,8 +588,8 @@ module Aws::Proton
|
|
539
588
|
|
540
589
|
# Attempts to cancel a service pipeline deployment on an
|
541
590
|
# UpdateServicePipeline action, if the deployment is `IN_PROGRESS`. For
|
542
|
-
# more information, see
|
543
|
-
#
|
591
|
+
# more information, see [Update a service pipeline][1] in the *Proton
|
592
|
+
# User guide*.
|
544
593
|
#
|
545
594
|
# The following list includes potential cancellation scenarios.
|
546
595
|
#
|
@@ -556,8 +605,7 @@ module Aws::Proton
|
|
556
605
|
#
|
557
606
|
#
|
558
607
|
#
|
559
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
560
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html
|
608
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html
|
561
609
|
#
|
562
610
|
# @option params [required, String] :service_name
|
563
611
|
# The name of the service with the service pipeline deployment to
|
@@ -595,6 +643,117 @@ module Aws::Proton
|
|
595
643
|
req.send_request(options)
|
596
644
|
end
|
597
645
|
|
646
|
+
# Create an Proton component. A component is an infrastructure extension
|
647
|
+
# for a service instance.
|
648
|
+
#
|
649
|
+
# For more information about components, see [Proton components][1] in
|
650
|
+
# the *Proton User Guide*.
|
651
|
+
#
|
652
|
+
#
|
653
|
+
#
|
654
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
655
|
+
#
|
656
|
+
# @option params [String] :description
|
657
|
+
# An optional customer-provided description of the component.
|
658
|
+
#
|
659
|
+
# @option params [String] :environment_name
|
660
|
+
# The name of the Proton environment that you want to associate this
|
661
|
+
# component with. You must specify this when you don't specify
|
662
|
+
# `serviceInstanceName` and `serviceName`.
|
663
|
+
#
|
664
|
+
# @option params [required, String] :manifest
|
665
|
+
# A path to a manifest file that lists the Infrastructure as Code (IaC)
|
666
|
+
# file, template language, and rendering engine for infrastructure that
|
667
|
+
# a custom component provisions.
|
668
|
+
#
|
669
|
+
# @option params [required, String] :name
|
670
|
+
# The customer-provided name of the component.
|
671
|
+
#
|
672
|
+
# @option params [String] :service_instance_name
|
673
|
+
# The name of the service instance that you want to attach this
|
674
|
+
# component to. If you don't specify this, the component isn't
|
675
|
+
# attached to any service instance. Specify both `serviceInstanceName`
|
676
|
+
# and `serviceName` or neither of them.
|
677
|
+
#
|
678
|
+
# @option params [String] :service_name
|
679
|
+
# The name of the service that `serviceInstanceName` is associated with.
|
680
|
+
# If you don't specify this, the component isn't attached to any
|
681
|
+
# service instance. Specify both `serviceInstanceName` and `serviceName`
|
682
|
+
# or neither of them.
|
683
|
+
#
|
684
|
+
# @option params [String] :service_spec
|
685
|
+
# The service spec that you want the component to use to access service
|
686
|
+
# inputs. Set this only when you attach the component to a service
|
687
|
+
# instance.
|
688
|
+
#
|
689
|
+
# @option params [Array<Types::Tag>] :tags
|
690
|
+
# An optional list of metadata items that you can associate with the
|
691
|
+
# Proton component. A tag is a key-value pair.
|
692
|
+
#
|
693
|
+
# For more information, see [Proton resources and tagging][1] in the
|
694
|
+
# *Proton User Guide*.
|
695
|
+
#
|
696
|
+
#
|
697
|
+
#
|
698
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
699
|
+
#
|
700
|
+
# @option params [required, String] :template_file
|
701
|
+
# A path to the Infrastructure as Code (IaC) file describing
|
702
|
+
# infrastructure that a custom component provisions.
|
703
|
+
#
|
704
|
+
# <note markdown="1"> Components support a single IaC file, even if you use Terraform as
|
705
|
+
# your template language.
|
706
|
+
#
|
707
|
+
# </note>
|
708
|
+
#
|
709
|
+
# @return [Types::CreateComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
710
|
+
#
|
711
|
+
# * {Types::CreateComponentOutput#component #component} => Types::Component
|
712
|
+
#
|
713
|
+
# @example Request syntax with placeholder values
|
714
|
+
#
|
715
|
+
# resp = client.create_component({
|
716
|
+
# description: "Description",
|
717
|
+
# environment_name: "ResourceName",
|
718
|
+
# manifest: "TemplateManifestContents", # required
|
719
|
+
# name: "ResourceName", # required
|
720
|
+
# service_instance_name: "ResourceName",
|
721
|
+
# service_name: "ResourceName",
|
722
|
+
# service_spec: "SpecContents",
|
723
|
+
# tags: [
|
724
|
+
# {
|
725
|
+
# key: "TagKey", # required
|
726
|
+
# value: "TagValue", # required
|
727
|
+
# },
|
728
|
+
# ],
|
729
|
+
# template_file: "TemplateFileContents", # required
|
730
|
+
# })
|
731
|
+
#
|
732
|
+
# @example Response structure
|
733
|
+
#
|
734
|
+
# resp.component.arn #=> String
|
735
|
+
# resp.component.created_at #=> Time
|
736
|
+
# resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
737
|
+
# resp.component.deployment_status_message #=> String
|
738
|
+
# resp.component.description #=> String
|
739
|
+
# resp.component.environment_name #=> String
|
740
|
+
# resp.component.last_deployment_attempted_at #=> Time
|
741
|
+
# resp.component.last_deployment_succeeded_at #=> Time
|
742
|
+
# resp.component.last_modified_at #=> Time
|
743
|
+
# resp.component.name #=> String
|
744
|
+
# resp.component.service_instance_name #=> String
|
745
|
+
# resp.component.service_name #=> String
|
746
|
+
# resp.component.service_spec #=> String
|
747
|
+
#
|
748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateComponent AWS API Documentation
|
749
|
+
#
|
750
|
+
# @overload create_component(params = {})
|
751
|
+
# @param [Hash] params ({})
|
752
|
+
def create_component(params = {}, options = {})
|
753
|
+
req = build_request(:create_component, params)
|
754
|
+
req.send_request(options)
|
755
|
+
end
|
756
|
+
|
598
757
|
# Deploy a new environment. An Proton environment is created from an
|
599
758
|
# environment template that defines infrastructure and resources that
|
600
759
|
# can be shared across services.
|
@@ -609,12 +768,28 @@ module Aws::Proton
|
|
609
768
|
# that your IaC engine uses to provision resources.
|
610
769
|
#
|
611
770
|
# For more information, see [Environments][1] and [Provisioning
|
612
|
-
# methods][2] in the *Proton
|
771
|
+
# methods][2] in the *Proton User Guide*.
|
772
|
+
#
|
773
|
+
#
|
774
|
+
#
|
775
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html
|
776
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html
|
613
777
|
#
|
778
|
+
# @option params [String] :component_role_arn
|
779
|
+
# The Amazon Resource Name (ARN) of the IAM service role that Proton
|
780
|
+
# uses when provisioning directly defined components in this
|
781
|
+
# environment. It determines the scope of infrastructure that a
|
782
|
+
# component can provision.
|
614
783
|
#
|
784
|
+
# You must specify `componentRoleArn` to allow directly defined
|
785
|
+
# components to be associated with this environment.
|
615
786
|
#
|
616
|
-
# [1]
|
617
|
-
#
|
787
|
+
# For more information about components, see [Proton components][1] in
|
788
|
+
# the *Proton User Guide*.
|
789
|
+
#
|
790
|
+
#
|
791
|
+
#
|
792
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
618
793
|
#
|
619
794
|
# @option params [String] :description
|
620
795
|
# A description of the environment that's being created and deployed.
|
@@ -623,7 +798,7 @@ module Aws::Proton
|
|
623
798
|
# The ID of the environment account connection that you provide if
|
624
799
|
# you're provisioning your environment infrastructure resources to an
|
625
800
|
# environment account. For more information, see [Environment account
|
626
|
-
# connections][1] in the *Proton
|
801
|
+
# connections][1] in the *Proton User guide*.
|
627
802
|
#
|
628
803
|
# To use Amazon Web Services-managed provisioning for the environment,
|
629
804
|
# specify either the `environmentAccountConnectionId` or
|
@@ -632,7 +807,7 @@ module Aws::Proton
|
|
632
807
|
#
|
633
808
|
#
|
634
809
|
#
|
635
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
810
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
636
811
|
#
|
637
812
|
# @option params [required, String] :name
|
638
813
|
# The name of the environment.
|
@@ -647,8 +822,10 @@ module Aws::Proton
|
|
647
822
|
# parameter.
|
648
823
|
#
|
649
824
|
# @option params [Types::RepositoryBranchInput] :provisioning_repository
|
650
|
-
# The
|
651
|
-
# infrastructure templates for self-managed provisioning.
|
825
|
+
# The linked repository that you use to host your rendered
|
826
|
+
# infrastructure templates for self-managed provisioning. A linked
|
827
|
+
# repository is a repository that has been registered with Proton. For
|
828
|
+
# more information, see CreateRepository.
|
652
829
|
#
|
653
830
|
# To use self-managed provisioning for the environment, specify this
|
654
831
|
# parameter and omit the `environmentAccountConnectionId` and
|
@@ -657,23 +834,22 @@ module Aws::Proton
|
|
657
834
|
# @option params [required, String] :spec
|
658
835
|
# A YAML formatted string that provides inputs as defined in the
|
659
836
|
# environment template bundle schema file. For more information, see
|
660
|
-
# [Environments][1] in the *Proton
|
837
|
+
# [Environments][1] in the *Proton User Guide*.
|
661
838
|
#
|
662
839
|
#
|
663
840
|
#
|
664
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
841
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html
|
665
842
|
#
|
666
843
|
# @option params [Array<Types::Tag>] :tags
|
667
844
|
# An optional list of metadata items that you can associate with the
|
668
845
|
# Proton environment. A tag is a key-value pair.
|
669
846
|
#
|
670
|
-
# For more information, see
|
671
|
-
#
|
847
|
+
# For more information, see [Proton resources and tagging][1] in the
|
848
|
+
# *Proton User Guide*.
|
672
849
|
#
|
673
850
|
#
|
674
851
|
#
|
675
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
676
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
852
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
677
853
|
#
|
678
854
|
# @option params [required, String] :template_major_version
|
679
855
|
# The major version of the environment template.
|
@@ -683,11 +859,11 @@ module Aws::Proton
|
|
683
859
|
#
|
684
860
|
# @option params [required, String] :template_name
|
685
861
|
# The name of the environment template. For more information, see
|
686
|
-
# [Environment Templates][1] in the *Proton
|
862
|
+
# [Environment Templates][1] in the *Proton User Guide*.
|
687
863
|
#
|
688
864
|
#
|
689
865
|
#
|
690
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
866
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html
|
691
867
|
#
|
692
868
|
# @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
693
869
|
#
|
@@ -696,6 +872,7 @@ module Aws::Proton
|
|
696
872
|
# @example Request syntax with placeholder values
|
697
873
|
#
|
698
874
|
# resp = client.create_environment({
|
875
|
+
# component_role_arn: "Arn",
|
699
876
|
# description: "Description",
|
700
877
|
# environment_account_connection_id: "EnvironmentAccountConnectionId",
|
701
878
|
# name: "ResourceName", # required
|
@@ -720,6 +897,7 @@ module Aws::Proton
|
|
720
897
|
# @example Response structure
|
721
898
|
#
|
722
899
|
# resp.environment.arn #=> String
|
900
|
+
# resp.environment.component_role_arn #=> String
|
723
901
|
# resp.environment.created_at #=> Time
|
724
902
|
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
725
903
|
# resp.environment.deployment_status_message #=> String
|
@@ -756,12 +934,11 @@ module Aws::Proton
|
|
756
934
|
# An environment account connection is a secure bi-directional
|
757
935
|
# connection between a *management account* and an *environment account*
|
758
936
|
# that maintains authorization and permissions. For more information,
|
759
|
-
# see [Environment account connections][1] in the *Proton
|
760
|
-
# guide*.
|
937
|
+
# see [Environment account connections][1] in the *Proton User guide*.
|
761
938
|
#
|
762
939
|
#
|
763
940
|
#
|
764
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
941
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
765
942
|
#
|
766
943
|
# @option params [String] :client_token
|
767
944
|
# When included, if two identical requests are made with the same client
|
@@ -771,6 +948,23 @@ module Aws::Proton
|
|
771
948
|
# **A suitable default value is auto-generated.** You should normally
|
772
949
|
# not need to pass this option.**
|
773
950
|
#
|
951
|
+
# @option params [String] :component_role_arn
|
952
|
+
# The Amazon Resource Name (ARN) of the IAM service role that Proton
|
953
|
+
# uses when provisioning directly defined components in the associated
|
954
|
+
# environment account. It determines the scope of infrastructure that a
|
955
|
+
# component can provision in the account.
|
956
|
+
#
|
957
|
+
# You must specify `componentRoleArn` to allow directly defined
|
958
|
+
# components to be associated with any environments running in this
|
959
|
+
# account.
|
960
|
+
#
|
961
|
+
# For more information about components, see [Proton components][1] in
|
962
|
+
# the *Proton User Guide*.
|
963
|
+
#
|
964
|
+
#
|
965
|
+
#
|
966
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
967
|
+
#
|
774
968
|
# @option params [required, String] :environment_name
|
775
969
|
# The name of the Proton environment that's created in the associated
|
776
970
|
# management account.
|
@@ -793,11 +987,11 @@ module Aws::Proton
|
|
793
987
|
# Proton environment account connection. A tag is a key-value pair.
|
794
988
|
#
|
795
989
|
# For more information, see [Proton resources and tagging][1] in the
|
796
|
-
# *Proton
|
990
|
+
# *Proton User Guide*.
|
797
991
|
#
|
798
992
|
#
|
799
993
|
#
|
800
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
994
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
801
995
|
#
|
802
996
|
# @return [Types::CreateEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
803
997
|
#
|
@@ -807,6 +1001,7 @@ module Aws::Proton
|
|
807
1001
|
#
|
808
1002
|
# resp = client.create_environment_account_connection({
|
809
1003
|
# client_token: "ClientToken",
|
1004
|
+
# component_role_arn: "Arn",
|
810
1005
|
# environment_name: "ResourceName", # required
|
811
1006
|
# management_account_id: "AwsAccountId", # required
|
812
1007
|
# role_arn: "Arn", # required
|
@@ -821,6 +1016,7 @@ module Aws::Proton
|
|
821
1016
|
# @example Response structure
|
822
1017
|
#
|
823
1018
|
# resp.environment_account_connection.arn #=> String
|
1019
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
824
1020
|
# resp.environment_account_connection.environment_account_id #=> String
|
825
1021
|
# resp.environment_account_connection.environment_name #=> String
|
826
1022
|
# resp.environment_account_connection.id #=> String
|
@@ -840,7 +1036,7 @@ module Aws::Proton
|
|
840
1036
|
end
|
841
1037
|
|
842
1038
|
# Create an environment template for Proton. For more information, see
|
843
|
-
# [Environment Templates][1] in the *Proton
|
1039
|
+
# [Environment Templates][1] in the *Proton User Guide*.
|
844
1040
|
#
|
845
1041
|
# You can create an environment template in one of the two following
|
846
1042
|
# ways:
|
@@ -855,12 +1051,12 @@ module Aws::Proton
|
|
855
1051
|
# provisioned and managed infrastructure, include the `provisioning`
|
856
1052
|
# parameter and set the value to `CUSTOMER_MANAGED`. For more
|
857
1053
|
# information, see [Register and publish an environment template][2]
|
858
|
-
# in the *Proton
|
1054
|
+
# in the *Proton User Guide*.
|
859
1055
|
#
|
860
1056
|
#
|
861
1057
|
#
|
862
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
863
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/
|
1058
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html
|
1059
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/template-create.html
|
864
1060
|
#
|
865
1061
|
# @option params [String] :description
|
866
1062
|
# A description of the environment template.
|
@@ -882,13 +1078,12 @@ module Aws::Proton
|
|
882
1078
|
# An optional list of metadata items that you can associate with the
|
883
1079
|
# Proton environment template. A tag is a key-value pair.
|
884
1080
|
#
|
885
|
-
# For more information, see
|
886
|
-
#
|
1081
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1082
|
+
# *Proton User Guide*.
|
887
1083
|
#
|
888
1084
|
#
|
889
1085
|
#
|
890
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
891
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1086
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
892
1087
|
#
|
893
1088
|
# @return [Types::CreateEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
894
1089
|
#
|
@@ -962,13 +1157,12 @@ module Aws::Proton
|
|
962
1157
|
# An optional list of metadata items that you can associate with the
|
963
1158
|
# Proton environment template version. A tag is a key-value pair.
|
964
1159
|
#
|
965
|
-
# For more information, see
|
966
|
-
#
|
1160
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1161
|
+
# *Proton User Guide*.
|
967
1162
|
#
|
968
1163
|
#
|
969
1164
|
#
|
970
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
971
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1165
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
972
1166
|
#
|
973
1167
|
# @option params [required, String] :template_name
|
974
1168
|
# The name of the environment template.
|
@@ -1021,30 +1215,33 @@ module Aws::Proton
|
|
1021
1215
|
req.send_request(options)
|
1022
1216
|
end
|
1023
1217
|
|
1024
|
-
# Create and register a link to a repository
|
1025
|
-
#
|
1026
|
-
# template sync
|
1027
|
-
#
|
1218
|
+
# Create and register a link to a repository. Proton uses the link to
|
1219
|
+
# repeatedly access the repository, to either push to it (self-managed
|
1220
|
+
# provisioning) or pull from it (template sync). You can share a linked
|
1221
|
+
# repository across multiple resources (like environments using
|
1222
|
+
# self-managed provisioning, or synced templates). When you create a
|
1223
|
+
# repository link, Proton creates a [service-linked role][1] for you.
|
1028
1224
|
#
|
1029
1225
|
# For more information, see [Self-managed provisioning][2], [Template
|
1030
|
-
# bundles][3], and [Template sync configurations][4] in the *Proton
|
1031
|
-
#
|
1226
|
+
# bundles][3], and [Template sync configurations][4] in the *Proton User
|
1227
|
+
# Guide*.
|
1032
1228
|
#
|
1033
1229
|
#
|
1034
1230
|
#
|
1035
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1036
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/
|
1037
|
-
# [3]: https://docs.aws.amazon.com/proton/latest/
|
1038
|
-
# [4]: https://docs.aws.amazon.com/proton/latest/
|
1231
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html
|
1232
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self
|
1233
|
+
# [3]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles
|
1234
|
+
# [4]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html
|
1039
1235
|
#
|
1040
1236
|
# @option params [required, String] :connection_arn
|
1041
|
-
# The Amazon Resource Name (ARN) of your
|
1042
|
-
#
|
1043
|
-
# the *Proton
|
1237
|
+
# The Amazon Resource Name (ARN) of your AWS CodeStar connection that
|
1238
|
+
# connects Proton to your repository provider account. For more
|
1239
|
+
# information, see [Setting up for Proton][1] in the *Proton User
|
1240
|
+
# Guide*.
|
1044
1241
|
#
|
1045
1242
|
#
|
1046
1243
|
#
|
1047
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1244
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html
|
1048
1245
|
#
|
1049
1246
|
# @option params [String] :encryption_key
|
1050
1247
|
# The ARN of your customer Amazon Web Services Key Management Service
|
@@ -1060,13 +1257,12 @@ module Aws::Proton
|
|
1060
1257
|
# An optional list of metadata items that you can associate with the
|
1061
1258
|
# Proton repository. A tag is a key-value pair.
|
1062
1259
|
#
|
1063
|
-
# For more information, see
|
1064
|
-
#
|
1260
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1261
|
+
# *Proton User Guide*.
|
1065
1262
|
#
|
1066
1263
|
#
|
1067
1264
|
#
|
1068
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1069
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1265
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1070
1266
|
#
|
1071
1267
|
# @return [Types::CreateRepositoryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1072
1268
|
#
|
@@ -1106,13 +1302,12 @@ module Aws::Proton
|
|
1106
1302
|
|
1107
1303
|
# Create an Proton service. An Proton service is an instantiation of a
|
1108
1304
|
# service template and often includes several service instances and
|
1109
|
-
# pipeline. For more information, see [Services][1] in the *Proton
|
1110
|
-
#
|
1305
|
+
# pipeline. For more information, see [Services][1] in the *Proton User
|
1306
|
+
# Guide*.
|
1111
1307
|
#
|
1112
1308
|
#
|
1113
1309
|
#
|
1114
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1115
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html
|
1310
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html
|
1116
1311
|
#
|
1117
1312
|
# @option params [String] :branch_name
|
1118
1313
|
# The name of the code repository branch that holds the code that's
|
@@ -1127,15 +1322,13 @@ module Aws::Proton
|
|
1127
1322
|
#
|
1128
1323
|
# @option params [String] :repository_connection_arn
|
1129
1324
|
# The Amazon Resource Name (ARN) of the repository connection. For more
|
1130
|
-
# information, see [
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
# *doesn't* include a service pipeline.
|
1325
|
+
# information, see [Setting up an AWS CodeStar connection][1] in the
|
1326
|
+
# *Proton User Guide*. *Don't* include this parameter if your service
|
1327
|
+
# template *doesn't* include a service pipeline.
|
1134
1328
|
#
|
1135
1329
|
#
|
1136
1330
|
#
|
1137
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1138
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/proton-setup.html#setup-repo-connection
|
1331
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol
|
1139
1332
|
#
|
1140
1333
|
# @option params [String] :repository_id
|
1141
1334
|
# The ID of the code repository. *Don't* include this parameter if your
|
@@ -1146,25 +1339,22 @@ module Aws::Proton
|
|
1146
1339
|
# template bundle schema file. The spec file is in YAML format. *Don’t*
|
1147
1340
|
# include pipeline inputs in the spec if your service template *doesn’t*
|
1148
1341
|
# include a service pipeline. For more information, see [Create a
|
1149
|
-
# service][1] in the *Proton
|
1150
|
-
# service][2] in the *Proton User Guide*.
|
1342
|
+
# service][1] in the *Proton User Guide*.
|
1151
1343
|
#
|
1152
1344
|
#
|
1153
1345
|
#
|
1154
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1155
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html
|
1346
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html
|
1156
1347
|
#
|
1157
1348
|
# @option params [Array<Types::Tag>] :tags
|
1158
1349
|
# An optional list of metadata items that you can associate with the
|
1159
1350
|
# Proton service. A tag is a key-value pair.
|
1160
1351
|
#
|
1161
|
-
# For more information, see
|
1162
|
-
#
|
1352
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1353
|
+
# *Proton User Guide*.
|
1163
1354
|
#
|
1164
1355
|
#
|
1165
1356
|
#
|
1166
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1167
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1357
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1168
1358
|
#
|
1169
1359
|
# @option params [required, String] :template_major_version
|
1170
1360
|
# The major version of the service template that was used to create the
|
@@ -1241,12 +1431,12 @@ module Aws::Proton
|
|
1241
1431
|
# from Proton. If the selected service template includes a service
|
1242
1432
|
# pipeline definition, they provide a link to their source code
|
1243
1433
|
# repository. Proton then deploys and manages the infrastructure defined
|
1244
|
-
# by the selected service template. For more information, see [
|
1245
|
-
#
|
1434
|
+
# by the selected service template. For more information, see [Proton
|
1435
|
+
# templates][1] in the *Proton User Guide*.
|
1246
1436
|
#
|
1247
1437
|
#
|
1248
1438
|
#
|
1249
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1439
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html
|
1250
1440
|
#
|
1251
1441
|
# @option params [String] :description
|
1252
1442
|
# A description of the service template.
|
@@ -1265,24 +1455,23 @@ module Aws::Proton
|
|
1265
1455
|
# By default, Proton provides a service pipeline for your service. When
|
1266
1456
|
# this parameter is included, it indicates that an Proton service
|
1267
1457
|
# pipeline *isn't* provided for your service. After it's included, it
|
1268
|
-
# *can't* be changed. For more information, see [
|
1269
|
-
#
|
1458
|
+
# *can't* be changed. For more information, see [Template bundles][1]
|
1459
|
+
# in the *Proton User Guide*.
|
1270
1460
|
#
|
1271
1461
|
#
|
1272
1462
|
#
|
1273
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1463
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles
|
1274
1464
|
#
|
1275
1465
|
# @option params [Array<Types::Tag>] :tags
|
1276
1466
|
# An optional list of metadata items that you can associate with the
|
1277
1467
|
# Proton service template. A tag is a key-value pair.
|
1278
1468
|
#
|
1279
|
-
# For more information, see
|
1280
|
-
#
|
1469
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1470
|
+
# *Proton User Guide*.
|
1281
1471
|
#
|
1282
1472
|
#
|
1283
1473
|
#
|
1284
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1285
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1474
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1286
1475
|
#
|
1287
1476
|
# @return [Types::CreateServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1288
1477
|
#
|
@@ -1339,8 +1528,10 @@ module Aws::Proton
|
|
1339
1528
|
# not need to pass this option.**
|
1340
1529
|
#
|
1341
1530
|
# @option params [required, Array<Types::CompatibleEnvironmentTemplateInput>] :compatible_environment_templates
|
1342
|
-
# An array of
|
1343
|
-
# version
|
1531
|
+
# An array of environment template objects that are compatible with the
|
1532
|
+
# new service template version. A service instance based on this service
|
1533
|
+
# template version can run in environments based on compatible
|
1534
|
+
# templates.
|
1344
1535
|
#
|
1345
1536
|
# @option params [String] :description
|
1346
1537
|
# A description of the new version of a service template.
|
@@ -1356,17 +1547,28 @@ module Aws::Proton
|
|
1356
1547
|
# An object that includes the template bundle S3 bucket path and name
|
1357
1548
|
# for the new version of a service template.
|
1358
1549
|
#
|
1550
|
+
# @option params [Array<String>] :supported_component_sources
|
1551
|
+
# An array of supported component sources. Components with supported
|
1552
|
+
# sources can be attached to service instances based on this service
|
1553
|
+
# template version.
|
1554
|
+
#
|
1555
|
+
# For more information about components, see [Proton components][1] in
|
1556
|
+
# the *Proton User Guide*.
|
1557
|
+
#
|
1558
|
+
#
|
1559
|
+
#
|
1560
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
1561
|
+
#
|
1359
1562
|
# @option params [Array<Types::Tag>] :tags
|
1360
1563
|
# An optional list of metadata items that you can associate with the
|
1361
1564
|
# Proton service template version. A tag is a key-value pair.
|
1362
1565
|
#
|
1363
|
-
# For more information, see
|
1364
|
-
#
|
1566
|
+
# For more information, see [Proton resources and tagging][1] in the
|
1567
|
+
# *Proton User Guide*.
|
1365
1568
|
#
|
1366
1569
|
#
|
1367
1570
|
#
|
1368
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1369
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1571
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1370
1572
|
#
|
1371
1573
|
# @option params [required, String] :template_name
|
1372
1574
|
# The name of the service template.
|
@@ -1393,6 +1595,7 @@ module Aws::Proton
|
|
1393
1595
|
# key: "S3Key", # required
|
1394
1596
|
# },
|
1395
1597
|
# },
|
1598
|
+
# supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED
|
1396
1599
|
# tags: [
|
1397
1600
|
# {
|
1398
1601
|
# key: "TagKey", # required
|
@@ -1417,6 +1620,8 @@ module Aws::Proton
|
|
1417
1620
|
# resp.service_template_version.schema #=> String
|
1418
1621
|
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1419
1622
|
# resp.service_template_version.status_message #=> String
|
1623
|
+
# resp.service_template_version.supported_component_sources #=> Array
|
1624
|
+
# resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED"
|
1420
1625
|
# resp.service_template_version.template_name #=> String
|
1421
1626
|
#
|
1422
1627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersion AWS API Documentation
|
@@ -1428,24 +1633,26 @@ module Aws::Proton
|
|
1428
1633
|
req.send_request(options)
|
1429
1634
|
end
|
1430
1635
|
|
1431
|
-
# Set up a template to create new template versions automatically
|
1432
|
-
# a
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
#
|
1436
|
-
#
|
1437
|
-
#
|
1636
|
+
# Set up a template to create new template versions automatically by
|
1637
|
+
# tracking a linked repository. A linked repository is a repository that
|
1638
|
+
# has been registered with Proton. For more information, see
|
1639
|
+
# CreateRepository.
|
1640
|
+
#
|
1641
|
+
# When a commit is pushed to your linked repository, Proton checks for
|
1642
|
+
# changes to your repository template bundles. If it detects a template
|
1643
|
+
# bundle change, a new major or minor version of its template is
|
1644
|
+
# created, if the version doesn’t already exist. For more information,
|
1645
|
+
# see [Template sync configurations][1] in the *Proton User Guide*.
|
1438
1646
|
#
|
1439
1647
|
#
|
1440
1648
|
#
|
1441
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1442
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html
|
1649
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html
|
1443
1650
|
#
|
1444
1651
|
# @option params [required, String] :branch
|
1445
|
-
# The branch
|
1652
|
+
# The repository branch for your template.
|
1446
1653
|
#
|
1447
1654
|
# @option params [required, String] :repository_name
|
1448
|
-
# The name
|
1655
|
+
# The repository name (for example, `myrepos/myrepo`).
|
1449
1656
|
#
|
1450
1657
|
# @option params [required, String] :repository_provider
|
1451
1658
|
# The provider type for your repository.
|
@@ -1494,6 +1701,53 @@ module Aws::Proton
|
|
1494
1701
|
req.send_request(options)
|
1495
1702
|
end
|
1496
1703
|
|
1704
|
+
# Delete an Proton component resource.
|
1705
|
+
#
|
1706
|
+
# For more information about components, see [Proton components][1] in
|
1707
|
+
# the *Proton User Guide*.
|
1708
|
+
#
|
1709
|
+
#
|
1710
|
+
#
|
1711
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
1712
|
+
#
|
1713
|
+
# @option params [required, String] :name
|
1714
|
+
# The name of the component to delete.
|
1715
|
+
#
|
1716
|
+
# @return [Types::DeleteComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1717
|
+
#
|
1718
|
+
# * {Types::DeleteComponentOutput#component #component} => Types::Component
|
1719
|
+
#
|
1720
|
+
# @example Request syntax with placeholder values
|
1721
|
+
#
|
1722
|
+
# resp = client.delete_component({
|
1723
|
+
# name: "ResourceName", # required
|
1724
|
+
# })
|
1725
|
+
#
|
1726
|
+
# @example Response structure
|
1727
|
+
#
|
1728
|
+
# resp.component.arn #=> String
|
1729
|
+
# resp.component.created_at #=> Time
|
1730
|
+
# resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1731
|
+
# resp.component.deployment_status_message #=> String
|
1732
|
+
# resp.component.description #=> String
|
1733
|
+
# resp.component.environment_name #=> String
|
1734
|
+
# resp.component.last_deployment_attempted_at #=> Time
|
1735
|
+
# resp.component.last_deployment_succeeded_at #=> Time
|
1736
|
+
# resp.component.last_modified_at #=> Time
|
1737
|
+
# resp.component.name #=> String
|
1738
|
+
# resp.component.service_instance_name #=> String
|
1739
|
+
# resp.component.service_name #=> String
|
1740
|
+
# resp.component.service_spec #=> String
|
1741
|
+
#
|
1742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteComponent AWS API Documentation
|
1743
|
+
#
|
1744
|
+
# @overload delete_component(params = {})
|
1745
|
+
# @param [Hash] params ({})
|
1746
|
+
def delete_component(params = {}, options = {})
|
1747
|
+
req = build_request(:delete_component, params)
|
1748
|
+
req.send_request(options)
|
1749
|
+
end
|
1750
|
+
|
1497
1751
|
# Delete an environment.
|
1498
1752
|
#
|
1499
1753
|
# @option params [required, String] :name
|
@@ -1512,6 +1766,7 @@ module Aws::Proton
|
|
1512
1766
|
# @example Response structure
|
1513
1767
|
#
|
1514
1768
|
# resp.environment.arn #=> String
|
1769
|
+
# resp.environment.component_role_arn #=> String
|
1515
1770
|
# resp.environment.created_at #=> Time
|
1516
1771
|
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1517
1772
|
# resp.environment.deployment_status_message #=> String
|
@@ -1551,11 +1806,11 @@ module Aws::Proton
|
|
1551
1806
|
# without an environment connection.
|
1552
1807
|
#
|
1553
1808
|
# For more information, see [Environment account connections][1] in the
|
1554
|
-
# *Proton
|
1809
|
+
# *Proton User guide*.
|
1555
1810
|
#
|
1556
1811
|
#
|
1557
1812
|
#
|
1558
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
1813
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
1559
1814
|
#
|
1560
1815
|
# @option params [required, String] :id
|
1561
1816
|
# The ID of the environment account connection to delete.
|
@@ -1573,6 +1828,7 @@ module Aws::Proton
|
|
1573
1828
|
# @example Response structure
|
1574
1829
|
#
|
1575
1830
|
# resp.environment_account_connection.arn #=> String
|
1831
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
1576
1832
|
# resp.environment_account_connection.environment_account_id #=> String
|
1577
1833
|
# resp.environment_account_connection.environment_name #=> String
|
1578
1834
|
# resp.environment_account_connection.id #=> String
|
@@ -1688,7 +1944,7 @@ module Aws::Proton
|
|
1688
1944
|
# De-register and unlink your repository.
|
1689
1945
|
#
|
1690
1946
|
# @option params [required, String] :name
|
1691
|
-
# The name
|
1947
|
+
# The repository name.
|
1692
1948
|
#
|
1693
1949
|
# @option params [required, String] :provider
|
1694
1950
|
# The repository provider.
|
@@ -1721,7 +1977,19 @@ module Aws::Proton
|
|
1721
1977
|
req.send_request(options)
|
1722
1978
|
end
|
1723
1979
|
|
1724
|
-
# Delete a service.
|
1980
|
+
# Delete a service, with its instances and pipeline.
|
1981
|
+
#
|
1982
|
+
# <note markdown="1"> You can't delete a service if it has any service instances that have
|
1983
|
+
# components attached to them.
|
1984
|
+
#
|
1985
|
+
# For more information about components, see [Proton components][1] in
|
1986
|
+
# the *Proton User Guide*.
|
1987
|
+
#
|
1988
|
+
# </note>
|
1989
|
+
#
|
1990
|
+
#
|
1991
|
+
#
|
1992
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
1725
1993
|
#
|
1726
1994
|
# @option params [required, String] :name
|
1727
1995
|
# The name of the service to delete.
|
@@ -1856,6 +2124,8 @@ module Aws::Proton
|
|
1856
2124
|
# resp.service_template_version.schema #=> String
|
1857
2125
|
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1858
2126
|
# resp.service_template_version.status_message #=> String
|
2127
|
+
# resp.service_template_version.supported_component_sources #=> Array
|
2128
|
+
# resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED"
|
1859
2129
|
# resp.service_template_version.template_name #=> String
|
1860
2130
|
#
|
1861
2131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersion AWS API Documentation
|
@@ -1904,7 +2174,7 @@ module Aws::Proton
|
|
1904
2174
|
req.send_request(options)
|
1905
2175
|
end
|
1906
2176
|
|
1907
|
-
# Get detail data for
|
2177
|
+
# Get detail data for Proton account-wide settings.
|
1908
2178
|
#
|
1909
2179
|
# @return [Types::GetAccountSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1910
2180
|
#
|
@@ -1927,10 +2197,64 @@ module Aws::Proton
|
|
1927
2197
|
req.send_request(options)
|
1928
2198
|
end
|
1929
2199
|
|
1930
|
-
# Get
|
2200
|
+
# Get detailed data for a component.
|
2201
|
+
#
|
2202
|
+
# For more information about components, see [Proton components][1] in
|
2203
|
+
# the *Proton User Guide*.
|
2204
|
+
#
|
2205
|
+
#
|
2206
|
+
#
|
2207
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
2208
|
+
#
|
2209
|
+
# @option params [required, String] :name
|
2210
|
+
# The name of the component that you want to get the detailed data for.
|
2211
|
+
#
|
2212
|
+
# @return [Types::GetComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2213
|
+
#
|
2214
|
+
# * {Types::GetComponentOutput#component #component} => Types::Component
|
2215
|
+
#
|
2216
|
+
# @example Request syntax with placeholder values
|
2217
|
+
#
|
2218
|
+
# resp = client.get_component({
|
2219
|
+
# name: "ResourceName", # required
|
2220
|
+
# })
|
2221
|
+
#
|
2222
|
+
# @example Response structure
|
2223
|
+
#
|
2224
|
+
# resp.component.arn #=> String
|
2225
|
+
# resp.component.created_at #=> Time
|
2226
|
+
# resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2227
|
+
# resp.component.deployment_status_message #=> String
|
2228
|
+
# resp.component.description #=> String
|
2229
|
+
# resp.component.environment_name #=> String
|
2230
|
+
# resp.component.last_deployment_attempted_at #=> Time
|
2231
|
+
# resp.component.last_deployment_succeeded_at #=> Time
|
2232
|
+
# resp.component.last_modified_at #=> Time
|
2233
|
+
# resp.component.name #=> String
|
2234
|
+
# resp.component.service_instance_name #=> String
|
2235
|
+
# resp.component.service_name #=> String
|
2236
|
+
# resp.component.service_spec #=> String
|
2237
|
+
#
|
2238
|
+
#
|
2239
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2240
|
+
#
|
2241
|
+
# * component_deleted
|
2242
|
+
# * component_deployed
|
2243
|
+
#
|
2244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetComponent AWS API Documentation
|
2245
|
+
#
|
2246
|
+
# @overload get_component(params = {})
|
2247
|
+
# @param [Hash] params ({})
|
2248
|
+
def get_component(params = {}, options = {})
|
2249
|
+
req = build_request(:get_component, params)
|
2250
|
+
req.send_request(options)
|
2251
|
+
end
|
2252
|
+
|
2253
|
+
# Get detailed data for an environment.
|
1931
2254
|
#
|
1932
2255
|
# @option params [required, String] :name
|
1933
|
-
# The name of the environment that you want to get the
|
2256
|
+
# The name of the environment that you want to get the detailed data
|
2257
|
+
# for.
|
1934
2258
|
#
|
1935
2259
|
# @return [Types::GetEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1936
2260
|
#
|
@@ -1945,6 +2269,7 @@ module Aws::Proton
|
|
1945
2269
|
# @example Response structure
|
1946
2270
|
#
|
1947
2271
|
# resp.environment.arn #=> String
|
2272
|
+
# resp.environment.component_role_arn #=> String
|
1948
2273
|
# resp.environment.created_at #=> Time
|
1949
2274
|
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1950
2275
|
# resp.environment.deployment_status_message #=> String
|
@@ -1979,18 +2304,19 @@ module Aws::Proton
|
|
1979
2304
|
req.send_request(options)
|
1980
2305
|
end
|
1981
2306
|
|
1982
|
-
# In an environment account,
|
2307
|
+
# In an environment account, get the detailed data for an environment
|
1983
2308
|
# account connection.
|
1984
2309
|
#
|
1985
2310
|
# For more information, see [Environment account connections][1] in the
|
1986
|
-
# *Proton
|
2311
|
+
# *Proton User guide*.
|
1987
2312
|
#
|
1988
2313
|
#
|
1989
2314
|
#
|
1990
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
2315
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
1991
2316
|
#
|
1992
2317
|
# @option params [required, String] :id
|
1993
|
-
# The ID of the environment account connection
|
2318
|
+
# The ID of the environment account connection that you want to get the
|
2319
|
+
# detailed data for.
|
1994
2320
|
#
|
1995
2321
|
# @return [Types::GetEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1996
2322
|
#
|
@@ -2005,6 +2331,7 @@ module Aws::Proton
|
|
2005
2331
|
# @example Response structure
|
2006
2332
|
#
|
2007
2333
|
# resp.environment_account_connection.arn #=> String
|
2334
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
2008
2335
|
# resp.environment_account_connection.environment_account_id #=> String
|
2009
2336
|
# resp.environment_account_connection.environment_name #=> String
|
2010
2337
|
# resp.environment_account_connection.id #=> String
|
@@ -2023,10 +2350,10 @@ module Aws::Proton
|
|
2023
2350
|
req.send_request(options)
|
2024
2351
|
end
|
2025
2352
|
|
2026
|
-
# Get
|
2353
|
+
# Get detailed data for an environment template.
|
2027
2354
|
#
|
2028
2355
|
# @option params [required, String] :name
|
2029
|
-
# The name of the environment template that you want to get the
|
2356
|
+
# The name of the environment template that you want to get the detailed
|
2030
2357
|
# data for.
|
2031
2358
|
#
|
2032
2359
|
# @return [Types::GetEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2060,19 +2387,20 @@ module Aws::Proton
|
|
2060
2387
|
req.send_request(options)
|
2061
2388
|
end
|
2062
2389
|
|
2063
|
-
#
|
2390
|
+
# Get detailed data for a major or minor version of an environment
|
2064
2391
|
# template.
|
2065
2392
|
#
|
2066
2393
|
# @option params [required, String] :major_version
|
2067
|
-
# To
|
2394
|
+
# To get environment template major version detail data, include `major
|
2068
2395
|
# Version`.
|
2069
2396
|
#
|
2070
2397
|
# @option params [required, String] :minor_version
|
2071
|
-
# To
|
2398
|
+
# To get environment template minor version detail data, include
|
2072
2399
|
# `minorVersion`.
|
2073
2400
|
#
|
2074
2401
|
# @option params [required, String] :template_name
|
2075
|
-
# The name of the environment template
|
2402
|
+
# The name of the environment template a version of which you want to
|
2403
|
+
# get detailed data for.
|
2076
2404
|
#
|
2077
2405
|
# @return [Types::GetEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2078
2406
|
#
|
@@ -2114,7 +2442,7 @@ module Aws::Proton
|
|
2114
2442
|
req.send_request(options)
|
2115
2443
|
end
|
2116
2444
|
|
2117
|
-
# Get detail data for a repository.
|
2445
|
+
# Get detail data for a linked repository.
|
2118
2446
|
#
|
2119
2447
|
# @option params [required, String] :name
|
2120
2448
|
# The repository name, for example `myrepos/myrepo`.
|
@@ -2159,14 +2487,14 @@ module Aws::Proton
|
|
2159
2487
|
# can't use these tags to control access to this action using
|
2160
2488
|
# Attribute-based access control (ABAC).
|
2161
2489
|
#
|
2162
|
-
# For more information about ABAC, see [ABAC][1] in the *Proton
|
2163
|
-
#
|
2490
|
+
# For more information about ABAC, see [ABAC][1] in the *Proton User
|
2491
|
+
# Guide*.
|
2164
2492
|
#
|
2165
2493
|
# </note>
|
2166
2494
|
#
|
2167
2495
|
#
|
2168
2496
|
#
|
2169
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
2497
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags
|
2170
2498
|
#
|
2171
2499
|
# @option params [required, String] :branch
|
2172
2500
|
# The repository branch.
|
@@ -2212,10 +2540,10 @@ module Aws::Proton
|
|
2212
2540
|
req.send_request(options)
|
2213
2541
|
end
|
2214
2542
|
|
2215
|
-
# Get
|
2543
|
+
# Get detailed data for a service.
|
2216
2544
|
#
|
2217
2545
|
# @option params [required, String] :name
|
2218
|
-
# The name of the service that you want to get the
|
2546
|
+
# The name of the service that you want to get the detailed data for.
|
2219
2547
|
#
|
2220
2548
|
# @return [Types::GetServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2221
2549
|
#
|
@@ -2269,12 +2597,12 @@ module Aws::Proton
|
|
2269
2597
|
req.send_request(options)
|
2270
2598
|
end
|
2271
2599
|
|
2272
|
-
# Get
|
2600
|
+
# Get detailed data for a service instance. A service instance is an
|
2273
2601
|
# instantiation of service template and it runs in a specific
|
2274
2602
|
# environment.
|
2275
2603
|
#
|
2276
2604
|
# @option params [required, String] :name
|
2277
|
-
# The name of a service instance that you want to get the
|
2605
|
+
# The name of a service instance that you want to get the detailed data
|
2278
2606
|
# for.
|
2279
2607
|
#
|
2280
2608
|
# @option params [required, String] :service_name
|
@@ -2321,10 +2649,11 @@ module Aws::Proton
|
|
2321
2649
|
req.send_request(options)
|
2322
2650
|
end
|
2323
2651
|
|
2324
|
-
# Get
|
2652
|
+
# Get detailed data for a service template.
|
2325
2653
|
#
|
2326
2654
|
# @option params [required, String] :name
|
2327
|
-
# The name of the service template that you want to get
|
2655
|
+
# The name of the service template that you want to get detailed data
|
2656
|
+
# for.
|
2328
2657
|
#
|
2329
2658
|
# @return [Types::GetServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2330
2659
|
#
|
@@ -2357,18 +2686,19 @@ module Aws::Proton
|
|
2357
2686
|
req.send_request(options)
|
2358
2687
|
end
|
2359
2688
|
|
2360
|
-
#
|
2689
|
+
# Get detailed data for a major or minor version of a service template.
|
2361
2690
|
#
|
2362
2691
|
# @option params [required, String] :major_version
|
2363
|
-
# To
|
2692
|
+
# To get service template major version detail data, include `major
|
2364
2693
|
# Version`.
|
2365
2694
|
#
|
2366
2695
|
# @option params [required, String] :minor_version
|
2367
|
-
# To
|
2696
|
+
# To get service template minor version detail data, include
|
2368
2697
|
# `minorVersion`.
|
2369
2698
|
#
|
2370
2699
|
# @option params [required, String] :template_name
|
2371
|
-
# The name of the service template
|
2700
|
+
# The name of the service template a version of which you want to get
|
2701
|
+
# detailed data for.
|
2372
2702
|
#
|
2373
2703
|
# @return [Types::GetServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2374
2704
|
#
|
@@ -2397,6 +2727,8 @@ module Aws::Proton
|
|
2397
2727
|
# resp.service_template_version.schema #=> String
|
2398
2728
|
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
2399
2729
|
# resp.service_template_version.status_message #=> String
|
2730
|
+
# resp.service_template_version.supported_component_sources #=> Array
|
2731
|
+
# resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED"
|
2400
2732
|
# resp.service_template_version.template_name #=> String
|
2401
2733
|
#
|
2402
2734
|
#
|
@@ -2528,14 +2860,181 @@ module Aws::Proton
|
|
2528
2860
|
req.send_request(options)
|
2529
2861
|
end
|
2530
2862
|
|
2863
|
+
# Get a list of component Infrastructure as Code (IaC) outputs.
|
2864
|
+
#
|
2865
|
+
# For more information about components, see [Proton components][1] in
|
2866
|
+
# the *Proton User Guide*.
|
2867
|
+
#
|
2868
|
+
#
|
2869
|
+
#
|
2870
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
2871
|
+
#
|
2872
|
+
# @option params [required, String] :component_name
|
2873
|
+
# The name of the component whose outputs you want.
|
2874
|
+
#
|
2875
|
+
# @option params [String] :next_token
|
2876
|
+
# A token that indicates the location of the next output in the array of
|
2877
|
+
# outputs, after the list of outputs that was previously requested.
|
2878
|
+
#
|
2879
|
+
# @return [Types::ListComponentOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2880
|
+
#
|
2881
|
+
# * {Types::ListComponentOutputsOutput#next_token #next_token} => String
|
2882
|
+
# * {Types::ListComponentOutputsOutput#outputs #outputs} => Array<Types::Output>
|
2883
|
+
#
|
2884
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2885
|
+
#
|
2886
|
+
# @example Request syntax with placeholder values
|
2887
|
+
#
|
2888
|
+
# resp = client.list_component_outputs({
|
2889
|
+
# component_name: "ResourceName", # required
|
2890
|
+
# next_token: "EmptyNextToken",
|
2891
|
+
# })
|
2892
|
+
#
|
2893
|
+
# @example Response structure
|
2894
|
+
#
|
2895
|
+
# resp.next_token #=> String
|
2896
|
+
# resp.outputs #=> Array
|
2897
|
+
# resp.outputs[0].key #=> String
|
2898
|
+
# resp.outputs[0].value_string #=> String
|
2899
|
+
#
|
2900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentOutputs AWS API Documentation
|
2901
|
+
#
|
2902
|
+
# @overload list_component_outputs(params = {})
|
2903
|
+
# @param [Hash] params ({})
|
2904
|
+
def list_component_outputs(params = {}, options = {})
|
2905
|
+
req = build_request(:list_component_outputs, params)
|
2906
|
+
req.send_request(options)
|
2907
|
+
end
|
2908
|
+
|
2909
|
+
# List provisioned resources for a component with details.
|
2910
|
+
#
|
2911
|
+
# For more information about components, see [Proton components][1] in
|
2912
|
+
# the *Proton User Guide*.
|
2913
|
+
#
|
2914
|
+
#
|
2915
|
+
#
|
2916
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
2917
|
+
#
|
2918
|
+
# @option params [required, String] :component_name
|
2919
|
+
# The name of the component whose provisioned resources you want.
|
2920
|
+
#
|
2921
|
+
# @option params [String] :next_token
|
2922
|
+
# A token that indicates the location of the next provisioned resource
|
2923
|
+
# in the array of provisioned resources, after the list of provisioned
|
2924
|
+
# resources that was previously requested.
|
2925
|
+
#
|
2926
|
+
# @return [Types::ListComponentProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2927
|
+
#
|
2928
|
+
# * {Types::ListComponentProvisionedResourcesOutput#next_token #next_token} => String
|
2929
|
+
# * {Types::ListComponentProvisionedResourcesOutput#provisioned_resources #provisioned_resources} => Array<Types::ProvisionedResource>
|
2930
|
+
#
|
2931
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2932
|
+
#
|
2933
|
+
# @example Request syntax with placeholder values
|
2934
|
+
#
|
2935
|
+
# resp = client.list_component_provisioned_resources({
|
2936
|
+
# component_name: "ResourceName", # required
|
2937
|
+
# next_token: "EmptyNextToken",
|
2938
|
+
# })
|
2939
|
+
#
|
2940
|
+
# @example Response structure
|
2941
|
+
#
|
2942
|
+
# resp.next_token #=> String
|
2943
|
+
# resp.provisioned_resources #=> Array
|
2944
|
+
# resp.provisioned_resources[0].identifier #=> String
|
2945
|
+
# resp.provisioned_resources[0].name #=> String
|
2946
|
+
# resp.provisioned_resources[0].provisioning_engine #=> String, one of "CLOUDFORMATION", "TERRAFORM"
|
2947
|
+
#
|
2948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponentProvisionedResources AWS API Documentation
|
2949
|
+
#
|
2950
|
+
# @overload list_component_provisioned_resources(params = {})
|
2951
|
+
# @param [Hash] params ({})
|
2952
|
+
def list_component_provisioned_resources(params = {}, options = {})
|
2953
|
+
req = build_request(:list_component_provisioned_resources, params)
|
2954
|
+
req.send_request(options)
|
2955
|
+
end
|
2956
|
+
|
2957
|
+
# List components with summary data. You can filter the result list by
|
2958
|
+
# environment, service, or a single service instance.
|
2959
|
+
#
|
2960
|
+
# For more information about components, see [Proton components][1] in
|
2961
|
+
# the *Proton User Guide*.
|
2962
|
+
#
|
2963
|
+
#
|
2964
|
+
#
|
2965
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
2966
|
+
#
|
2967
|
+
# @option params [String] :environment_name
|
2968
|
+
# The name of an environment for result list filtering. Proton returns
|
2969
|
+
# components associated with the environment or attached to service
|
2970
|
+
# instances running in it.
|
2971
|
+
#
|
2972
|
+
# @option params [Integer] :max_results
|
2973
|
+
# The maximum number of components to list.
|
2974
|
+
#
|
2975
|
+
# @option params [String] :next_token
|
2976
|
+
# A token that indicates the location of the next component in the array
|
2977
|
+
# of components, after the list of components that was previously
|
2978
|
+
# requested.
|
2979
|
+
#
|
2980
|
+
# @option params [String] :service_instance_name
|
2981
|
+
# The name of a service instance for result list filtering. Proton
|
2982
|
+
# returns the component attached to the service instance, if any.
|
2983
|
+
#
|
2984
|
+
# @option params [String] :service_name
|
2985
|
+
# The name of a service for result list filtering. Proton returns
|
2986
|
+
# components attached to service instances of the service.
|
2987
|
+
#
|
2988
|
+
# @return [Types::ListComponentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2989
|
+
#
|
2990
|
+
# * {Types::ListComponentsOutput#components #components} => Array<Types::ComponentSummary>
|
2991
|
+
# * {Types::ListComponentsOutput#next_token #next_token} => String
|
2992
|
+
#
|
2993
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2994
|
+
#
|
2995
|
+
# @example Request syntax with placeholder values
|
2996
|
+
#
|
2997
|
+
# resp = client.list_components({
|
2998
|
+
# environment_name: "ResourceName",
|
2999
|
+
# max_results: 1,
|
3000
|
+
# next_token: "NextToken",
|
3001
|
+
# service_instance_name: "ResourceName",
|
3002
|
+
# service_name: "ResourceName",
|
3003
|
+
# })
|
3004
|
+
#
|
3005
|
+
# @example Response structure
|
3006
|
+
#
|
3007
|
+
# resp.components #=> Array
|
3008
|
+
# resp.components[0].arn #=> String
|
3009
|
+
# resp.components[0].created_at #=> Time
|
3010
|
+
# resp.components[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
3011
|
+
# resp.components[0].deployment_status_message #=> String
|
3012
|
+
# resp.components[0].environment_name #=> String
|
3013
|
+
# resp.components[0].last_deployment_attempted_at #=> Time
|
3014
|
+
# resp.components[0].last_deployment_succeeded_at #=> Time
|
3015
|
+
# resp.components[0].last_modified_at #=> Time
|
3016
|
+
# resp.components[0].name #=> String
|
3017
|
+
# resp.components[0].service_instance_name #=> String
|
3018
|
+
# resp.components[0].service_name #=> String
|
3019
|
+
# resp.next_token #=> String
|
3020
|
+
#
|
3021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListComponents AWS API Documentation
|
3022
|
+
#
|
3023
|
+
# @overload list_components(params = {})
|
3024
|
+
# @param [Hash] params ({})
|
3025
|
+
def list_components(params = {}, options = {})
|
3026
|
+
req = build_request(:list_components, params)
|
3027
|
+
req.send_request(options)
|
3028
|
+
end
|
3029
|
+
|
2531
3030
|
# View a list of environment account connections.
|
2532
3031
|
#
|
2533
3032
|
# For more information, see [Environment account connections][1] in the
|
2534
|
-
# *Proton
|
3033
|
+
# *Proton User guide*.
|
2535
3034
|
#
|
2536
3035
|
#
|
2537
3036
|
#
|
2538
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3037
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
2539
3038
|
#
|
2540
3039
|
# @option params [String] :environment_name
|
2541
3040
|
# The environment name that's associated with each listed environment
|
@@ -2577,6 +3076,7 @@ module Aws::Proton
|
|
2577
3076
|
#
|
2578
3077
|
# resp.environment_account_connections #=> Array
|
2579
3078
|
# resp.environment_account_connections[0].arn #=> String
|
3079
|
+
# resp.environment_account_connections[0].component_role_arn #=> String
|
2580
3080
|
# resp.environment_account_connections[0].environment_account_id #=> String
|
2581
3081
|
# resp.environment_account_connections[0].environment_name #=> String
|
2582
3082
|
# resp.environment_account_connections[0].id #=> String
|
@@ -2824,6 +3324,7 @@ module Aws::Proton
|
|
2824
3324
|
#
|
2825
3325
|
# resp.environments #=> Array
|
2826
3326
|
# resp.environments[0].arn #=> String
|
3327
|
+
# resp.environments[0].component_role_arn #=> String
|
2827
3328
|
# resp.environments[0].created_at #=> Time
|
2828
3329
|
# resp.environments[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2829
3330
|
# resp.environments[0].deployment_status_message #=> String
|
@@ -2849,7 +3350,7 @@ module Aws::Proton
|
|
2849
3350
|
req.send_request(options)
|
2850
3351
|
end
|
2851
3352
|
|
2852
|
-
# List repositories with detail data.
|
3353
|
+
# List linked repositories with detail data.
|
2853
3354
|
#
|
2854
3355
|
# @option params [Integer] :max_results
|
2855
3356
|
# The maximum number of repositories to list.
|
@@ -2940,18 +3441,17 @@ module Aws::Proton
|
|
2940
3441
|
req.send_request(options)
|
2941
3442
|
end
|
2942
3443
|
|
2943
|
-
#
|
2944
|
-
# detail data.
|
3444
|
+
# Get a list service of instance Infrastructure as Code (IaC) outputs.
|
2945
3445
|
#
|
2946
3446
|
# @option params [String] :next_token
|
2947
3447
|
# A token that indicates the location of the next output in the array of
|
2948
3448
|
# outputs, after the list of outputs that was previously requested.
|
2949
3449
|
#
|
2950
3450
|
# @option params [required, String] :service_instance_name
|
2951
|
-
# The service instance
|
3451
|
+
# The name of the service instance whose outputs you want.
|
2952
3452
|
#
|
2953
3453
|
# @option params [required, String] :service_name
|
2954
|
-
# The service
|
3454
|
+
# The name of the service that `serviceInstanceName` is associated to.
|
2955
3455
|
#
|
2956
3456
|
# @return [Types::ListServiceInstanceOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2957
3457
|
#
|
@@ -2992,10 +3492,10 @@ module Aws::Proton
|
|
2992
3492
|
# resources that was previously requested.
|
2993
3493
|
#
|
2994
3494
|
# @option params [required, String] :service_instance_name
|
2995
|
-
# The service instance
|
3495
|
+
# The name of the service instance whose provisioned resources you want.
|
2996
3496
|
#
|
2997
3497
|
# @option params [required, String] :service_name
|
2998
|
-
# The service
|
3498
|
+
# The name of the service that `serviceInstanceName` is associated to.
|
2999
3499
|
#
|
3000
3500
|
# @return [Types::ListServiceInstanceProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3001
3501
|
#
|
@@ -3029,7 +3529,7 @@ module Aws::Proton
|
|
3029
3529
|
req.send_request(options)
|
3030
3530
|
end
|
3031
3531
|
|
3032
|
-
# List service instances with
|
3532
|
+
# List service instances with summary data.
|
3033
3533
|
#
|
3034
3534
|
# @option params [Integer] :max_results
|
3035
3535
|
# The maximum number of service instances to list.
|
@@ -3083,15 +3583,14 @@ module Aws::Proton
|
|
3083
3583
|
req.send_request(options)
|
3084
3584
|
end
|
3085
3585
|
|
3086
|
-
#
|
3087
|
-
# detail.
|
3586
|
+
# Get a list of service pipeline Infrastructure as Code (IaC) outputs.
|
3088
3587
|
#
|
3089
3588
|
# @option params [String] :next_token
|
3090
3589
|
# A token that indicates the location of the next output in the array of
|
3091
3590
|
# outputs, after the list of outputs that was previously requested.
|
3092
3591
|
#
|
3093
3592
|
# @option params [required, String] :service_name
|
3094
|
-
# The service
|
3593
|
+
# The name of the service whose pipeline's outputs you want.
|
3095
3594
|
#
|
3096
3595
|
# @return [Types::ListServicePipelineOutputsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3097
3596
|
#
|
@@ -3131,7 +3630,8 @@ module Aws::Proton
|
|
3131
3630
|
# resources that was previously requested.
|
3132
3631
|
#
|
3133
3632
|
# @option params [required, String] :service_name
|
3134
|
-
# The service
|
3633
|
+
# The name of the service whose pipeline's provisioned resources you
|
3634
|
+
# want.
|
3135
3635
|
#
|
3136
3636
|
# @return [Types::ListServicePipelineProvisionedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3137
3637
|
#
|
@@ -3316,14 +3816,12 @@ module Aws::Proton
|
|
3316
3816
|
req.send_request(options)
|
3317
3817
|
end
|
3318
3818
|
|
3319
|
-
# List tags for a resource. For more information, see
|
3320
|
-
# and tagging
|
3321
|
-
# Guide][2].
|
3819
|
+
# List tags for a resource. For more information, see [Proton resources
|
3820
|
+
# and tagging][1] in the *Proton User Guide*.
|
3322
3821
|
#
|
3323
3822
|
#
|
3324
3823
|
#
|
3325
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3326
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
3824
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
3327
3825
|
#
|
3328
3826
|
# @option params [Integer] :max_results
|
3329
3827
|
# The maximum number of tags to list.
|
@@ -3371,11 +3869,11 @@ module Aws::Proton
|
|
3371
3869
|
# self-managed provisioning.
|
3372
3870
|
#
|
3373
3871
|
# For more information, see [Self-managed provisioning][1] in the
|
3374
|
-
# *Proton
|
3872
|
+
# *Proton User Guide*.
|
3375
3873
|
#
|
3376
3874
|
#
|
3377
3875
|
#
|
3378
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3876
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self
|
3379
3877
|
#
|
3380
3878
|
# @option params [String] :deployment_id
|
3381
3879
|
# The deployment ID for your provisioned resource.
|
@@ -3407,7 +3905,7 @@ module Aws::Proton
|
|
3407
3905
|
# ],
|
3408
3906
|
# resource_arn: "Arn", # required
|
3409
3907
|
# status: "IN_PROGRESS", # required, accepts IN_PROGRESS, FAILED, SUCCEEDED
|
3410
|
-
# status_message: "
|
3908
|
+
# status_message: "NotifyResourceDeploymentStatusChangeInputStatusMessageString",
|
3411
3909
|
# })
|
3412
3910
|
#
|
3413
3911
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/NotifyResourceDeploymentStatusChange AWS API Documentation
|
@@ -3429,11 +3927,11 @@ module Aws::Proton
|
|
3429
3927
|
# to an environment.
|
3430
3928
|
#
|
3431
3929
|
# For more information, see [Environment account connections][1] in the
|
3432
|
-
# *Proton
|
3930
|
+
# *Proton User guide*.
|
3433
3931
|
#
|
3434
3932
|
#
|
3435
3933
|
#
|
3436
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3934
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
3437
3935
|
#
|
3438
3936
|
# @option params [required, String] :id
|
3439
3937
|
# The ID of the environment account connection to reject.
|
@@ -3451,6 +3949,7 @@ module Aws::Proton
|
|
3451
3949
|
# @example Response structure
|
3452
3950
|
#
|
3453
3951
|
# resp.environment_account_connection.arn #=> String
|
3952
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
3454
3953
|
# resp.environment_account_connection.environment_account_id #=> String
|
3455
3954
|
# resp.environment_account_connection.environment_name #=> String
|
3456
3955
|
# resp.environment_account_connection.id #=> String
|
@@ -3472,13 +3971,12 @@ module Aws::Proton
|
|
3472
3971
|
# Tag a resource. A tag is a key-value pair of metadata that you
|
3473
3972
|
# associate with an Proton resource.
|
3474
3973
|
#
|
3475
|
-
# For more information, see
|
3476
|
-
#
|
3974
|
+
# For more information, see [Proton resources and tagging][1] in the
|
3975
|
+
# *Proton User Guide*.
|
3477
3976
|
#
|
3478
3977
|
#
|
3479
3978
|
#
|
3480
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3481
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
3979
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
3482
3980
|
#
|
3483
3981
|
# @option params [required, String] :resource_arn
|
3484
3982
|
# The Amazon Resource Name (ARN) of the Proton resource to apply
|
@@ -3513,13 +4011,12 @@ module Aws::Proton
|
|
3513
4011
|
# Remove a customer tag from a resource. A tag is a key-value pair of
|
3514
4012
|
# metadata associated with an Proton resource.
|
3515
4013
|
#
|
3516
|
-
# For more information, see
|
3517
|
-
#
|
4014
|
+
# For more information, see [Proton resources and tagging][1] in the
|
4015
|
+
# *Proton User Guide*.
|
3518
4016
|
#
|
3519
4017
|
#
|
3520
4018
|
#
|
3521
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3522
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
4019
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
3523
4020
|
#
|
3524
4021
|
# @option params [required, String] :resource_arn
|
3525
4022
|
# The Amazon Resource Name (ARN) of the resource to remove customer tags
|
@@ -3547,12 +4044,24 @@ module Aws::Proton
|
|
3547
4044
|
req.send_request(options)
|
3548
4045
|
end
|
3549
4046
|
|
3550
|
-
# Update
|
4047
|
+
# Update Proton settings that are used for multiple services in the
|
4048
|
+
# Amazon Web Services account.
|
4049
|
+
#
|
4050
|
+
# @option params [Boolean] :delete_pipeline_provisioning_repository
|
4051
|
+
# Set to `true` to remove a configured pipeline repository from the
|
4052
|
+
# account settings. Don't set this field if you are updating the
|
4053
|
+
# configured pipeline repository.
|
3551
4054
|
#
|
3552
4055
|
# @option params [Types::RepositoryBranchInput] :pipeline_provisioning_repository
|
3553
|
-
# A repository for pipeline provisioning. Specify it if you have
|
4056
|
+
# A linked repository for pipeline provisioning. Specify it if you have
|
3554
4057
|
# environments configured for self-managed provisioning with services
|
3555
|
-
# that include pipelines.
|
4058
|
+
# that include pipelines. A linked repository is a repository that has
|
4059
|
+
# been registered with Proton. For more information, see
|
4060
|
+
# CreateRepository.
|
4061
|
+
#
|
4062
|
+
# To remove a previously configured repository, set
|
4063
|
+
# `deletePipelineProvisioningRepository` to `true`, and don't set
|
4064
|
+
# `pipelineProvisioningRepository`.
|
3556
4065
|
#
|
3557
4066
|
# @option params [String] :pipeline_service_role_arn
|
3558
4067
|
# The Amazon Resource Name (ARN) of the service role you want to use for
|
@@ -3560,6 +4069,8 @@ module Aws::Proton
|
|
3560
4069
|
# Services-managed provisioning, and by customer-owned automation for
|
3561
4070
|
# self-managed provisioning.
|
3562
4071
|
#
|
4072
|
+
# To remove a previously configured ARN, specify an empty string.
|
4073
|
+
#
|
3563
4074
|
# @return [Types::UpdateAccountSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3564
4075
|
#
|
3565
4076
|
# * {Types::UpdateAccountSettingsOutput#account_settings #account_settings} => Types::AccountSettings
|
@@ -3567,6 +4078,7 @@ module Aws::Proton
|
|
3567
4078
|
# @example Request syntax with placeholder values
|
3568
4079
|
#
|
3569
4080
|
# resp = client.update_account_settings({
|
4081
|
+
# delete_pipeline_provisioning_repository: false,
|
3570
4082
|
# pipeline_provisioning_repository: {
|
3571
4083
|
# branch: "GitBranchName", # required
|
3572
4084
|
# name: "RepositoryName", # required
|
@@ -3592,6 +4104,120 @@ module Aws::Proton
|
|
3592
4104
|
req.send_request(options)
|
3593
4105
|
end
|
3594
4106
|
|
4107
|
+
# Update a component.
|
4108
|
+
#
|
4109
|
+
# There are a few modes for updating a component. The `deploymentType`
|
4110
|
+
# field defines the mode.
|
4111
|
+
#
|
4112
|
+
# <note markdown="1"> You can't update a component while its deployment status, or the
|
4113
|
+
# deployment status of a service instance attached to it, is
|
4114
|
+
# `IN_PROGRESS`.
|
4115
|
+
#
|
4116
|
+
# </note>
|
4117
|
+
#
|
4118
|
+
# For more information about components, see [Proton components][1] in
|
4119
|
+
# the *Proton User Guide*.
|
4120
|
+
#
|
4121
|
+
#
|
4122
|
+
#
|
4123
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
4124
|
+
#
|
4125
|
+
# @option params [required, String] :deployment_type
|
4126
|
+
# The deployment type. It defines the mode for updating a component, as
|
4127
|
+
# follows:
|
4128
|
+
#
|
4129
|
+
#
|
4130
|
+
#
|
4131
|
+
# : `NONE`
|
4132
|
+
#
|
4133
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
4134
|
+
# metadata parameters are updated. You can only specify `description`
|
4135
|
+
# in this mode.
|
4136
|
+
#
|
4137
|
+
#
|
4138
|
+
#
|
4139
|
+
# : `CURRENT_VERSION`
|
4140
|
+
#
|
4141
|
+
# In this mode, the component is deployed and updated with the new
|
4142
|
+
# `serviceSpec`, `templateSource`, and/or `type` that you provide.
|
4143
|
+
# Only requested parameters are updated.
|
4144
|
+
#
|
4145
|
+
# @option params [String] :description
|
4146
|
+
# An optional customer-provided description of the component.
|
4147
|
+
#
|
4148
|
+
# @option params [required, String] :name
|
4149
|
+
# The name of the component to update.
|
4150
|
+
#
|
4151
|
+
# @option params [String] :service_instance_name
|
4152
|
+
# The name of the service instance that you want to attach this
|
4153
|
+
# component to. Don't specify to keep the component's current service
|
4154
|
+
# instance attachment. Specify an empty string to detach the component
|
4155
|
+
# from the service instance it's attached to. Specify non-empty values
|
4156
|
+
# for both `serviceInstanceName` and `serviceName` or for neither of
|
4157
|
+
# them.
|
4158
|
+
#
|
4159
|
+
# @option params [String] :service_name
|
4160
|
+
# The name of the service that `serviceInstanceName` is associated with.
|
4161
|
+
# Don't specify to keep the component's current service instance
|
4162
|
+
# attachment. Specify an empty string to detach the component from the
|
4163
|
+
# service instance it's attached to. Specify non-empty values for both
|
4164
|
+
# `serviceInstanceName` and `serviceName` or for neither of them.
|
4165
|
+
#
|
4166
|
+
# @option params [String] :service_spec
|
4167
|
+
# The service spec that you want the component to use to access service
|
4168
|
+
# inputs. Set this only when the component is attached to a service
|
4169
|
+
# instance.
|
4170
|
+
#
|
4171
|
+
# @option params [String] :template_file
|
4172
|
+
# A path to the Infrastructure as Code (IaC) file describing
|
4173
|
+
# infrastructure that a custom component provisions.
|
4174
|
+
#
|
4175
|
+
# <note markdown="1"> Components support a single IaC file, even if you use Terraform as
|
4176
|
+
# your template language.
|
4177
|
+
#
|
4178
|
+
# </note>
|
4179
|
+
#
|
4180
|
+
# @return [Types::UpdateComponentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4181
|
+
#
|
4182
|
+
# * {Types::UpdateComponentOutput#component #component} => Types::Component
|
4183
|
+
#
|
4184
|
+
# @example Request syntax with placeholder values
|
4185
|
+
#
|
4186
|
+
# resp = client.update_component({
|
4187
|
+
# deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION
|
4188
|
+
# description: "Description",
|
4189
|
+
# name: "ResourceName", # required
|
4190
|
+
# service_instance_name: "ResourceNameOrEmpty",
|
4191
|
+
# service_name: "ResourceNameOrEmpty",
|
4192
|
+
# service_spec: "SpecContents",
|
4193
|
+
# template_file: "TemplateFileContents",
|
4194
|
+
# })
|
4195
|
+
#
|
4196
|
+
# @example Response structure
|
4197
|
+
#
|
4198
|
+
# resp.component.arn #=> String
|
4199
|
+
# resp.component.created_at #=> Time
|
4200
|
+
# resp.component.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
4201
|
+
# resp.component.deployment_status_message #=> String
|
4202
|
+
# resp.component.description #=> String
|
4203
|
+
# resp.component.environment_name #=> String
|
4204
|
+
# resp.component.last_deployment_attempted_at #=> Time
|
4205
|
+
# resp.component.last_deployment_succeeded_at #=> Time
|
4206
|
+
# resp.component.last_modified_at #=> Time
|
4207
|
+
# resp.component.name #=> String
|
4208
|
+
# resp.component.service_instance_name #=> String
|
4209
|
+
# resp.component.service_name #=> String
|
4210
|
+
# resp.component.service_spec #=> String
|
4211
|
+
#
|
4212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateComponent AWS API Documentation
|
4213
|
+
#
|
4214
|
+
# @overload update_component(params = {})
|
4215
|
+
# @param [Hash] params ({})
|
4216
|
+
def update_component(params = {}, options = {})
|
4217
|
+
req = build_request(:update_component, params)
|
4218
|
+
req.send_request(options)
|
4219
|
+
end
|
4220
|
+
|
3595
4221
|
# Update an environment.
|
3596
4222
|
#
|
3597
4223
|
# If the environment is associated with an environment account
|
@@ -3622,7 +4248,7 @@ module Aws::Proton
|
|
3622
4248
|
# parameters.
|
3623
4249
|
#
|
3624
4250
|
# For more information, see [Environments][1] and [Provisioning
|
3625
|
-
# methods][2] in the *Proton
|
4251
|
+
# methods][2] in the *Proton User Guide*.
|
3626
4252
|
#
|
3627
4253
|
# There are four modes for updating an environment. The `deploymentType`
|
3628
4254
|
# field defines the mode.
|
@@ -3664,8 +4290,24 @@ module Aws::Proton
|
|
3664
4290
|
#
|
3665
4291
|
#
|
3666
4292
|
#
|
3667
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3668
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/
|
4293
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html
|
4294
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html
|
4295
|
+
#
|
4296
|
+
# @option params [String] :component_role_arn
|
4297
|
+
# The Amazon Resource Name (ARN) of the IAM service role that Proton
|
4298
|
+
# uses when provisioning directly defined components in this
|
4299
|
+
# environment. It determines the scope of infrastructure that a
|
4300
|
+
# component can provision.
|
4301
|
+
#
|
4302
|
+
# The environment must have a `componentRoleArn` to allow directly
|
4303
|
+
# defined components to be associated with the environment.
|
4304
|
+
#
|
4305
|
+
# For more information about components, see [Proton components][1] in
|
4306
|
+
# the *Proton User Guide*.
|
4307
|
+
#
|
4308
|
+
#
|
4309
|
+
#
|
4310
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
3669
4311
|
#
|
3670
4312
|
# @option params [required, String] :deployment_type
|
3671
4313
|
# There are four modes for updating an environment. The `deploymentType`
|
@@ -3725,8 +4367,10 @@ module Aws::Proton
|
|
3725
4367
|
# Proton to make API calls to other services your behalf.
|
3726
4368
|
#
|
3727
4369
|
# @option params [Types::RepositoryBranchInput] :provisioning_repository
|
3728
|
-
# The
|
3729
|
-
# infrastructure templates for self-managed provisioning.
|
4370
|
+
# The linked repository that you use to host your rendered
|
4371
|
+
# infrastructure templates for self-managed provisioning. A linked
|
4372
|
+
# repository is a repository that has been registered with Proton. For
|
4373
|
+
# more information, see CreateRepository.
|
3730
4374
|
#
|
3731
4375
|
# @option params [String] :spec
|
3732
4376
|
# The formatted specification that defines the update.
|
@@ -3744,6 +4388,7 @@ module Aws::Proton
|
|
3744
4388
|
# @example Request syntax with placeholder values
|
3745
4389
|
#
|
3746
4390
|
# resp = client.update_environment({
|
4391
|
+
# component_role_arn: "Arn",
|
3747
4392
|
# deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
|
3748
4393
|
# description: "Description",
|
3749
4394
|
# environment_account_connection_id: "EnvironmentAccountConnectionId",
|
@@ -3762,6 +4407,7 @@ module Aws::Proton
|
|
3762
4407
|
# @example Response structure
|
3763
4408
|
#
|
3764
4409
|
# resp.environment.arn #=> String
|
4410
|
+
# resp.environment.component_role_arn #=> String
|
3765
4411
|
# resp.environment.created_at #=> Time
|
3766
4412
|
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
3767
4413
|
# resp.environment.deployment_status_message #=> String
|
@@ -3795,16 +4441,33 @@ module Aws::Proton
|
|
3795
4441
|
# use a new IAM role.
|
3796
4442
|
#
|
3797
4443
|
# For more information, see [Environment account connections][1] in the
|
3798
|
-
# *Proton
|
4444
|
+
# *Proton User guide*.
|
4445
|
+
#
|
4446
|
+
#
|
4447
|
+
#
|
4448
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html
|
4449
|
+
#
|
4450
|
+
# @option params [String] :component_role_arn
|
4451
|
+
# The Amazon Resource Name (ARN) of the IAM service role that Proton
|
4452
|
+
# uses when provisioning directly defined components in the associated
|
4453
|
+
# environment account. It determines the scope of infrastructure that a
|
4454
|
+
# component can provision in the account.
|
3799
4455
|
#
|
4456
|
+
# The environment account connection must have a `componentRoleArn` to
|
4457
|
+
# allow directly defined components to be associated with any
|
4458
|
+
# environments running in the account.
|
3800
4459
|
#
|
4460
|
+
# For more information about components, see [Proton components][1] in
|
4461
|
+
# the *Proton User Guide*.
|
3801
4462
|
#
|
3802
|
-
#
|
4463
|
+
#
|
4464
|
+
#
|
4465
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
3803
4466
|
#
|
3804
4467
|
# @option params [required, String] :id
|
3805
4468
|
# The ID of the environment account connection to update.
|
3806
4469
|
#
|
3807
|
-
# @option params [
|
4470
|
+
# @option params [String] :role_arn
|
3808
4471
|
# The Amazon Resource Name (ARN) of the IAM service role that's
|
3809
4472
|
# associated with the environment account connection to update.
|
3810
4473
|
#
|
@@ -3815,13 +4478,15 @@ module Aws::Proton
|
|
3815
4478
|
# @example Request syntax with placeholder values
|
3816
4479
|
#
|
3817
4480
|
# resp = client.update_environment_account_connection({
|
4481
|
+
# component_role_arn: "Arn",
|
3818
4482
|
# id: "EnvironmentAccountConnectionId", # required
|
3819
|
-
# role_arn: "Arn",
|
4483
|
+
# role_arn: "Arn",
|
3820
4484
|
# })
|
3821
4485
|
#
|
3822
4486
|
# @example Response structure
|
3823
4487
|
#
|
3824
4488
|
# resp.environment_account_connection.arn #=> String
|
4489
|
+
# resp.environment_account_connection.component_role_arn #=> String
|
3825
4490
|
# resp.environment_account_connection.environment_account_id #=> String
|
3826
4491
|
# resp.environment_account_connection.environment_name #=> String
|
3827
4492
|
# resp.environment_account_connection.id #=> String
|
@@ -3953,6 +4618,18 @@ module Aws::Proton
|
|
3953
4618
|
#
|
3954
4619
|
# Edit the `spec` parameter to add or delete instances.
|
3955
4620
|
#
|
4621
|
+
# <note markdown="1"> You can't delete a service instance (remove it from the spec) if it
|
4622
|
+
# has an attached component.
|
4623
|
+
#
|
4624
|
+
# For more information about components, see [Proton components][1] in
|
4625
|
+
# the *Proton User Guide*.
|
4626
|
+
#
|
4627
|
+
# </note>
|
4628
|
+
#
|
4629
|
+
#
|
4630
|
+
#
|
4631
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
4632
|
+
#
|
3956
4633
|
# @option params [String] :description
|
3957
4634
|
# The edited service description.
|
3958
4635
|
#
|
@@ -3963,13 +4640,12 @@ module Aws::Proton
|
|
3963
4640
|
# Lists the service instances to add and the existing service instances
|
3964
4641
|
# to remain. Omit the existing service instances to delete from the
|
3965
4642
|
# list. *Don't* include edits to the existing service instances or
|
3966
|
-
# pipeline. For more information, see
|
3967
|
-
#
|
4643
|
+
# pipeline. For more information, see [Edit a service][1] in the *Proton
|
4644
|
+
# User Guide*.
|
3968
4645
|
#
|
3969
4646
|
#
|
3970
4647
|
#
|
3971
|
-
# [1]: https://docs.aws.amazon.com/proton/latest/
|
3972
|
-
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html
|
4648
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html
|
3973
4649
|
#
|
3974
4650
|
# @return [Types::UpdateServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3975
4651
|
#
|
@@ -4019,49 +4695,24 @@ module Aws::Proton
|
|
4019
4695
|
|
4020
4696
|
# Update a service instance.
|
4021
4697
|
#
|
4022
|
-
# There are
|
4698
|
+
# There are a few modes for updating a service instance. The
|
4023
4699
|
# `deploymentType` field defines the mode.
|
4024
4700
|
#
|
4701
|
+
# <note markdown="1"> You can't update a service instance while its deployment status, or
|
4702
|
+
# the deployment status of a component attached to it, is `IN_PROGRESS`.
|
4025
4703
|
#
|
4704
|
+
# For more information about components, see [Proton components][1] in
|
4705
|
+
# the *Proton User Guide*.
|
4026
4706
|
#
|
4027
|
-
#
|
4028
|
-
#
|
4029
|
-
# In this mode, a deployment *doesn't* occur. Only the requested
|
4030
|
-
# metadata parameters are updated.
|
4031
|
-
#
|
4032
|
-
#
|
4033
|
-
#
|
4034
|
-
# : `CURRENT_VERSION`
|
4035
|
-
#
|
4036
|
-
# In this mode, the service instance is deployed and updated with the
|
4037
|
-
# new spec that you provide. Only requested parameters are updated.
|
4038
|
-
# *Don’t* include minor or major version parameters when you use this
|
4039
|
-
# `deployment-type`.
|
4040
|
-
#
|
4041
|
-
#
|
4042
|
-
#
|
4043
|
-
# : `MINOR_VERSION`
|
4044
|
-
#
|
4045
|
-
# In this mode, the service instance is deployed and updated with the
|
4046
|
-
# published, recommended (latest) minor version of the current major
|
4047
|
-
# version in use, by default. You can also specify a different minor
|
4048
|
-
# version of the current major version in use.
|
4049
|
-
#
|
4707
|
+
# </note>
|
4050
4708
|
#
|
4051
4709
|
#
|
4052
|
-
# : `MAJOR_VERSION`
|
4053
4710
|
#
|
4054
|
-
#
|
4055
|
-
# published, recommended (latest) major and minor version of the
|
4056
|
-
# current template, by default. You can also specify a different major
|
4057
|
-
# version that's higher than the major version in use and a minor
|
4058
|
-
# version.
|
4711
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
4059
4712
|
#
|
4060
4713
|
# @option params [required, String] :deployment_type
|
4061
|
-
# The deployment type.
|
4062
|
-
#
|
4063
|
-
# There are four modes for updating a service instance. The
|
4064
|
-
# `deploymentType` field defines the mode.
|
4714
|
+
# The deployment type. It defines the mode for updating a service
|
4715
|
+
# instance, as follows:
|
4065
4716
|
#
|
4066
4717
|
#
|
4067
4718
|
#
|
@@ -4077,7 +4728,7 @@ module Aws::Proton
|
|
4077
4728
|
# In this mode, the service instance is deployed and updated with the
|
4078
4729
|
# new spec that you provide. Only requested parameters are updated.
|
4079
4730
|
# *Don’t* include major or minor version parameters when you use this
|
4080
|
-
#
|
4731
|
+
# deployment type.
|
4081
4732
|
#
|
4082
4733
|
#
|
4083
4734
|
#
|
@@ -4332,8 +4983,10 @@ module Aws::Proton
|
|
4332
4983
|
# Update a major or minor version of a service template.
|
4333
4984
|
#
|
4334
4985
|
# @option params [Array<Types::CompatibleEnvironmentTemplateInput>] :compatible_environment_templates
|
4335
|
-
# An array of
|
4336
|
-
#
|
4986
|
+
# An array of environment template objects that are compatible with this
|
4987
|
+
# service template version. A service instance based on this service
|
4988
|
+
# template version can run in environments based on compatible
|
4989
|
+
# templates.
|
4337
4990
|
#
|
4338
4991
|
# @option params [String] :description
|
4339
4992
|
# A description of a service template version to update.
|
@@ -4349,6 +5002,24 @@ module Aws::Proton
|
|
4349
5002
|
# @option params [String] :status
|
4350
5003
|
# The status of the service template minor version to update.
|
4351
5004
|
#
|
5005
|
+
# @option params [Array<String>] :supported_component_sources
|
5006
|
+
# An array of supported component sources. Components with supported
|
5007
|
+
# sources can be attached to service instances based on this service
|
5008
|
+
# template version.
|
5009
|
+
#
|
5010
|
+
# <note markdown="1"> A change to `supportedComponentSources` doesn't impact existing
|
5011
|
+
# component attachments to instances based on this template version. A
|
5012
|
+
# change only affects later associations.
|
5013
|
+
#
|
5014
|
+
# </note>
|
5015
|
+
#
|
5016
|
+
# For more information about components, see [Proton components][1] in
|
5017
|
+
# the *Proton User Guide*.
|
5018
|
+
#
|
5019
|
+
#
|
5020
|
+
#
|
5021
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html
|
5022
|
+
#
|
4352
5023
|
# @option params [required, String] :template_name
|
4353
5024
|
# The name of the service template.
|
4354
5025
|
#
|
@@ -4369,6 +5040,7 @@ module Aws::Proton
|
|
4369
5040
|
# major_version: "TemplateVersionPart", # required
|
4370
5041
|
# minor_version: "TemplateVersionPart", # required
|
4371
5042
|
# status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
|
5043
|
+
# supported_component_sources: ["DIRECTLY_DEFINED"], # accepts DIRECTLY_DEFINED
|
4372
5044
|
# template_name: "ResourceName", # required
|
4373
5045
|
# })
|
4374
5046
|
#
|
@@ -4387,6 +5059,8 @@ module Aws::Proton
|
|
4387
5059
|
# resp.service_template_version.schema #=> String
|
4388
5060
|
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
4389
5061
|
# resp.service_template_version.status_message #=> String
|
5062
|
+
# resp.service_template_version.supported_component_sources #=> Array
|
5063
|
+
# resp.service_template_version.supported_component_sources[0] #=> String, one of "DIRECTLY_DEFINED"
|
4390
5064
|
# resp.service_template_version.template_name #=> String
|
4391
5065
|
#
|
4392
5066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersion AWS API Documentation
|
@@ -4399,13 +5073,16 @@ module Aws::Proton
|
|
4399
5073
|
end
|
4400
5074
|
|
4401
5075
|
# Update template sync configuration parameters, except for the
|
4402
|
-
# `templateName` and `templateType`.
|
5076
|
+
# `templateName` and `templateType`. Repository details (branch, name,
|
5077
|
+
# and provider) should be of a linked repository. A linked repository is
|
5078
|
+
# a repository that has been registered with Proton. For more
|
5079
|
+
# information, see CreateRepository.
|
4403
5080
|
#
|
4404
5081
|
# @option params [required, String] :branch
|
4405
|
-
# The repository branch.
|
5082
|
+
# The repository branch for your template.
|
4406
5083
|
#
|
4407
5084
|
# @option params [required, String] :repository_name
|
4408
|
-
# The name
|
5085
|
+
# The repository name (for example, `myrepos/myrepo`).
|
4409
5086
|
#
|
4410
5087
|
# @option params [required, String] :repository_provider
|
4411
5088
|
# The repository provider.
|
@@ -4466,7 +5143,7 @@ module Aws::Proton
|
|
4466
5143
|
params: params,
|
4467
5144
|
config: config)
|
4468
5145
|
context[:gem_name] = 'aws-sdk-proton'
|
4469
|
-
context[:gem_version] = '1.
|
5146
|
+
context[:gem_version] = '1.17.0'
|
4470
5147
|
Seahorse::Client::Request.new(handlers, context)
|
4471
5148
|
end
|
4472
5149
|
|
@@ -4534,6 +5211,8 @@ module Aws::Proton
|
|
4534
5211
|
#
|
4535
5212
|
# | waiter_name | params | :delay | :max_attempts |
|
4536
5213
|
# | --------------------------------------- | ----------------------------------------- | -------- | ------------- |
|
5214
|
+
# | component_deleted | {Client#get_component} | 5 | 999 |
|
5215
|
+
# | component_deployed | {Client#get_component} | 5 | 999 |
|
4537
5216
|
# | environment_deployed | {Client#get_environment} | 5 | 999 |
|
4538
5217
|
# | environment_template_version_registered | {Client#get_environment_template_version} | 2 | 150 |
|
4539
5218
|
# | service_created | {Client#get_service} | 5 | 999 |
|
@@ -4592,6 +5271,8 @@ module Aws::Proton
|
|
4592
5271
|
|
4593
5272
|
def waiters
|
4594
5273
|
{
|
5274
|
+
component_deleted: Waiters::ComponentDeleted,
|
5275
|
+
component_deployed: Waiters::ComponentDeployed,
|
4595
5276
|
environment_deployed: Waiters::EnvironmentDeployed,
|
4596
5277
|
environment_template_version_registered: Waiters::EnvironmentTemplateVersionRegistered,
|
4597
5278
|
service_created: Waiters::ServiceCreated,
|