Archive
eventbridge.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | eventbridge-controller/apis/v1alpha1#Archive |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Archive |
| ListKind | ArchiveList |
| Plural | archives |
| Singular | archive |
An Archive object that contains details about an archive.
Spec
description: string
eventPattern: string
eventSourceARN: string
eventSourceRef:
from:
name: string
name: string
retentionDays: integer
| Field | Description |
|---|---|
| description Optional | string A description for the archive. |
| eventPattern Optional | string An event pattern to use to filter events sent to the archive. |
| eventSourceARN Optional | string The ARN of the event bus that sends events to the archive. |
| eventSourceRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| eventSourceRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| eventSourceRef.from.name Optional | string |
| name Required | string The name for the archive to create. |
| retentionDays Optional | integer The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
state: string
stateReason: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| creationTime Optional | string The time at which the archive was created. |
| state Optional | string The state of the archive that was created. |
| stateReason Optional | string The reason that the archive is in the state. |