EbsSnapshotConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.accessanalyzer.model.EbsSnapshotConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EbsSnapshotConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The proposed access control configuration for an Amazon EBS volume snapshot. You can propose a configuration for a new Amazon EBS volume snapshot or an Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and optional KMS encryption key. For more information, see ModifySnapshotAttribute.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EbsSnapshotConfiguration()

Constructors
Constructor and Description
`EbsSnapshotConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EbsSnapshotConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getGroups()` The groups that have access to the Amazon EBS volume snapshot.
`String`	`getKmsKeyId()` The KMS key identifier for an encrypted Amazon EBS volume snapshot.
`List<String>`	`getUserIds()` The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGroups(Collection<String> groups)` The groups that have access to the Amazon EBS volume snapshot.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted Amazon EBS volume snapshot.
`void`	`setUserIds(Collection<String> userIds)` The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
`String`	`toString()` Returns a string representation of this object.
`EbsSnapshotConfiguration`	`withGroups(Collection<String> groups)` The groups that have access to the Amazon EBS volume snapshot.
`EbsSnapshotConfiguration`	`withGroups(String... groups)` The groups that have access to the Amazon EBS volume snapshot.
`EbsSnapshotConfiguration`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier for an encrypted Amazon EBS volume snapshot.
`EbsSnapshotConfiguration`	`withUserIds(Collection<String> userIds)` The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
`EbsSnapshotConfiguration`	`withUserIds(String... userIds)` The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EbsSnapshotConfiguration
```
public EbsSnapshotConfiguration()
```
- Method Detail
  - getUserIds
```
public List<String> getUserIds()
```
    The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    - If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    - To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    Returns:
    The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    
    If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    
    To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
  - setUserIds
```
public void setUserIds(Collection<String> userIds)
```
    The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    - If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    - To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    Parameters:
    userIds - The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    
    If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    
    To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
  - withUserIds
```
public EbsSnapshotConfiguration withUserIds(String... userIds)
```
    The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    - If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    - To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    NOTE: This method appends the values to the existing list (if any). Use setUserIds(java.util.Collection) or withUserIds(java.util.Collection) if you want to override the existing values.
    Parameters:
    userIds - The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    
    If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    
    To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserIds
```
public EbsSnapshotConfiguration withUserIds(Collection<String> userIds)
```
    The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    - If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    - To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    Parameters:
    userIds - The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot.
    
    If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds.
    
    To propose deletion of existing shared accountIds, you can specify an empty list for userIds.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGroups
```
public List<String> getGroups()
```
    The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups , then the access preview uses the existing shared groups for the snapshot.
    - If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    - To propose deletion of existing shared groups, you can specify an empty list for groups .
    Returns:
    The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot.
    
    If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    
    To propose deletion of existing shared groups, you can specify an empty list for groups.
  - setGroups
```
public void setGroups(Collection<String> groups)
```
    The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups , then the access preview uses the existing shared groups for the snapshot.
    - If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    - To propose deletion of existing shared groups, you can specify an empty list for groups .
    Parameters:
    groups - The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot.
    
    If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    
    To propose deletion of existing shared groups, you can specify an empty list for groups.
  - withGroups
```
public EbsSnapshotConfiguration withGroups(String... groups)
```
    The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups , then the access preview uses the existing shared groups for the snapshot.
    - If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    - To propose deletion of existing shared groups, you can specify an empty list for groups .
    NOTE: This method appends the values to the existing list (if any). Use setGroups(java.util.Collection) or withGroups(java.util.Collection) if you want to override the existing values.
    Parameters:
    groups - The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot.
    
    If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    
    To propose deletion of existing shared groups, you can specify an empty list for groups.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGroups
```
public EbsSnapshotConfiguration withGroups(Collection<String> groups)
```
    The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups , then the access preview uses the existing shared groups for the snapshot.
    - If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    - To propose deletion of existing shared groups, you can specify an empty list for groups .
    Parameters:
    groups - The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot.
    
    If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups.
    
    To propose deletion of existing shared groups, you can specify an empty list for groups.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    - If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
    Parameters:
    kmsKeyId - The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    
    If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    - If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
    Returns:
    The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    
    If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
  - withKmsKeyId
```
public EbsSnapshotConfiguration withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    - If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    - If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
    Parameters:
    kmsKeyId - The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
    
    If the configuration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot.
    
    If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EbsSnapshotConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class EbsSnapshotConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EbsSnapshotConfiguration

Method Detail

getUserIds

setUserIds

withUserIds

withUserIds

getGroups

setGroups

withGroups

withGroups

setKmsKeyId

getKmsKeyId

withKmsKeyId

toString

equals

hashCode

clone

marshall