aws-native.events.getArchive

AWS Cloud Control v1.58.0, Mar 23 26

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

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

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

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getArchive

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getArchive(args: GetArchiveArgs, opts?: InvokeOptions): Promise<GetArchiveResult>
function getArchiveOutput(args: GetArchiveOutputArgs, opts?: InvokeOptions): Output<GetArchiveResult>

def get_archive(archive_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetArchiveResult
def get_archive_output(archive_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetArchiveResult]

func LookupArchive(ctx *Context, args *LookupArchiveArgs, opts ...InvokeOption) (*LookupArchiveResult, error)
func LookupArchiveOutput(ctx *Context, args *LookupArchiveOutputArgs, opts ...InvokeOption) LookupArchiveResultOutput

> Note: This function is named LookupArchive in the Go SDK.

public static class GetArchive 
{
    public static Task<GetArchiveResult> InvokeAsync(GetArchiveArgs args, InvokeOptions? opts = null)
    public static Output<GetArchiveResult> Invoke(GetArchiveInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetArchiveResult> getArchive(GetArchiveArgs args, InvokeOptions options)
public static Output<GetArchiveResult> getArchive(GetArchiveArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:events:getArchive
  arguments:
    # arguments dictionary

The following arguments are supported:

ArchiveName string: The name for the archive to create.

ArchiveName string: The name for the archive to create.

archiveName String: The name for the archive to create.

archiveName string: The name for the archive to create.

archive_name str: The name for the archive to create.

archiveName String: The name for the archive to create.

getArchive Result

The following output properties are available:

Arn string

The ARN of the archive created.

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

Arn string

The ARN of the archive created.

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

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

arn String

The ARN of the archive created.

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

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

arn string

The ARN of the archive created.

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

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

arn str

The ARN of the archive created.

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

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

arn String

The ARN of the archive created.

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

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