aws-sdk-elasticbeanstalk 1.27.0 → 1.32.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 414b399834661d392021ca069c084455bf5dd98a
4
- data.tar.gz: bd8469057503233c553cb9bec4f8f903f376cdc6
2
+ SHA256:
3
+ metadata.gz: 7584c15a6c555d110745ffc38afa01602d9428f73277b3a99c3c2005b27a309d
4
+ data.tar.gz: c39425e3a76f6aff6014174c5a41ac282e84a2094eaf2df8e5bc0ae1f1ed818c
5
5
  SHA512:
6
- metadata.gz: 8806dcfb5a079346df5b3b629f9a4f37a9d6f75f226053dc73d87326cc3faaf5ac154ec6fe99eb9e52497dc2f2c273b9b27e9779477af0cafe637f1f6299b38d
7
- data.tar.gz: 8c78386ef6c2aea4b994f074f68645bde35ff14141c06d00c6286f1fa457443c6c10174e3272668e3d95baec4a7e190b8ebf95da63436fb3511e8c498fdbc6c0
6
+ metadata.gz: b49a9b8c3e812475beef435b79e52e21c595996802c2856d2cb1efe3791385d073e8ffec0c8630a03a64d9e806643bd2d490f4d4e83a7a39f84d151ec7a77fcb
7
+ data.tar.gz: c62f9afd142aadff51a30271188237ba48a3f4aa71fbe39ec9f906cc07a127c0368b97c986e69ed438b829febb5ed755971878b4be9517f5441246d9cd1943da
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
45
45
  # @service
46
46
  module Aws::ElasticBeanstalk
47
47
 
48
- GEM_VERSION = '1.27.0'
48
+ GEM_VERSION = '1.32.1'
49
49
 
50
50
  end
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/query.rb'
29
30
 
@@ -32,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:elasticbeanstalk)
32
33
  module Aws::ElasticBeanstalk
33
34
  # An API client for ElasticBeanstalk. To construct a client, you need to configure a `:region` and `:credentials`.
34
35
  #
35
- # client = Aws::ElasticBeanstalk::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
36
+ # client = Aws::ElasticBeanstalk::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
40
41
  #
41
42
  # For details on configuring region and credentials see
42
43
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -69,6 +70,7 @@ module Aws::ElasticBeanstalk
69
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
72
74
  add_plugin(Aws::Plugins::SignatureV4)
73
75
  add_plugin(Aws::Plugins::Protocols::Query)
74
76
 
@@ -105,7 +107,7 @@ module Aws::ElasticBeanstalk
105
107
  # @option options [required, String] :region
106
108
  # The AWS region to connect to. The configured `:region` is
107
109
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
109
111
  #
110
112
  # * `Aws.config[:region]`
111
113
  # * `ENV['AWS_REGION']`
@@ -161,7 +163,7 @@ module Aws::ElasticBeanstalk
161
163
  # @option options [String] :endpoint
162
164
  # The client endpoint is normally constructed from the `:region`
163
165
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
167
  #
166
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +178,7 @@ module Aws::ElasticBeanstalk
176
178
  # requests fetching endpoints information. Defaults to 60 sec.
177
179
  #
178
180
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
182
  #
181
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
184
  # The log formatter.
@@ -229,15 +231,19 @@ module Aws::ElasticBeanstalk
229
231
  #
230
232
  # @option options [String] :retry_mode ("legacy")
231
233
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
241
247
  #
242
248
  # @option options [String] :secret_access_key
243
249
  #
@@ -265,8 +271,7 @@ module Aws::ElasticBeanstalk
265
271
  #
266
272
  # @option options [Integer] :http_read_timeout (60) The default
267
273
  # number of seconds to wait for response data. This value can
268
- # safely be set
269
- # per-request on the session yielded by {#session_for}.
274
+ # safely be set per-request on the session.
270
275
  #
271
276
  # @option options [Float] :http_idle_timeout (5) The number of
272
277
  # seconds a connection is allowed to sit idle before it is
@@ -278,7 +283,7 @@ module Aws::ElasticBeanstalk
278
283
  # request body. This option has no effect unless the request has
279
284
  # "Expect" header set to "100-continue". Defaults to `nil` which
280
285
  # disables this behaviour. This value can safely be set per
281
- # request on the session yielded by {#session_for}.
286
+ # request on the session.
282
287
  #
283
288
  # @option options [Boolean] :http_wire_trace (false) When `true`,
284
289
  # HTTP debug output will be sent to the `:logger`.
@@ -387,6 +392,41 @@ module Aws::ElasticBeanstalk
387
392
  req.send_request(options)
388
393
  end
389
394
 
395
+ # Add or change the operations role used by an environment. After this
396
+ # call is made, Elastic Beanstalk uses the associated operations role
397
+ # for permissions to downstream services during subsequent calls acting
398
+ # on this environment. For more information, see [Operations roles][1]
399
+ # in the *AWS Elastic Beanstalk Developer Guide*.
400
+ #
401
+ #
402
+ #
403
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
404
+ #
405
+ # @option params [required, String] :environment_name
406
+ # The name of the environment to which to set the operations role.
407
+ #
408
+ # @option params [required, String] :operations_role
409
+ # The Amazon Resource Name (ARN) of an existing IAM role to be used as
410
+ # the environment's operations role.
411
+ #
412
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
413
+ #
414
+ # @example Request syntax with placeholder values
415
+ #
416
+ # resp = client.associate_environment_operations_role({
417
+ # environment_name: "EnvironmentName", # required
418
+ # operations_role: "OperationsRole", # required
419
+ # })
420
+ #
421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/AssociateEnvironmentOperationsRole AWS API Documentation
422
+ #
423
+ # @overload associate_environment_operations_role(params = {})
424
+ # @param [Hash] params ({})
425
+ def associate_environment_operations_role(params = {}, options = {})
426
+ req = build_request(:associate_environment_operations_role, params)
427
+ req.send_request(options)
428
+ end
429
+
390
430
  # Checks if the specified CNAME is available.
391
431
  #
392
432
  # @option params [required, String] :cname_prefix
@@ -508,6 +548,7 @@ module Aws::ElasticBeanstalk
508
548
  # resp.environments[0].environment_links[0].link_name #=> String
509
549
  # resp.environments[0].environment_links[0].environment_name #=> String
510
550
  # resp.environments[0].environment_arn #=> String
551
+ # resp.environments[0].operations_role #=> String
511
552
  # resp.next_token #=> String
512
553
  #
513
554
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ComposeEnvironments AWS API Documentation
@@ -523,17 +564,13 @@ module Aws::ElasticBeanstalk
523
564
  # `default` and no application versions.
524
565
  #
525
566
  # @option params [required, String] :application_name
526
- # The name of the application.
527
- #
528
- # Constraint: This name must be unique within your account. If the
529
- # specified name already exists, the action returns an
530
- # `InvalidParameterValue` error.
567
+ # The name of the application. Must be unique within your account.
531
568
  #
532
569
  # @option params [String] :description
533
- # Describes the application.
570
+ # Your description of the application.
534
571
  #
535
572
  # @option params [Types::ApplicationResourceLifecycleConfig] :resource_lifecycle_config
536
- # Specify an application resource lifecycle configuration to prevent
573
+ # Specifies an application resource lifecycle configuration to prevent
537
574
  # your application from accumulating too many versions.
538
575
  #
539
576
  # @option params [Array<Types::Tag>] :tags
@@ -641,8 +678,8 @@ module Aws::ElasticBeanstalk
641
678
  # Omit both `SourceBuildInformation` and `SourceBundle` to use the
642
679
  # default sample application.
643
680
  #
644
- # <note markdown="1"> Once you create an application version with a specified Amazon S3
645
- # bucket and key location, you cannot change that Amazon S3 location. If
681
+ # <note markdown="1"> After you create an application version with a specified Amazon S3
682
+ # bucket and key location, you can't change that Amazon S3 location. If
646
683
  # you change the Amazon S3 location, you receive an exception when you
647
684
  # attempt to launch an environment from the application version.
648
685
  #
@@ -661,7 +698,7 @@ module Aws::ElasticBeanstalk
661
698
  # Elastic Beanstalk returns an `InvalidParameterValue` error.
662
699
  #
663
700
  # @option params [String] :description
664
- # Describes this version.
701
+ # A description of this application version.
665
702
  #
666
703
  # @option params [Types::SourceBuildInformation] :source_build_information
667
704
  # Specify a commit in an AWS CodeCommit Git repository to use as the
@@ -802,8 +839,10 @@ module Aws::ElasticBeanstalk
802
839
  req.send_request(options)
803
840
  end
804
841
 
805
- # Creates a configuration template. Templates are associated with a
806
- # specific application and are used to deploy different versions of the
842
+ # Creates an AWS Elastic Beanstalk configuration template, associated
843
+ # with a specific Elastic Beanstalk application. You define application
844
+ # configuration settings in a configuration template. You can then use
845
+ # the configuration template to deploy different versions of the
807
846
  # application with the same configuration settings.
808
847
  #
809
848
  # Templates aren't associated with any environment. The
@@ -818,64 +857,80 @@ module Aws::ElasticBeanstalk
818
857
  # * ListAvailableSolutionStacks
819
858
  #
820
859
  # @option params [required, String] :application_name
821
- # The name of the application to associate with this configuration
822
- # template. If no application is found with this name, AWS Elastic
823
- # Beanstalk returns an `InvalidParameterValue` error.
860
+ # The name of the Elastic Beanstalk application to associate with this
861
+ # configuration template.
824
862
  #
825
863
  # @option params [required, String] :template_name
826
864
  # The name of the configuration template.
827
865
  #
828
866
  # Constraint: This name must be unique per application.
829
867
  #
830
- # Default: If a configuration template already exists with this name,
831
- # AWS Elastic Beanstalk returns an `InvalidParameterValue` error.
832
- #
833
868
  # @option params [String] :solution_stack_name
834
- # The name of the solution stack used by this configuration. The
835
- # solution stack specifies the operating system, architecture, and
836
- # application server for a configuration template. It determines the set
837
- # of configuration options as well as the possible and default values.
869
+ # The name of an Elastic Beanstalk solution stack (platform version)
870
+ # that this configuration uses. For example, `64bit Amazon Linux 2013.09
871
+ # running Tomcat 7 Java 7`. A solution stack specifies the operating
872
+ # system, runtime, and application server for a configuration template.
873
+ # It also determines the set of configuration options as well as the
874
+ # possible and default values. For more information, see [Supported
875
+ # Platforms][1] in the *AWS Elastic Beanstalk Developer Guide*.
838
876
  #
