com.amazonaws.services.backup.model

Class PutBackupVaultNotificationsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.PutBackupVaultNotificationsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutBackupVaultNotificationsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutBackupVaultNotificationsRequest()

Method Summary

Modifier and Type	Method and Description
PutBackupVaultNotificationsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getBackupVaultEvents() An array of events that indicate the status of jobs to back up resources to the backup vault.
String	getBackupVaultName() The name of a logical container where backups are stored.
String	getSNSTopicArn() 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.
int	hashCode()
void	setBackupVaultEvents(Collection<String> backupVaultEvents) An array of events that indicate the status of jobs to back up resources to the backup vault.
void	setBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
void	setSNSTopicArn(String 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.
String	toString() Returns a string representation of this object.
PutBackupVaultNotificationsRequest	withBackupVaultEvents(BackupVaultEvent... backupVaultEvents) An array of events that indicate the status of jobs to back up resources to the backup vault.
PutBackupVaultNotificationsRequest	withBackupVaultEvents(Collection<String> backupVaultEvents) An array of events that indicate the status of jobs to back up resources to the backup vault.
PutBackupVaultNotificationsRequest	withBackupVaultEvents(String... backupVaultEvents) An array of events that indicate the status of jobs to back up resources to the backup vault.
PutBackupVaultNotificationsRequest	withBackupVaultName(String backupVaultName) The name of a logical container where backups are stored.
PutBackupVaultNotificationsRequest	withSNSTopicArn(String 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutBackupVaultNotificationsRequest

public PutBackupVaultNotificationsRequest()

Method Detail

setBackupVaultName

public void setBackupVaultName(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 lowercase letters, numbers, and hyphens.

Parameters:

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.

getBackupVaultName

public String getBackupVaultName()

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.

withBackupVaultName

public PutBackupVaultNotificationsRequest withBackupVaultName(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 lowercase letters, numbers, and hyphens.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSNSTopicArn

public void setSNSTopicArn(String 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.

Parameters:

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.

getSNSTopicArn

public String getSNSTopicArn()

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.

withSNSTopicArn

public PutBackupVaultNotificationsRequest withSNSTopicArn(String 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getBackupVaultEvents

public List<String> getBackupVaultEvents()

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.

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.

See Also:

BackupVaultEvent

setBackupVaultEvents

public void setBackupVaultEvents(Collection<String> 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.

Parameters:

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.

See Also:

BackupVaultEvent

withBackupVaultEvents

public PutBackupVaultNotificationsRequest withBackupVaultEvents(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setBackupVaultEvents(java.util.Collection) or withBackupVaultEvents(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupVaultEvent

withBackupVaultEvents

public PutBackupVaultNotificationsRequest withBackupVaultEvents(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupVaultEvent

withBackupVaultEvents

public PutBackupVaultNotificationsRequest withBackupVaultEvents(BackupVaultEvent... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupVaultEvent

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 PutBackupVaultNotificationsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()