CfnArchiveProps¶
-
class
aws_cdk.aws_events.
CfnArchiveProps
(*, source_arn, archive_name=None, description=None, event_pattern=None, retention_days=None)¶ Bases:
object
Properties for defining a
CfnArchive
.- Parameters
source_arn (
str
) – The ARN of the event bus that sends events to the archive.archive_name (
Optional
[str
]) – The name for the archive to create.description (
Optional
[str
]) – A description for the archive.event_pattern (
Optional
[Any
]) – An event pattern to use to filter events sent to the archive.retention_days (
Union
[int
,float
,None
]) – The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-archive.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_events as events # event_pattern: Any cfn_archive_props = events.CfnArchiveProps( source_arn="sourceArn", # the properties below are optional archive_name="archiveName", description="description", event_pattern=event_pattern, retention_days=123 )
Attributes
-
archive_name
¶ The name for the archive to create.
-
description
¶ A description for the archive.
-
event_pattern
¶ An event pattern to use to filter events sent to the archive.
-
retention_days
¶ The number of days to retain events for.
Default value is 0. If set to 0, events are retained indefinitely
- Link
- Return type
Union
[int
,float
,None
]
-
source_arn
¶ The ARN of the event bus that sends events to the archive.