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: "FpgaImageId", # 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute.

Returns:

  • (String)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#descriptionString

A description for the AFI.

Returns:

  • (String)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

class ModifyFpgaImageAttributeRequest < Struct.new(
  :dry_run,
  :fpga_image_id,
  :attribute,
  :operation_type,
  :user_ids,
  :user_groups,
  :product_codes,
  :load_permission,
  :description,
  :name)
  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)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#fpga_image_idString

The ID of the AFI.

Returns:

  • (String)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#load_permissionTypes::LoadPermissionModifications

The load permission for the AFI.



34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#nameString

A name for the AFI.

Returns:

  • (String)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#operation_typeString

The operation type.

Returns:

  • (String)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#product_codesArray<String>

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


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#user_groupsArray<String>

The user groups. This parameter is valid only when modifying the loadPermission attribute.

Returns:

  • (Array<String>)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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

#user_idsArray<String>

The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

Returns:

  • (Array<String>)


34018
34019
34020
34021
34022
34023
34024
34025
34026
34027
34028
34029
34030
34031
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 34018

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