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

Class: Aws::EC2::Types::ModifyFpgaImageAttributeRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyFpgaImageAttributeRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

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

{
  dry_run: false,
  fpga_image_id: "String", # required
  attribute: "description", # accepts description, name, loadPermission, productCodes
  operation_type: "add", # accepts add, remove
  user_ids: ["String"],
  user_groups: ["String"],
  product_codes: ["String"],
  load_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  description: "String",
  name: "String",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attribute ⇒ String

  The name of the attribute.

• #description ⇒ String

  A description for the AFI.

• #dry_run ⇒ Boolean

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

• #fpga_image_id ⇒ String

  The ID of the AFI.

• #load_permission ⇒ Types::LoadPermissionModifications

  The load permission for the AFI.

• #name ⇒ String

  A name for the AFI.

• #operation_type ⇒ String

  The operation type.

• #product_codes ⇒ Array<String>

  One or more product codes.

• #user_groups ⇒ Array<String>

  One or more user groups.

• #user_ids ⇒ Array<String>

  One or more AWS account IDs.

Instance Attribute Details

#attribute ⇒ String

The name of the attribute.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#description ⇒ String

A description for the AFI.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

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

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#fpga_image_id ⇒ String

The ID of the AFI.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#load_permission ⇒ Types::LoadPermissionModifications

The load permission for the AFI.

Returns:

• (Types::LoadPermissionModifications)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#name ⇒ String

A name for the AFI.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#operation_type ⇒ String

The operation type.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#product_codes ⇒ Array<String>

One or more product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#user_groups ⇒ Array<String>

One or more user groups. This parameter is valid only when modifying the loadPermission attribute.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end

#user_ids ⇒ Array<String>

One or more AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20458

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  include Aws::Structure
end