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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute ⇒ String

The snapshot attribute to modify. Only volume creation permissions can be modified.

Returns:

  • (String) 


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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

#create_volume_permission ⇒ Types::CreateVolumePermissionModifications

A JSON representation of the snapshot attribute modification.

Returns:



26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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

#group_names ⇒ Array<String>

The group to modify for the snapshot.

Returns:

  • (Array<String>) 


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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

#operation_type ⇒ String

The type of operation to perform to the attribute.

Returns:

  • (String) 


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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

#snapshot_id ⇒ String

The ID of the snapshot.

Returns:

  • (String) 


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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

#user_ids ⇒ Array<String>

The account ID to modify for the snapshot.

Returns:

  • (Array<String>) 


26258
26259
26260
26261
26262
26263
26264
26265
26266
26267
 
# File 'lib/aws-sdk-ec2/types.rb', line 26258

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