You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyImageAttributeRequest as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute ⇒ String

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

Returns:

  • (String) —

    The name of the attribute to modify.

#description ⇒ Types::AttributeValue

A new description for the AMI.

Returns:

#dry_run ⇒ Boolean

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) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#image_id ⇒ String

The ID of the AMI.

Returns:

  • (String) —

    The ID of the AMI.

#launch_permission ⇒ Types::LaunchPermissionModifications

A new launch permission for the AMI.

Returns:

#operation_type ⇒ String

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

Possible values:

  • add
  • remove

Returns:

  • (String) —

    The operation type.

#product_codes ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The DevPay product codes.

#user_groups ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The user groups.

#user_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The AWS account IDs.

#value ⇒ String

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

Returns:

  • (String) —

    The value of the attribute being modified.