839
- # Use ListAvailableSolutionStacks to obtain a list of available solution
840
- # stacks.
877
+ # You must specify `SolutionStackName` if you don't specify
878
+ # `PlatformArn`, `EnvironmentId`, or `SourceConfiguration`.
841
879
  #
842
- # A solution stack name or a source configuration parameter must be
843
- # specified, otherwise AWS Elastic Beanstalk returns an
844
- # `InvalidParameterValue` error.
880
+ # Use the [ `ListAvailableSolutionStacks` ][2] API to obtain a list of
881
+ # available solution stacks.
845
882
  #
846
- # If a solution stack name is not specified and the source configuration
847
- # parameter is specified, AWS Elastic Beanstalk uses the same solution
848
- # stack as the source configuration template.
883
+ #
884
+ #
885
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html
886
+ # [2]: https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ListAvailableSolutionStacks.html
849
887
  #
850
888
  # @option params [String] :platform_arn
851
- # The ARN of the custom platform.
889
+ # The Amazon Resource Name (ARN) of the custom platform. For more
890
+ # information, see [ Custom Platforms][1] in the *AWS Elastic Beanstalk
891
+ # Developer Guide*.
892
+ #
893
+ # <note markdown="1"> If you specify `PlatformArn`, then don't specify `SolutionStackName`.
894
+ #
895
+ # </note>
896
+ #
897
+ #
898
+ #
899
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
852
900
  #
853
901
  # @option params [Types::SourceConfiguration] :source_configuration
854
- # If specified, AWS Elastic Beanstalk uses the configuration values from
855
- # the specified configuration template to create a new configuration.
902
+ # An Elastic Beanstalk configuration template to base this one on. If
903
+ # specified, Elastic Beanstalk uses the configuration values from the
904
+ # specified configuration template to create a new configuration.
856
905
  #
857
- # Values specified in the `OptionSettings` parameter of this call
858
- # overrides any values obtained from the `SourceConfiguration`.
906
+ # Values specified in `OptionSettings` override any values obtained from
907
+ # the `SourceConfiguration`.
859
908
  #
860
- # If no configuration template is found, returns an
861
- # `InvalidParameterValue` error.
909
+ # You must specify `SourceConfiguration` if you don't specify
910
+ # `PlatformArn`, `EnvironmentId`, or `SolutionStackName`.
862
911
  #
863
- # Constraint: If both the solution stack name parameter and the source
864
- # configuration parameters are specified, the solution stack of the
865
- # source configuration template must match the specified solution stack
866
- # name or else AWS Elastic Beanstalk returns an
867
- # `InvalidParameterCombination` error.
912
+ # Constraint: If both solution stack name and source configuration are
913
+ # specified, the solution stack of the source configuration template
914
+ # must match the specified solution stack name.
868
915
  #
869
916
  # @option params [String] :environment_id
870
- # The ID of the environment used with this configuration template.
917
+ # The ID of an environment whose settings you want to use to create the
918
+ # configuration template. You must specify `EnvironmentId` if you don't
919
+ # specify `PlatformArn`, `SolutionStackName`, or `SourceConfiguration`.
871
920
  #
872
921
  # @option params [String] :description
873
- # Describes this configuration.
922
+ # An optional description for this configuration.
874
923
  #
875
924
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
876
- # If specified, AWS Elastic Beanstalk sets the specified configuration
877
- # option to the requested value. The new value overrides the value
878
- # obtained from the solution stack or the source configuration template.
925
+ # Option values for the Elastic Beanstalk configuration, such as the
926
+ # instance type. If specified, these values override the values obtained
927
+ # from the solution stack or the source configuration template. For a
928
+ # complete list of Elastic Beanstalk configuration options, see [Option
929
+ # Values][1] in the *AWS Elastic Beanstalk Developer Guide*.
930
+ #
931
+ #
932
+ #
933
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
879
934
  #
880
935
  # @option params [Array<Types::Tag>] :tags
881
936
  # Specifies the tags applied to the configuration template.
@@ -969,28 +1024,24 @@ module Aws::ElasticBeanstalk
969
1024
  req.send_request(options)
970
1025
  end
971
1026
 
972
- # Launches an environment for the specified application using the
973
- # specified configuration.
1027
+ # Launches an AWS Elastic Beanstalk environment for the specified
1028
+ # application using the specified configuration.
974
1029
  #
975
1030
  # @option params [required, String] :application_name
976
- # The name of the application that contains the version to be deployed.
977
- #
978
- # If no application is found with this name, `CreateEnvironment` returns
979
- # an `InvalidParameterValue` error.
1031
+ # The name of the application that is associated with this environment.
980
1032
  #
981
1033
  # @option params [String] :environment_name
982
- # A unique name for the deployment environment. Used in the application
983
- # URL.
1034
+ # A unique name for the environment.
984
1035
  #
985
1036
  # Constraint: Must be from 4 to 40 characters in length. The name can
986
- # contain only letters, numbers, and hyphens. It cannot start or end
1037
+ # contain only letters, numbers, and hyphens. It can't start or end
987
1038
  # with a hyphen. This name must be unique within a region in your
988
- # account. If the specified name already exists in the region, AWS
989
- # Elastic Beanstalk returns an `InvalidParameterValue` error.
1039
+ # account. If the specified name already exists in the region, Elastic
1040
+ # Beanstalk returns an `InvalidParameterValue` error.
990
1041
  #
991
- # Default: If the CNAME parameter is not specified, the environment name
992
- # becomes part of the CNAME, and therefore part of the visible URL for
993
- # your application.
1042
+ # If you don't specify the `CNAMEPrefix` parameter, the environment
1043
+ # name becomes part of the CNAME, and therefore part of the visible URL
1044
+ # for your application.
994
1045
  #
995
1046
  # @option params [String] :group_name
996
1047
  # The name of the group to which the target environment belongs. Specify
@@ -1003,15 +1054,20 @@ module Aws::ElasticBeanstalk
1003
1054
  # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
1004
1055
  #
1005
1056
  # @option params [String] :description
1006
- # Describes this environment.
1057
+ # Your description for this environment.
1007
1058
  #
1008
1059
  # @option params [String] :cname_prefix
1009
1060
  # If specified, the environment attempts to use this value as the prefix
1010
- # for the CNAME. If not specified, the CNAME is generated automatically
1011
- # by appending a random alphanumeric string to the environment name.
1061
+ # for the CNAME in your Elastic Beanstalk environment URL. If not
1062
+ # specified, the CNAME is generated automatically by appending a random
1063
+ # alphanumeric string to the environment name.
1012
1064
  #
1013
1065
  # @option params [Types::EnvironmentTier] :tier
1014
- # This specifies the tier to use for creating this environment.
1066
+ # Specifies the tier to use in creating this environment. The
1067
+ # environment tier that you choose determines whether Elastic Beanstalk
1068
+ # provisions resources to support a web application that handles HTTP(S)
1069
+ # requests or a web application that handles background-processing
1070
+ # tasks.
1015
1071
  #
1016
1072
  # @option params [Array<Types::Tag>] :tags
1017
1073
  # Specifies the tags applied to resources in the environment.
@@ -1019,32 +1075,47 @@ module Aws::ElasticBeanstalk
1019
1075
  # @option params [String] :version_label
1020
1076
  # The name of the application version to deploy.
1021
1077
  #
1022
- # If the specified application has no associated application versions,
1023
- # AWS Elastic Beanstalk `UpdateEnvironment` returns an
1024
- # `InvalidParameterValue` error.
1025
- #
1026
- # Default: If not specified, AWS Elastic Beanstalk attempts to launch
1027
- # the sample application in the container.
1078
+ # Default: If not specified, Elastic Beanstalk attempts to deploy the
1079
+ # sample application.
1028
1080
  #
1029
1081
  # @option params [String] :template_name
1030
- # The name of the configuration template to use in deployment. If no
1031
- # configuration template is found with this name, AWS Elastic Beanstalk
1032
- # returns an `InvalidParameterValue` error.
1082
+ # The name of the Elastic Beanstalk configuration template to use with
1083
+ # the environment.
1084
+ #
1085
+ # <note markdown="1"> If you specify `TemplateName`, then don't specify
1086
+ # `SolutionStackName`.
1087
+ #
1088
+ # </note>
1033
1089
  #
1034
1090
  # @option params [String] :solution_stack_name
1035
- # This is an alternative to specifying a template name. If specified,
1036
- # AWS Elastic Beanstalk sets the configuration values to the default
1037
- # values associated with the specified solution stack.
1091
+ # The name of an Elastic Beanstalk solution stack (platform version) to
1092
+ # use with the environment. If specified, Elastic Beanstalk sets the
1093
+ # configuration values to the default values associated with the
1094
+ # specified solution stack. For a list of current solution stacks, see
1095
+ # [Elastic Beanstalk Supported Platforms][1] in the *AWS Elastic
1096
+ # Beanstalk Platforms* guide.
1097
+ #
1098
+ # <note markdown="1"> If you specify `SolutionStackName`, don't specify `PlatformArn` or
1099
+ # `TemplateName`.
1038
1100
  #
1039
- # For a list of current solution stacks, see [Elastic Beanstalk
1040
- # Supported Platforms][1].
1101
+ # </note>
1041
1102
  #
1042
1103
  #
1043
1104
  #
1044
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html
1105
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platforms-supported.html
1045
1106
  #
1046
1107
  # @option params [String] :platform_arn
1047
- # The ARN of the platform.
1108
+ # The Amazon Resource Name (ARN) of the custom platform to use with the
1109
+ # environment. For more information, see [Custom Platforms][1] in the
1110
+ # *AWS Elastic Beanstalk Developer Guide*.
1111
+ #
1112
+ # <note markdown="1"> If you specify `PlatformArn`, don't specify `SolutionStackName`.
1113
+ #
1114
+ # </note>
1115
+ #
1116
+ #
1117
+ #
1118
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html
1048
1119
  #
1049
1120
  # @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
1050
1121
  # If specified, AWS Elastic Beanstalk sets the specified configuration
@@ -1056,6 +1127,19 @@ module Aws::ElasticBeanstalk
1056
1127
  # A list of custom user-defined configuration options to remove from the
1057
1128
  # configuration set for this new environment.
1058
1129
  #
