software.amazon.awssdk.services.accessanalyzer.model

Class RdsDbSnapshotConfiguration

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.RdsDbSnapshotConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RdsDbSnapshotConfiguration.Builder,RdsDbSnapshotConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class RdsDbSnapshotConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RdsDbSnapshotConfiguration.Builder,RdsDbSnapshotConfiguration>

The proposed access control configuration for an Amazon RDS DB snapshot. You can propose a configuration for a new Amazon RDS DB snapshot or an Amazon RDS DB snapshot that you own by specifying the RdsDbSnapshotAttributeValue and optional KMS encryption key. For more information, see ModifyDBSnapshotAttribute.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RdsDbSnapshotConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,RdsDbSnapshotAttributeValue>	attributes() The names and values of manual DB snapshot attributes.
static RdsDbSnapshotConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	kmsKeyId() The KMS key identifier for an encrypted Amazon RDS DB snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends RdsDbSnapshotConfiguration.Builder>	serializableBuilderClass()
RdsDbSnapshotConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasAttributes

public final boolean hasAttributes()

For responses, this returns true if the service returned a value for the Attributes 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.

attributes

public final Map<String,RdsDbSnapshotAttributeValue> attributes()

The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

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 hasAttributes() method.

Returns:

The names and values of manual DB snapshot attributes. Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. The only valid value for attributeName for the attribute map is restore.

kmsKeyId

public final String kmsKeyId()

The KMS key identifier for an encrypted Amazon RDS DB 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 RDS DB 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 specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

Returns:

The KMS key identifier for an encrypted Amazon RDS DB 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 RDS DB 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 specify the kmsKeyId, then the access preview considers the snapshot as unencrypted.

toBuilder

public RdsDbSnapshotConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RdsDbSnapshotConfiguration.Builder,RdsDbSnapshotConfiguration>

builder

public static RdsDbSnapshotConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends RdsDbSnapshotConfiguration.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