ModifySnapshotAttributeRequest Class

Container for the parameters to the ModifySnapshotAttribute operation. Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifySnapshotAttributeRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class ModifySnapshotAttributeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifySnapshotAttributeRequest type exposes the following members

Constructors

	Name	Description
	ModifySnapshotAttributeRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	ModifySnapshotAttributeRequest(string, SnapshotAttributeName, OperationType)	Instantiates ModifySnapshotAttributeRequest with the parameterized properties

Properties

Name	Type	Description
Attribute	Amazon.EC2.SnapshotAttributeName	Gets and sets the property Attribute. The snapshot attribute to modify. Only volume creation permissions can be modified.
CreateVolumePermission	Amazon.EC2.Model.CreateVolumePermissionModifications	Gets and sets the property CreateVolumePermission. A JSON representation of the snapshot attribute modification.
GroupNames	System.Collections.Generic.List<System.String>	Gets and sets the property GroupNames. The group to modify for the snapshot.
OperationType	Amazon.EC2.OperationType	Gets and sets the property OperationType. The type of operation to perform to the attribute.
SnapshotId	System.String	Gets and sets the property SnapshotId. The ID of the snapshot.
UserIds	System.Collections.Generic.List<System.String>	Gets and sets the property UserIds. The account ID to modify for the snapshot.

Examples

This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.

To modify a snapshot attribute


var client = new AmazonEC2Client();
var response = client.ModifySnapshotAttribute(new ModifySnapshotAttributeRequest 
{
    Attribute = "createVolumePermission",
    OperationType = "remove",
    SnapshotId = "snap-1234567890abcdef0",
    UserIds = new List<string> {
        "123456789012"
    }
});

This example makes the snapshot ``snap-1234567890abcdef0`` public.

To make a snapshot public


var client = new AmazonEC2Client();
var response = client.ModifySnapshotAttribute(new ModifySnapshotAttributeRequest 
{
    Attribute = "createVolumePermission",
    GroupNames = new List<string> {
        "all"
    },
    OperationType = "add",
    SnapshotId = "snap-1234567890abcdef0"
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5