EbsSnapshotConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.accessanalyzer.model.EbsSnapshotConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EbsSnapshotConfiguration.Builder,EbsSnapshotConfiguration>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class EbsSnapshotConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EbsSnapshotConfiguration.Builder,EbsSnapshotConfiguration>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EbsSnapshotConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EbsSnapshotConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EbsSnapshotConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groups()` The groups that have access to the Amazon EBS volume snapshot.
`boolean`	`hasGroups()` For responses, this returns true if the service returned a value for the Groups property.
`int`	`hashCode()`
`boolean`	`hasUserIds()` For responses, this returns true if the service returned a value for the UserIds property.
`String`	`kmsKeyId()` The KMS key identifier for an encrypted Amazon EBS volume snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EbsSnapshotConfiguration.Builder>`	`serializableBuilderClass()`
`EbsSnapshotConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasUserIds
```
public final boolean hasUserIds()
```
    For responses, this returns true if the service returned a value for the UserIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - userIds
```
public final List<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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserIds() method.
    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.
  - hasGroups
```
public final boolean hasGroups()
```
    For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - groups
```
public final List<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 .
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroups() method.
    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.
  - kmsKeyId
```
public final 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.
    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.
  - toBuilder
```
public EbsSnapshotConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EbsSnapshotConfiguration.Builder,EbsSnapshotConfiguration>
  - builder
```
public static EbsSnapshotConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EbsSnapshotConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class EbsSnapshotConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasUserIds

userIds

hasGroups

groups

kmsKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields