Package software.amazon.awssdk.services.eventbridge.model

Interface CreateArchiveRequest.Builder

    • Method Detail

      • archiveName

        CreateArchiveRequest.Builder archiveName​(String archiveName)

        The name for the archive to create.

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

      • eventSourceArn

        CreateArchiveRequest.Builder eventSourceArn​(String eventSourceArn)

        The ARN of the event bus that sends events to the archive.

        Parameters:
        eventSourceArn - The ARN of the event bus that sends events to the archive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateArchiveRequest.Builder description​(String description)

        A description for the archive.

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

      • eventPattern

        CreateArchiveRequest.Builder eventPattern​(String eventPattern)

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

        Parameters:
        eventPattern - An 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

        CreateArchiveRequest.Builder retentionDays​(Integer retentionDays)

        The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

        Parameters:
        retentionDays - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyIdentifier

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