Class: Aws::ElasticBeanstalk::Types::UpdateEnvironmentMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticBeanstalk::Types::UpdateEnvironmentMessage
- Defined in:
- gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb
Overview
When making an API call, you may pass UpdateEnvironmentMessage data as a hash:
{
application_name: "ApplicationName",
environment_id: "EnvironmentId",
environment_name: "EnvironmentName",
group_name: "GroupName",
description: "Description",
tier: {
name: "String",
type: "String",
version: "String",
},
version_label: "VersionLabel",
template_name: "ConfigurationTemplateName",
solution_stack_name: "SolutionStackName",
platform_arn: "PlatformArn",
option_settings: [
{
resource_name: "ResourceName",
namespace: "OptionNamespace",
option_name: "ConfigurationOptionName",
value: "ConfigurationOptionValue",
},
],
options_to_remove: [
{
resource_name: "ResourceName",
namespace: "OptionNamespace",
option_name: "ConfigurationOptionName",
},
],
}
Request to update an environment.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_name ⇒ String
The name of the application with which the environment is associated.
-
#description ⇒ String
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
-
#environment_id ⇒ String
The ID of the environment to update.
-
#environment_name ⇒ String
The name of the environment to update.
-
#group_name ⇒ String
The name of the group to which the target environment belongs.
-
#option_settings ⇒ Array<Types::ConfigurationOptionSetting>
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
-
#options_to_remove ⇒ Array<Types::OptionSpecification>
A list of custom user-defined configuration options to remove from the configuration set for this environment.
-
#platform_arn ⇒ String
The ARN of the platform, if used.
-
#solution_stack_name ⇒ String
This specifies the platform version that the environment will run after the environment is updated.
-
#template_name ⇒ String
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
-
#tier ⇒ Types::EnvironmentTier
This specifies the tier to use to update the environment.
-
#version_label ⇒ String
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
Instance Attribute Details
#application_name ⇒ String
The name of the application with which the environment is associated.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#environment_id ⇒ String
The ID of the environment to update.
If no environment with this ID exists, AWS Elastic Beanstalk returns
an InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentName, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#environment_name ⇒ String
The name of the environment to update. If no environment with this
name exists, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
Condition: You must specify either this or an EnvironmentId, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#group_name ⇒ String
The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#option_settings ⇒ Array<Types::ConfigurationOptionSetting>
If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#options_to_remove ⇒ Array<Types::OptionSpecification>
A list of custom user-defined configuration options to remove from the configuration set for this environment.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#platform_arn ⇒ String
The ARN of the platform, if used.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#solution_stack_name ⇒ String
This specifies the platform version that the environment will run after the environment is updated.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#template_name ⇒ String
If this parameter is specified, AWS Elastic Beanstalk deploys this
configuration template to the environment. If no such configuration
template is found, AWS Elastic Beanstalk returns an
InvalidParameterValue
error.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#tier ⇒ Types::EnvironmentTier
This specifies the tier to use to update the environment.
Condition: At this time, if you change the tier version, name, or
type, AWS Elastic Beanstalk returns InvalidParameterValue
error.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |
#version_label ⇒ String
If this parameter is specified, AWS Elastic Beanstalk deploys the
named application version to the environment. If no such application
version is found, returns an InvalidParameterValue
error.
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 |
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 5184 class UpdateEnvironmentMessage < Struct.new( :application_name, :environment_id, :environment_name, :group_name, :description, :tier, :version_label, :template_name, :solution_stack_name, :platform_arn, :option_settings, :options_to_remove) SENSITIVE = [] include Aws::Structure end |