1130
+ # @option params [String] :operations_role
1131
+ # The Amazon Resource Name (ARN) of an existing IAM role to be used as
1132
+ # the environment's operations role. If specified, Elastic Beanstalk
1133
+ # uses the operations role for permissions to downstream services during
1134
+ # this call and during subsequent calls acting on this environment. To
1135
+ # specify an operations role, you must have the `iam:PassRole`
1136
+ # permission for the role. For more information, see [Operations
1137
+ # roles][1] in the *AWS Elastic Beanstalk Developer Guide*.
1138
+ #
1139
+ #
1140
+ #
1141
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
1142
+ #
1059
1143
  # @return [Types::EnvironmentDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1060
1144
  #
1061
1145
  # * {Types::EnvironmentDescription#environment_name #environment_name} => String
@@ -1078,6 +1162,7 @@ module Aws::ElasticBeanstalk
1078
1162
  # * {Types::EnvironmentDescription#tier #tier} => Types::EnvironmentTier
1079
1163
  # * {Types::EnvironmentDescription#environment_links #environment_links} => Array&lt;Types::EnvironmentLink&gt;
1080
1164
  # * {Types::EnvironmentDescription#environment_arn #environment_arn} => String
1165
+ # * {Types::EnvironmentDescription#operations_role #operations_role} => String
1081
1166
  #
1082
1167
  #
1083
1168
  # @example Example: To create a new environment for an application
@@ -1149,6 +1234,7 @@ module Aws::ElasticBeanstalk
1149
1234
  # option_name: "ConfigurationOptionName",
1150
1235
  # },
1151
1236
  # ],
1237
+ # operations_role: "OperationsRole",
1152
1238
  # })
1153
1239
  #
1154
1240
  # @example Response structure
@@ -1181,6 +1267,7 @@ module Aws::ElasticBeanstalk
1181
1267
  # resp.environment_links[0].link_name #=> String
1182
1268
  # resp.environment_links[0].environment_name #=> String
1183
1269
  # resp.environment_arn #=> String
1270
+ # resp.operations_role #=> String
1184
1271
  #
1185
1272
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreateEnvironment AWS API Documentation
1186
1273
  #
@@ -1258,6 +1345,10 @@ module Aws::ElasticBeanstalk
1258
1345
  # resp.platform_summary.supported_tier_list[0] #=> String
1259
1346
  # resp.platform_summary.supported_addon_list #=> Array
1260
1347
  # resp.platform_summary.supported_addon_list[0] #=> String
1348
+ # resp.platform_summary.platform_lifecycle_state #=> String
1349
+ # resp.platform_summary.platform_version #=> String
1350
+ # resp.platform_summary.platform_branch_name #=> String
1351
+ # resp.platform_summary.platform_branch_lifecycle_state #=> String
1261
1352
  # resp.builder.arn #=> String
1262
1353
  #
1263
1354
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/CreatePlatformVersion AWS API Documentation
@@ -1511,6 +1602,10 @@ module Aws::ElasticBeanstalk
1511
1602
  # resp.platform_summary.supported_tier_list[0] #=> String
1512
1603
  # resp.platform_summary.supported_addon_list #=> Array
1513
1604
  # resp.platform_summary.supported_addon_list[0] #=> String
1605
+ # resp.platform_summary.platform_lifecycle_state #=> String
1606
+ # resp.platform_summary.platform_version #=> String
1607
+ # resp.platform_summary.platform_branch_name #=> String
1608
+ # resp.platform_summary.platform_branch_lifecycle_state #=> String
1514
1609
  #
1515
1610
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DeletePlatformVersion AWS API Documentation
1516
1611
  #
@@ -2433,6 +2528,7 @@ module Aws::ElasticBeanstalk
2433
2528
  # resp.environments[0].environment_links[0].link_name #=> String
2434
2529
  # resp.environments[0].environment_links[0].environment_name #=> String
2435
2530
  # resp.environments[0].environment_arn #=> String
2531
+ # resp.environments[0].operations_role #=> String
2436
2532
  # resp.next_token #=> String
2437
2533
  #
2438
2534
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments AWS API Documentation
@@ -2474,7 +2570,9 @@ module Aws::ElasticBeanstalk
2474
2570
  # descriptions to those associated with this environment.
2475
2571
  #
2476
2572
  # @option params [String] :platform_arn
2477
- # The ARN of the version of the custom platform.
2573
+ # The ARN of a custom platform version. If specified, AWS Elastic
2574
+ # Beanstalk restricts the returned descriptions to those associated with
2575
+ # this custom platform version.
2478
2576
  #
2479
2577
  # @option params [String] :request_id
2480
2578
  # If specified, AWS Elastic Beanstalk restricts the described events to
@@ -2506,6 +2604,8 @@ module Aws::ElasticBeanstalk
2506
2604
  # * {Types::EventDescriptionsMessage#events #events} => Array&lt;Types::EventDescription&gt;
2507
2605
  # * {Types::EventDescriptionsMessage#next_token #next_token} => String
2508
2606
  #
2607
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2608
+ #
2509
2609
  #
2510
2610
  # @example Example: To view events for an environment
2511
2611
  #
@@ -2743,10 +2843,19 @@ module Aws::ElasticBeanstalk
2743
2843
  req.send_request(options)
2744
2844
  end
2745
2845
 
