LogGroup
cloudwatchlogs.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | cloudwatchlogs-controller/apis/v1alpha1#LogGroup |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | LogGroup |
| ListKind | LogGroupList |
| Plural | loggroups |
| Singular | loggroup |
Represents a log group.
Spec
kmsKeyID: string
kmsKeyRef:
from:
name: string
namespace: string
name: string
retentionDays: integer
subscriptionFilters:
- destinationARN: string
distribution: string
filterName: string
filterPattern: string
roleARN: string
tags: {}
| Field | Description |
|---|---|
| kmsKeyID Optional | string The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms). |
| kmsKeyRef 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 |
| kmsKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsKeyRef.from.name Optional | string |
| kmsKeyRef.from.namespace Optional | string |
| name Required | string |
| retentionDays Optional | integer |
| subscriptionFilters Optional | array |
| subscriptionFilters.[] Required | object |
| subscriptionFilters.[].distribution Optional | string The method used to distribute log data to the destination, which can be either random or grouped by log stream. |
| subscriptionFilters.[].filterName Optional | string |
| subscriptionFilters.[].filterPattern Optional | string A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message. |
| subscriptionFilters.[].roleARN Optional | string |
| tags Optional | object The key-value pairs to use for the tags. You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html). |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: integer
dataProtectionStatus: string
metricFilterCount: integer
retentionInDays: integer
storedBytes: integer
| 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. 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 | integer The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. |
| dataProtectionStatus Optional | string Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html). |
| metricFilterCount Optional | integer The number of metric filters. |
| retentionInDays Optional | integer |
| storedBytes Optional | integer The number of bytes stored. |