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

Class PutBackupVaultNotificationsRequest

    • 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 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

        public final 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.

        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

        public final List<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.

        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 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.

      • backupVaultEventsAsStrings

        public final List<String> 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.

      • 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