Class PutBackupVaultNotificationsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutBackupVaultNotificationsRequest.Builder,
PutBackupVaultNotificationsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<BackupVaultEvent> An array of events that indicate the status of jobs to back up resources to the backup vault.An array of events that indicate the status of jobs to back up resources to the backup vault.final String
The name of a logical container where backups are stored.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the BackupVaultEvents property.final int
hashCode()
static Class
<? extends PutBackupVaultNotificationsRequest.Builder> final String
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example,arn:aws:sns:us-west-2:111122223333:MyVaultTopic
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 lowercase 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 lowercase letters, numbers, and hyphens.
-
snsTopicArn
The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
.- Returns:
- The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example,
arn:aws:sns:us-west-2:111122223333:MyVaultTopic
.
-
backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
-
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
-
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
-
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
-
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
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
hasBackupVaultEvents()
method.- Returns:
- An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
-
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
-
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
-
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
-
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
-
-
-
hasBackupVaultEvents
public final boolean hasBackupVaultEvents()For responses, this returns true if the service returned a value for the BackupVaultEvents property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
backupVaultEventsAsStrings
An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
-
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
-
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
-
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
-
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
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
hasBackupVaultEvents()
method.- Returns:
- An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
-
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
-
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
-
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
-
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutBackupVaultNotificationsRequest.Builder,
PutBackupVaultNotificationsRequest> - Specified by:
toBuilder
in classBackupRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends PutBackupVaultNotificationsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-