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
show all
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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute.

Returns:

  • (String)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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

#descriptionString

A description for the AFI.

Returns:

  • (String)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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_idString

The ID of the AFI.

Returns:

  • (String)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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_permissionTypes::LoadPermissionModifications

The load permission for the AFI.



19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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

#nameString

A name for the AFI.

Returns:

  • (String)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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_typeString

The operation type.

Returns:

  • (String)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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_groupsArray<String>

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

Returns:

  • (Array<String>)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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_idsArray<String>

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

Returns:

  • (Array<String>)


19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19548

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