Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.events.Archive
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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,
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
The Archive resource accepts the following input properties:
- Source
Arn string - The ARN of the event bus that sends events to the archive.
- Archive
Name string - The name for the archive to create.
- Description string
- A description for the archive.
- Event
Pattern object An event pattern to use to filter events sent to the archive.
Search the CloudFormation User Guide for
AWS::Events::Archivefor more information about the expected schema for this property.- Retention
Days int - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
- Source
Arn string - The ARN of the event bus that sends events to the archive.
- Archive
Name string - The name for the archive to create.
- Description string
- A description for the archive.
- Event
Pattern interface{} An event pattern to use to filter events sent to the archive.
Search the CloudFormation User Guide for
AWS::Events::Archivefor more information about the expected schema for this property.- Retention
Days int - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
- source
Arn String - The ARN of the event bus that sends events to the archive.
- archive
Name String - The name for the archive to create.
- description String
- A description for the archive.
- event
Pattern Object An event pattern to use to filter events sent to the archive.
Search the CloudFormation User Guide for
AWS::Events::Archivefor more information about the expected schema for this property.- retention
Days Integer - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
- source
Arn string - The ARN of the event bus that sends events to the archive.
- archive
Name string - The name for the archive to create.
- description string
- 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::Archivefor more information about the expected schema for this property.- retention
Days 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::Archivefor more information about the expected schema for this property.- retention_
days int - The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
- source
Arn String - The ARN of the event bus that sends events to the archive.
- archive
Name String - The name for the archive to create.
- description String
- 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::Archivefor more information about the expected schema for this property.- retention
Days 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:
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.