Interface PutBackupVaultNotificationsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>, SdkBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutBackupVaultNotificationsRequest
public static interface PutBackupVaultNotificationsRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<PutBackupVaultNotificationsRequest.Builder,PutBackupVaultNotificationsRequest>

  • Method Details

    • backupVaultName

      PutBackupVaultNotificationsRequest.Builder backupVaultName(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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snsTopicArn

      PutBackupVaultNotificationsRequest.Builder snsTopicArn(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.

    • backupVaultEventsWithStrings

      PutBackupVaultNotificationsRequest.Builder backupVaultEventsWithStrings(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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the 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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

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

    • backupVaultEventsWithStrings

      PutBackupVaultNotificationsRequest.Builder backupVaultEventsWithStrings(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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the 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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

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

    • backupVaultEvents

      PutBackupVaultNotificationsRequest.Builder backupVaultEvents(Collection<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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the 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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

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

    • backupVaultEvents

      PutBackupVaultNotificationsRequest.Builder backupVaultEvents(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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the 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 includes both supported events and deprecated events that are no longer in use (for reference). Deprecated events do not return statuses or notifications. Refer to the list above for the supported events.

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

    • overrideConfiguration

      PutBackupVaultNotificationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutBackupVaultNotificationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.