2746
- # Describes the version of the platform.
2846
+ # Describes a platform version. Provides full details. Compare to
2847
+ # ListPlatformVersions, which provides summary information about a list
2848
+ # of platform versions.
2849
+ #
2850
+ # For definitions of platform version and other platform-related terms,
2851
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
2852
+ #
2853
+ #
2854
+ #
2855
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
2747
2856
  #
2748
2857
  # @option params [String] :platform_arn
2749
- # The ARN of the version of the platform.
2858
+ # The ARN of the platform version.
2750
2859
  #
2751
2860
  # @return [Types::DescribePlatformVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2752
2861
  #
@@ -2786,6 +2895,9 @@ module Aws::ElasticBeanstalk
2786
2895
  # resp.platform_description.supported_tier_list[0] #=> String
2787
2896
  # resp.platform_description.supported_addon_list #=> Array
2788
2897
  # resp.platform_description.supported_addon_list[0] #=> String
2898
+ # resp.platform_description.platform_lifecycle_state #=> String
2899
+ # resp.platform_description.platform_branch_name #=> String
2900
+ # resp.platform_description.platform_branch_lifecycle_state #=> String
2789
2901
  #
2790
2902
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribePlatformVersion AWS API Documentation
2791
2903
  #
@@ -2796,6 +2908,37 @@ module Aws::ElasticBeanstalk
2796
2908
  req.send_request(options)
2797
2909
  end
2798
2910
 
2911
+ # Disassociate the operations role from an environment. After this call
2912
+ # is made, Elastic Beanstalk uses the caller's permissions for
2913
+ # permissions to downstream services during subsequent calls acting on
2914
+ # this environment. For more information, see [Operations roles][1] in
2915
+ # the *AWS Elastic Beanstalk Developer Guide*.
2916
+ #
2917
+ #
2918
+ #
2919
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html
2920
+ #
2921
+ # @option params [required, String] :environment_name
2922
+ # The name of the environment from which to disassociate the operations
2923
+ # role.
2924
+ #
2925
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2926
+ #
2927
+ # @example Request syntax with placeholder values
2928
+ #
2929
+ # resp = client.disassociate_environment_operations_role({
2930
+ # environment_name: "EnvironmentName", # required
2931
+ # })
2932
+ #
2933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DisassociateEnvironmentOperationsRole AWS API Documentation
2934
+ #
2935
+ # @overload disassociate_environment_operations_role(params = {})
2936
+ # @param [Hash] params ({})
2937
+ def disassociate_environment_operations_role(params = {}, options = {})
2938
+ req = build_request(:disassociate_environment_operations_role, params)
2939
+ req.send_request(options)
2940
+ end
2941
+
2799
2942
  # Returns a list of the available solution stack names, with the public
2800
2943
  # version first and then in reverse chronological order.
2801
2944
  #
@@ -2873,18 +3016,133 @@ module Aws::ElasticBeanstalk
2873
3016
  req.send_request(options)
2874
3017
  end
2875
3018
 
2876
- # Lists the available platforms.
3019
+ # Lists the platform branches available for your account in an AWS
3020
+ # Region. Provides summary information about each platform branch.
3021
+ #
3022
+ # For definitions of platform branch and other platform-related terms,
3023
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
3024
+ #
3025
+ #
3026
+ #
3027
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
3028
+ #
3029
+ # @option params [Array<Types::SearchFilter>] :filters
3030
+ # Criteria for restricting the resulting list of platform branches. The
3031
+ # filter is evaluated as a logical conjunction (AND) of the separate
3032
+ # `SearchFilter` terms.
3033
+ #
3034
+ # The following list shows valid attribute values for each of the
3035
+ # `SearchFilter` terms. Most operators take a single value. The `in` and
3036
+ # `not_in` operators can take multiple values.
3037
+ #
3038
+ # * `Attribute = BranchName`\:
3039
+ #
3040
+ # * `Operator`\: `=` \| `!=` \| `begins_with` \| `ends_with` \|
3041
+ # `contains` \| `in` \| `not_in`
3042
+ #
3043
+ # ^
3044
+ #
3045
+ # * `Attribute = LifecycleState`\:
3046
+ #
3047
+ # * `Operator`\: `=` \| `!=` \| `in` \| `not_in`
3048
+ #
3049
+ # * `Values`\: `beta` \| `supported` \| `deprecated` \| `retired`
3050
+ #
3051
+ # * `Attribute = PlatformName`\:
3052
+ #
3053
+ # * `Operator`\: `=` \| `!=` \| `begins_with` \| `ends_with` \|
3054
+ # `contains` \| `in` \| `not_in`
3055
+ #
3056
+ # ^
3057
+ #
3058
+ # * `Attribute = TierType`\:
3059
+ #
3060
+ # * `Operator`\: `=` \| `!=`
3061
+ #
3062
+ # * `Values`\: `WebServer/Standard` \| `Worker/SQS/HTTP`
3063
+ #
3064
+ # Array size: limited to 10 `SearchFilter` objects.
3065
+ #
3066
+ # Within each `SearchFilter` item, the `Values` array is limited to 10
3067
+ # items.
3068
+ #
3069
+ # @option params [Integer] :max_records
3070
+ # The maximum number of platform branch values returned in one call.
3071
+ #
3072
+ # @option params [String] :next_token
3073
+ # For a paginated request. Specify a token from a previous response page
3074
+ # to retrieve the next response page. All other parameter values must be
3075
+ # identical to the ones specified in the initial request.
3076
+ #
3077
+ # If no `NextToken` is specified, the first page is retrieved.
3078
+ #
3079
+ # @return [Types::ListPlatformBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3080
+ #
3081
+ # * {Types::ListPlatformBranchesResult#platform_branch_summary_list #platform_branch_summary_list} => Array&lt;Types::PlatformBranchSummary&gt;
3082
+ # * {Types::ListPlatformBranchesResult#next_token #next_token} => String
3083
+ #
3084
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3085
+ #
3086
+ # @example Request syntax with placeholder values
3087
+ #
3088
+ # resp = client.list_platform_branches({
3089
+ # filters: [
3090
+ # {
3091
+ # attribute: "SearchFilterAttribute",
3092
+ # operator: "SearchFilterOperator",
3093
+ # values: ["SearchFilterValue"],
3094
+ # },
3095
+ # ],
3096
+ # max_records: 1,
3097
+ # next_token: "Token",
3098
+ # })
3099
+ #
3100
+ # @example Response structure
3101
+ #
3102
+ # resp.platform_branch_summary_list #=> Array
3103
+ # resp.platform_branch_summary_list[0].platform_name #=> String
3104
+ # resp.platform_branch_summary_list[0].branch_name #=> String
3105
+ # resp.platform_branch_summary_list[0].lifecycle_state #=> String
3106
+ # resp.platform_branch_summary_list[0].branch_order #=> Integer
3107
+ # resp.platform_branch_summary_list[0].supported_tier_list #=> Array
3108
+ # resp.platform_branch_summary_list[0].supported_tier_list[0] #=> String
3109
+ # resp.next_token #=> String
3110
+ #
3111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformBranches AWS API Documentation
3112
+ #
3113
+ # @overload list_platform_branches(params = {})
3114
+ # @param [Hash] params ({})
3115
+ def list_platform_branches(params = {}, options = {})
3116
+ req = build_request(:list_platform_branches, params)
3117
+ req.send_request(options)
3118
+ end
3119
+
3120
+ # Lists the platform versions available for your account in an AWS
3121
+ # Region. Provides summary information about each platform version.
3122
+ # Compare to DescribePlatformVersion, which provides full details about
3123
+ # a single platform version.
3124
+ #
3125
+ # For definitions of platform version and other platform-related terms,
3126
+ # see [AWS Elastic Beanstalk Platforms Glossary][1].
3127
+ #
3128
+ #
3129
+ #
3130
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-glossary.html
2877
3131
  #
2878
3132
  # @option params [Array<Types::PlatformFilter>] :filters
2879
- # List only the platforms where the platform member value relates to one
2880
- # of the supplied values.
3133
+ # Criteria for restricting the resulting list of platform versions. The
3134
+ # filter is interpreted as a logical conjunction (AND) of the separate
3135
+ # `PlatformFilter` terms.
2881
3136
  #
2882
3137
  # @option params [Integer] :max_records
2883
- # The maximum number of platform values returned in one call.
3138
+ # The maximum number of platform version values returned in one call.
2884
3139
  #
2885
3140
  # @option params [String] :next_token
2886
- # The starting index into the remaining list of platforms. Use the
2887
- # `NextToken` value from a previous `ListPlatformVersion` call.
3141
+ # For a paginated request. Specify a token from a previous response page
3142
+ # to retrieve the next response page. All other parameter values must be
3143
+ # identical to the ones specified in the initial request.
3144
+ #
3145
+ # If no `NextToken` is specified, the first page is retrieved.
2888
3146
  #
2889
3147
  # @return [Types::ListPlatformVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2890
3148
  #
@@ -2918,6 +3176,10 @@ module Aws::ElasticBeanstalk
2918
3176
  # resp.platform_summary_list[0].supported_tier_list[0] #=> String
2919
3177
  # resp.platform_summary_list[0].supported_addon_list #=> Array
2920
3178
  # resp.platform_summary_list[0].supported_addon_list[0] #=> String
3179
+ # resp.platform_summary_list[0].platform_lifecycle_state #=> String
3180
+ # resp.platform_summary_list[0].platform_version #=> String
3181
+ # resp.platform_summary_list[0].platform_branch_name #=> String
3182
+ # resp.platform_summary_list[0].platform_branch_lifecycle_state #=> String
2921
3183
  # resp.next_token #=> String
2922
3184
  #
2923
3185
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/ListPlatformVersions AWS API Documentation
@@ -2929,22 +3191,22 @@ module Aws::ElasticBeanstalk
2929
3191
  req.send_request(options)
2930
3192
  end
2931
3193
 
2932
- # Returns the tags applied to an AWS Elastic Beanstalk resource. The
3194
+ # Return the tags applied to an AWS Elastic Beanstalk resource. The
2933
3195
  # response contains a list of tag key-value pairs.
2934
3196
  #
2935
- # Currently, Elastic Beanstalk only supports tagging of Elastic
2936
- # Beanstalk environments. For details about environment tagging, see
2937
- # [Tagging Resources in Your Elastic Beanstalk Environment][1].
3197
+ # Elastic Beanstalk supports tagging of all of its resources. For
3198
+ # details about resource tagging, see [Tagging Application
3199
+ # Resources][1].
2938
3200
  #
2939
3201
  #
2940
3202
  #
