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

Class: Aws::EC2::Types::ModifySnapshotAttributeRequest

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 ModifySnapshotAttributeRequest data as a hash:

{
  attribute: "productCodes", # accepts productCodes, createVolumePermission
  create_volume_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  group_names: ["String"],
  operation_type: "add", # accepts add, remove
  snapshot_id: "String", # required
  user_ids: ["String"],
  dry_run: false,
}

Contains the parameters for ModifySnapshotAttribute.

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

Returns:

  • (String)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end

#create_volume_permissionTypes::CreateVolumePermissionModifications

A JSON representation of the snapshot attribute modification.



20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  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)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end

#group_namesArray<String>

The group to modify for the snapshot.

Returns:

  • (Array<String>)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end

#operation_typeString

The type of operation to perform to the attribute.

Returns:

  • (String)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end

#snapshot_idString

The ID of the snapshot.

Returns:

  • (String)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end

#user_idsArray<String>

The account ID to modify for the snapshot.

Returns:

  • (Array<String>)


20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 20125

class ModifySnapshotAttributeRequest < Struct.new(
  :attribute,
  :create_volume_permission,
  :group_names,
  :operation_type,
  :snapshot_id,
  :user_ids,
  :dry_run)
  include Aws::Structure
end