Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. events
  5. Archive

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.Archive

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Events::Archive

    Create Archive Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Archive(name: string, args: ArchiveArgs, opts?: CustomResourceOptions);
    @overload
def Archive(resource_name: str,
            args: ArchiveArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Archive(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            source_arn: Optional[str] = None,
            archive_name: Optional[str] = None,
            description: Optional[str] = None,
            event_pattern: Optional[Any] = None,
            kms_key_identifier: Optional[str] = None,
            retention_days: Optional[int] = None)
    func NewArchive(ctx *Context, name string, args ArchiveArgs, opts ...ResourceOption) (*Archive, error)
    public Archive(string name, ArchiveArgs args, CustomResourceOptions? opts = null)
    public Archive(String name, ArchiveArgs args)
public Archive(String name, ArchiveArgs args, CustomResourceOptions options)

    type: aws-native:events:Archive
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ArchiveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ArchiveArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ArchiveArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ArchiveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ArchiveArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Archive Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Archive resource accepts the following input properties:

    SourceArn string
    The ARN of the event bus that sends events to the archive.
    ArchiveName string
    The name for the archive to create.
    Description string
    A description for the archive.
    EventPattern object

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    KmsKeyIdentifier string

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

    RetentionDays int
    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
    SourceArn string
    The ARN of the event bus that sends events to the archive.
    ArchiveName string
    The name for the archive to create.
    Description string
    A description for the archive.
    EventPattern interface{}

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    KmsKeyIdentifier string

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

    RetentionDays int
    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
    sourceArn String
    The ARN of the event bus that sends events to the archive.
    archiveName String
    The name for the archive to create.
    description String
    A description for the archive.
    eventPattern Object

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    kmsKeyIdentifier String

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

    retentionDays Integer
    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
    sourceArn string
    The ARN of the event bus that sends events to the archive.
    archiveName string
    The name for the archive to create.
    description string
    A description for the archive.
    eventPattern any

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    kmsKeyIdentifier string

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

    retentionDays number
    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
    source_arn str
    The ARN of the event bus that sends events to the archive.
    archive_name str
    The name for the archive to create.
    description str
    A description for the archive.
    event_pattern Any

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    kms_key_identifier str

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

    retention_days int
    The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
    sourceArn String
    The ARN of the event bus that sends events to the archive.
    archiveName String
    The name for the archive to create.
    description String
    A description for the archive.
    eventPattern Any

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

    Search the CloudFormation User Guide for AWS::Events::Archive for more information about the expected schema for this property.

    kmsKeyIdentifier String

    The identifier of the AWS 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 AWS owned key to encrypt the archive.

    For more information, see Identify and view keys in the AWS 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 .

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Archive resource produces the following output properties:

    Arn string
    The ARN of the archive created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN of the archive created.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the archive created.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN of the archive created.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN of the archive created.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the archive created.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native