Interface UpdateArchiveRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateArchiveRequest.Builder,UpdateArchiveRequest>, EventBridgeRequest.Builder, SdkBuilder<UpdateArchiveRequest.Builder,UpdateArchiveRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateArchiveRequest
@Mutable @NotThreadSafe public static interface UpdateArchiveRequest.Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<UpdateArchiveRequest.Builder,UpdateArchiveRequest>

  • Method Details

    • archiveName

      UpdateArchiveRequest.Builder archiveName(String archiveName)

      The name of the archive to update.

      Parameters:
      archiveName - The name of the archive to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateArchiveRequest.Builder description(String description)

      The description for the archive.

      Parameters:
      description - The description for the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventPattern

      UpdateArchiveRequest.Builder eventPattern(String eventPattern)

      The event pattern to use to filter events sent to the archive.

      Parameters:
      eventPattern - The event pattern to use to filter events sent to the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retentionDays

      UpdateArchiveRequest.Builder retentionDays(Integer retentionDays)

      The number of days to retain events in the archive.

      Parameters:
      retentionDays - The number of days to retain events in the archive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyIdentifier

      UpdateArchiveRequest.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

      The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

      If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

      For more information, see Identify and view keys in the Key Management Service Developer Guide.

      If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

      For more information, see Encrypting archives in the Amazon EventBridge User Guide.

      Parameters:
      kmsKeyIdentifier - The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

      If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

      For more information, see Identify and view keys in the Key Management Service Developer Guide.

      If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

      For more information, see Encrypting archives in the Amazon EventBridge User Guide.

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

    • overrideConfiguration

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

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