Package software.amazon.awssdk.services.backup.model

Class CreateBackupVaultRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.CreateBackupVaultRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateBackupVaultRequest.Builder,CreateBackupVaultRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateBackupVaultRequest
extends BackupRequest
implements ToCopyableBuilder<CreateBackupVaultRequest.Builder,CreateBackupVaultRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateBackupVaultRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	backupVaultName()	The name of a logical container where backups are stored.
Map<String,String>	backupVaultTags()	Metadata that you can assign to help organize the resources that you create.
static CreateBackupVaultRequest.Builder	builder()
String	creatorRequestId()	A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
String	encryptionKeyArn()	The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBackupVaultTags()	For responses, this returns true if the service returned a value for the BackupVaultTags property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackupVaultRequest.Builder>	serializableBuilderClass()
CreateBackupVaultRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

backupVaultName

public final String backupVaultName()

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

Returns:

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

hasBackupVaultTags

public final boolean hasBackupVaultTags()

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

backupVaultTags

public final Map<String,String> backupVaultTags()

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

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

Returns:

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

encryptionKeyArn

public final String encryptionKeyArn()

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Returns:

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

creatorRequestId

public final String creatorRequestId()

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

toBuilder

public CreateBackupVaultRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateBackupVaultRequest.Builder,CreateBackupVaultRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static CreateBackupVaultRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBackupVaultRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo