Class: Aws::MainframeModernization::Types::UpdateEnvironmentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#apply_during_maintenance_windowBoolean

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Returns:

  • (Boolean)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#desired_capacityInteger

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Returns:

  • (Integer)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The version of the runtime engine for the runtime environment.

Returns:

  • (String)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#environment_idString

The unique identifier of the runtime environment that you want to update.

Returns:

  • (String)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#force_updateBoolean

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Returns:

  • (Boolean)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type for the runtime environment to update.

Returns:

  • (String)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Returns:

  • (String)


3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 3162

class UpdateEnvironmentRequest < Struct.new(
  :apply_during_maintenance_window,
  :desired_capacity,
  :engine_version,
  :environment_id,
  :force_update,
  :instance_type,
  :preferred_maintenance_window)
  SENSITIVE = []
  include Aws::Structure
end