Class: Aws::EC2::Types::ModifyImageAttributeRequest

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

Overview

Note:

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

{
  attribute: "String",
  description: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  image_id: "ImageId", # required
  launch_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  dry_run: false,
}

Contains the parameters for ModifyImageAttribute.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.

Returns:

  • (String)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionTypes::AttributeValue

A new description for the AMI.



35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#image_idString

The ID of the AMI.

Returns:

  • (String)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#launch_permissionTypes::LaunchPermissionModifications

A new launch permission for the AMI.



35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#operation_typeString

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (String)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#product_codesArray<String>

The DevPay product codes. After you add a product code to an AMI, it can't be removed.

Returns:

  • (Array<String>)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#user_groupsArray<String>

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#user_idsArray<String>

The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.

Returns:

  • (String)


35198
35199
35200
35201
35202
35203
35204
35205
35206
35207
35208
35209
35210
35211
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 35198

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end