Class: Aws::SMS::Types::UpdateAppRequest

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

Overview

Note:

When making an API call, you may pass UpdateAppRequest data as a hash:

{
  app_id: "AppId",
  name: "AppName",
  description: "AppDescription",
  role_name: "RoleName",
  server_groups: [
    {
      server_group_id: "ServerGroupId",
      name: "ServerGroupName",
      server_list: [
        {
          server_id: "ServerId",
          server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
          vm_server: {
            vm_server_address: {
              vm_manager_id: "VmManagerId",
              vm_id: "VmId",
            },
            vm_name: "VmName",
            vm_manager_name: "VmManagerName",
            vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
            vm_path: "VmPath",
          },
          replication_job_id: "ReplicationJobId",
          replication_job_terminated: false,
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The ID of the application.

Returns:

  • (String)


2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The new description of the application.

Returns:

  • (String)


2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The new name of the application.

Returns:

  • (String)


2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_nameString

The name of the service role in the customer's account used by AWS SMS.

Returns:

  • (String)


2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#server_groupsArray<Types::ServerGroup>

The server groups in the application to update.

Returns:



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to associate with the application.

Returns:



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2852

class UpdateAppRequest < Struct.new(
  :app_id,
  :name,
  :description,
  :role_name,
  :server_groups,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end