2941
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html
3203
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html
2942
3204
  #
2943
3205
  # @option params [required, String] :resource_arn
2944
3206
  # The Amazon Resource Name (ARN) of the resouce for which a tag list is
2945
3207
  # requested.
2946
3208
  #
2947
- # Must be the ARN of an Elastic Beanstalk environment.
3209
+ # Must be the ARN of an Elastic Beanstalk resource.
2948
3210
  #
2949
3211
  # @return [Types::ResourceTagsDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2950
3212
  #
@@ -3342,6 +3604,7 @@ module Aws::ElasticBeanstalk
3342
3604
  # * {Types::EnvironmentDescription#tier #tier} => Types::EnvironmentTier
3343
3605
  # * {Types::EnvironmentDescription#environment_links #environment_links} => Array&lt;Types::EnvironmentLink&gt;
3344
3606
  # * {Types::EnvironmentDescription#environment_arn #environment_arn} => String
3607
+ # * {Types::EnvironmentDescription#operations_role #operations_role} => String
3345
3608
  #
3346
3609
  #
3347
3610
  # @example Example: To terminate an environment
@@ -3411,6 +3674,7 @@ module Aws::ElasticBeanstalk
3411
3674
  # resp.environment_links[0].link_name #=> String
3412
3675
  # resp.environment_links[0].environment_name #=> String
3413
3676
  # resp.environment_arn #=> String
3677
+ # resp.operations_role #=> String
3414
3678
  #
3415
3679
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/TerminateEnvironment AWS API Documentation
3416
3680
  #
@@ -3881,6 +4145,7 @@ module Aws::ElasticBeanstalk
3881
4145
  # * {Types::EnvironmentDescription#tier #tier} => Types::EnvironmentTier
3882
4146
  # * {Types::EnvironmentDescription#environment_links #environment_links} => Array&lt;Types::EnvironmentLink&gt;
3883
4147
  # * {Types::EnvironmentDescription#environment_arn #environment_arn} => String
4148
+ # * {Types::EnvironmentDescription#operations_role #operations_role} => String
3884
4149
  #
3885
4150
  #
3886
4151
  # @example Example: To update an environment to a new version
@@ -4027,6 +4292,7 @@ module Aws::ElasticBeanstalk
4027
4292
  # resp.environment_links[0].link_name #=> String
4028
4293
  # resp.environment_links[0].environment_name #=> String
4029
4294
  # resp.environment_arn #=> String
4295
+ # resp.operations_role #=> String
4030
4296
  #
4031
4297
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateEnvironment AWS API Documentation
4032
4298
  #
@@ -4041,9 +4307,9 @@ module Aws::ElasticBeanstalk
4041
4307
  # Two lists can be passed: `TagsToAdd` for tags to add or update, and
4042
4308
  # `TagsToRemove`.
4043
4309
  #
4044
- # Currently, Elastic Beanstalk only supports tagging of Elastic
4045
- # Beanstalk environments. For details about environment tagging, see
4046
- # [Tagging Resources in Your Elastic Beanstalk Environment][1].
4310
+ # Elastic Beanstalk supports tagging of all of its resources. For
4311
+ # details about resource tagging, see [Tagging Application
4312
+ # Resources][1].
4047
4313
  #
4048
4314
  # If you create a custom IAM user policy to control permission to this
4049
4315
  # operation, specify one of the following two virtual actions (or both)
@@ -4064,23 +4330,25 @@ module Aws::ElasticBeanstalk
4064
4330
  #
4065
4331
  #
4066
4332
  #
4067
- # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html
4333
+ # [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/applications-tagging-resources.html
4068
4334
  # [2]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies
4069
4335
  #
4070
4336
  # @option params [required, String] :resource_arn
4071
4337
  # The Amazon Resource Name (ARN) of the resouce to be updated.
4072
4338
  #
4073
- # Must be the ARN of an Elastic Beanstalk environment.
4339
+ # Must be the ARN of an Elastic Beanstalk resource.
4074
4340
  #
4075
4341
  # @option params [Array<Types::Tag>] :tags_to_add
4076
- # A list of tags to add or update.
4342
+ # A list of tags to add or update. If a key of an existing tag is added,
4343
+ # the tag's value is updated.
4077
4344
  #
4078
- # If a key of an existing tag is added, the tag's value is updated.
4345
+ # Specify at least one of these parameters: `TagsToAdd`, `TagsToRemove`.
4079
4346
  #
4080
4347
  # @option params [Array<String>] :tags_to_remove
4081
- # A list of tag keys to remove.
4348
+ # A list of tag keys to remove. If a tag key doesn't exist, it is
4349
+ # silently ignored.
4082
4350
  #
4083
- # If a tag key doesn't exist, it is silently ignored.
4351
+ # Specify at least one of these parameters: `TagsToAdd`, `TagsToRemove`.
4084
4352
  #
4085
4353
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4086
4354
  #
@@ -4205,7 +4473,7 @@ module Aws::ElasticBeanstalk
4205
4473
  params: params,
4206
4474
  config: config)
4207
4475
  context[:gem_name] = 'aws-sdk-elasticbeanstalk'
4208
- context[:gem_version] = '1.27.0'
4476
+ context[:gem_version] = '1.32.1'
4209
4477
  Seahorse::Client::Request.new(handlers, context)
4210
4478
  end
4211
4479