Observability Admin

6 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

ObservabilityAdminOrganizationCentralizationRule # CLOUD CONTROL · AWS::ObservabilityAdmin::OrganizationCentralizationRule ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: organization-wide telemetry rule. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ObservabilityAdminOrganizationCentralizationRule manages AWS::ObservabilityAdmin::OrganizationCentralizationRule through the AWS Cloud Control API.

kubectl get observabilityadminorganizationcentralizationrules · example on GitHub

Example

# ObservabilityAdminOrganizationCentralizationRule — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadminorganizationcentralizationrule
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminOrganizationCentralizationRule
metadata:
  name: example-observabilityadminorganizationcentralizationrule
  namespace: default
spec:
  providerRef:
    name: example-observabilityadminorganizationcentralizationrule
    region: us-east-1
  rule:
    destination:
      account: example
      region: us-east-1
    source:
      regions:
      - example
      scope: example
      sourceLogsConfiguration:
        dataSourceSelectionCriteria: example
        encryptedLogGroupStrategy: ALLOW
        logGroupSelectionCriteria: example
      sourceMetricsConfiguration:
        metricsSelectionCriteria: example
  ruleName: example-observabilityadminorganizationcentralizationrule
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`rule`	object	yes	ObservabilityAdminOrganizationCentralizationRuleCentralizationRule is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination`	object	yes	ObservabilityAdminOrganizationCentralizationRuleCentralizationRuleDestination is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.account`	string	—
`rule.destination.destinationLogsConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleDestinationLogsConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationLogsConfiguration.backupConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleLogsBackupConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationLogsConfiguration.backupConfiguration.kmsKeyArn`	string	—
`rule.destination.destinationLogsConfiguration.backupConfiguration.region`	string	yes
`rule.destination.destinationLogsConfiguration.logGroupNameConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleLogGroupNameConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationLogsConfiguration.logGroupNameConfiguration.logGroupNamePattern`	string	yes
`rule.destination.destinationLogsConfiguration.logsEncryptionConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleLogsEncryptionConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationLogsConfiguration.logsEncryptionConfiguration.encryptionConflictResolutionStrategy`	enum	—	Allowed: `ALLOW, SKIP`
`rule.destination.destinationLogsConfiguration.logsEncryptionConfiguration.encryptionScope`	enum	—	Allowed: `ENCRYPTED_SOURCE_ONLY, NEW_DESTINATION_LOG_GROUPS`
`rule.destination.destinationLogsConfiguration.logsEncryptionConfiguration.encryptionStrategy`	enum	yes	Allowed: `CUSTOMER_MANAGED, AWS_OWNED`
`rule.destination.destinationLogsConfiguration.logsEncryptionConfiguration.kmsKeyArn`	string	—
`rule.destination.destinationLogsConfiguration.tagPropagationConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleTagPropagationConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationLogsConfiguration.tagPropagationConfiguration.destinationRoleArn`	string	yes	The ARN of the destination account IAM role used for tag propagation.
`rule.destination.destinationLogsConfiguration.tagPropagationConfiguration.tagConflictResolutionStrategy`	enum	—	The strategy to resolve tag conflicts during propagation. Allowed: `IN_SYNC, ADD_ONLY, UPDATE_SYNC`
`rule.destination.destinationMetricsConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleDestinationMetricsConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationMetricsConfiguration.backupConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleMetricsBackupConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.destination.destinationMetricsConfiguration.backupConfiguration.region`	string	yes
`rule.destination.region`	string	yes
`rule.source`	object	yes	ObservabilityAdminOrganizationCentralizationRuleCentralizationRuleSource is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.source.regions`	array<string>	yes
`rule.source.scope`	string	—
`rule.source.sourceLogsConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleSourceLogsConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.source.sourceLogsConfiguration.dataSourceSelectionCriteria`	string	—
`rule.source.sourceLogsConfiguration.encryptedLogGroupStrategy`	enum	yes	Allowed: `ALLOW, SKIP`
`rule.source.sourceLogsConfiguration.logGroupSelectionCriteria`	string	—
`rule.source.sourceMetricsConfiguration`	object	—	ObservabilityAdminOrganizationCentralizationRuleSourceMetricsConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationCentralizationRule.
`rule.source.sourceMetricsConfiguration.metricsSelectionCriteria`	string	—
`ruleName`	string	yes	Create-only in AWS: changing it requires replacing the resource.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource.
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`ruleArn`	string	—	Read-only: reported by AWS after creation.

ObservabilityAdminOrganizationTelemetryRule # CLOUD CONTROL · AWS::ObservabilityAdmin::OrganizationTelemetryRule ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: organization-wide telemetry rule. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ObservabilityAdminOrganizationTelemetryRule manages AWS::ObservabilityAdmin::OrganizationTelemetryRule through the AWS Cloud Control API.

kubectl get observabilityadminorganizationtelemetryrules · example on GitHub

Example

# ObservabilityAdminOrganizationTelemetryRule — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadminorganizationtelemetryrule
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminOrganizationTelemetryRule
metadata:
  name: example-observabilityadminorganizationtelemetryrule
  namespace: default
spec:
  providerRef:
    name: example-observabilityadminorganizationtelemetryrule
    region: us-east-1
  rule:
    allRegions: false
    allowFieldUpdates: false
    destinationConfiguration:
      cloudtrailParameters:
        advancedEventSelectors:
        - fieldSelectors:
          - endsWith:
            - example
            equals:
            - example
            field: example
            notEndsWith:
            - example
            notEquals:
            - example
            notStartsWith:
            - example
            startsWith:
            - example
          name: example-observabilityadminorganizationtelemetryrule
      destinationPattern: example
      destinationType: cloud-watch-logs
      elbLoadBalancerLoggingParameters:
        fieldDelimiter: example
        outputFormat: plain
      kmsKeyArn: arn:aws:iam::123456789012:role/example-role
      logDeliveryParameters:
        logTypes:
        - example
      retentionInDays: 7
      vpcFlowLogParameters:
        logFormat: example
        maxAggregationInterval: 1
        trafficType: example
      wafLoggingParameters:
        logType: WAF_LOGS
        redactedFields:
        - method: example
          queryString: example
          uriPath: example
    regions:
    - example
    resourceType: example
    scope: example
    selectionCriteria: example
    telemetrySourceTypes:
    - example
    telemetryType: Logs
  ruleName: example-observabilityadminorganizationtelemetryrule
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`rule`	object	yes	ObservabilityAdminOrganizationTelemetryRuleTelemetryRule is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.allRegions`	boolean	—	When true, the rule is replicated to all supported regions
`rule.allowFieldUpdates`	boolean	—
`rule.destinationConfiguration`	object	—	ObservabilityAdminOrganizationTelemetryRuleTelemetryDestinationConfiguration is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.cloudtrailParameters`	object	—	ObservabilityAdminOrganizationTelemetryRuleCloudtrailParameters is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors`	array<object>	yes	Create fine-grained selectors for AWS CloudTrail management and data.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors`	array<object>	yes	Contains all selector statements in an advanced event selector.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].endsWith`	array<string>	—	An operator that includes events that match the last few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].equals`	array<string>	—	An operator that includes events that match the exact value of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].field`	string	—	A field in a CloudTrail event record on which to filter events to be logged
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notEndsWith`	array<string>	—	An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notEquals`	array<string>	—	An operator that excludes events that match the exact value of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notStartsWith`	array<string>	—	An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].startsWith`	array<string>	—	An operator that includes events that match the first few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].name`	string	—	An optional descriptive name for the advanced event selector
`rule.destinationConfiguration.destinationPattern`	string	—
`rule.destinationConfiguration.destinationType`	enum	—	Allowed: `cloud-watch-logs`
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters`	object	—	ObservabilityAdminOrganizationTelemetryRuleELBLoadBalancerLoggingParameters is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters.fieldDelimiter`	string	—	A delimiter to delineate log fields
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters.outputFormat`	enum	—	Allowed: `plain, json`
`rule.destinationConfiguration.kmsKeyArn`	string	—
`rule.destinationConfiguration.logDeliveryParameters`	object	—	Parameters for log delivery configuration
`rule.destinationConfiguration.logDeliveryParameters.logTypes`	array<string>	—	Types of logs to deliver
`rule.destinationConfiguration.retentionInDays`	integer	—
`rule.destinationConfiguration.vpcFlowLogParameters`	object	—	ObservabilityAdminOrganizationTelemetryRuleVPCFlowLogParameters is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.vpcFlowLogParameters.logFormat`	string	—	The fields to include in the flow log record.
`rule.destinationConfiguration.vpcFlowLogParameters.maxAggregationInterval`	integer	—	The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`rule.destinationConfiguration.vpcFlowLogParameters.trafficType`	string	—	The type of traffic captured for the flow log.
`rule.destinationConfiguration.wafLoggingParameters`	object	—	ObservabilityAdminOrganizationTelemetryRuleWAFLoggingParameters is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.logType`	enum	—	Allowed: `WAF_LOGS`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter`	object	—	ObservabilityAdminOrganizationTelemetryRuleLoggingFilter is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.defaultBehavior`	enum	—	Allowed: `KEEP, DROP`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters`	array<object>	—
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].behavior`	enum	—	Allowed: `KEEP, DROP`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].conditions`	array<object>	—
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].requirement`	enum	—	Allowed: `MEETS_ALL, MEETS_ANY`
`rule.destinationConfiguration.wafLoggingParameters.redactedFields`	array<object>	—	Fields not to be included in the logs.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].method`	string	—	The method with which to match this rule.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].queryString`	string	—	The query string to find the resource to match this field to.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].singleHeader`	object	—	ObservabilityAdminOrganizationTelemetryRuleSingleHeader is a nested property type of AWS::ObservabilityAdmin::OrganizationTelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].singleHeader.name`	string	yes	The name of the header
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].uriPath`	string	—	This is the URI path to match this rule to.
`rule.regions`	array<string>	—	List of AWS region codes where the rule should be replicated
`rule.resourceType`	string	yes
`rule.scope`	string	—
`rule.selectionCriteria`	string	—
`rule.telemetrySourceTypes`	array<string>	—
`rule.telemetryType`	enum	yes	Allowed: `Logs, Metrics`
`ruleName`	string	yes	The name of the organization telemetry rule Create-only in AWS: changing it requires replacing the resource.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`regionStatuses`	array<object>	—	Per-region replication status of the rule Read-only: reported by AWS after creation.
`regionStatuses[].region`	string	—	The AWS region code
`regionStatuses[].ruleArn`	string	—	The ARN of the rule in this region
`regionStatuses[].status`	string	—	The replication status of the rule in this region
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`ruleArn`	string	—	The arn of the organization telemetry rule Read-only: reported by AWS after creation.

ObservabilityAdminS3TableIntegration # CLOUD CONTROL · AWS::ObservabilityAdmin::S3TableIntegration

ObservabilityAdminS3TableIntegration manages AWS::ObservabilityAdmin::S3TableIntegration through the AWS Cloud Control API.

kubectl get observabilityadmins3tableintegrations · example on GitHub

Example

# ObservabilityAdminS3TableIntegration — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadmins3tableintegration
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminS3TableIntegration
metadata:
  name: example-observabilityadmins3tableintegration
  namespace: default
spec:
  encryption:
    kmsKeyArn: arn:aws:iam::123456789012:role/example-role
    sseAlgorithm: example
  logSources:
  - identifier: example
    name: example-observabilityadmins3tableintegration
    type: example
  providerRef:
    name: example-observabilityadmins3tableintegration
    region: us-east-1
  roleArn: arn:aws:iam::123456789012:role/example-role
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`encryption`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`encryption.kmsKeyArn`	string	—	The ARN of the KMS key used to encrypt the S3 Table Integration
`encryption.sseAlgorithm`	string	yes	The server-side encryption algorithm used to encrypt the S3 Table(s) data
`logSources`	array<object>	—	The CloudWatch Logs data sources to associate with the S3 Table Integration
`logSources[].identifier`	string	—	The ID of the CloudWatch Logs data source association
`logSources[].name`	string	yes	The name of the CloudWatch Logs data source
`logSources[].type`	string	yes	The type of the CloudWatch Logs data source
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`roleArn`	string	yes	The ARN of the role used to access the S3 Table Integration Create-only in AWS: changing it requires replacing the resource.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	The ARN of the S3 Table Integration Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.

ObservabilityAdminTelemetryEnrichment # CLOUD CONTROL · AWS::ObservabilityAdmin::TelemetryEnrichment

ObservabilityAdminTelemetryEnrichment manages AWS::ObservabilityAdmin::TelemetryEnrichment through the AWS Cloud Control API.

kubectl get observabilityadmintelemetryenrichments · example on GitHub

Example

# ObservabilityAdminTelemetryEnrichment — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadmintelemetryenrichment
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminTelemetryEnrichment
metadata:
  name: example-observabilityadmintelemetryenrichment
  namespace: default
spec:
  providerRef:
    name: example-observabilityadmintelemetryenrichment
    region: us-east-1
  scope: ACCOUNT

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`scope`	enum	yes	Create-only in AWS: changing it requires replacing the resource. Allowed: `ACCOUNT`

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`status`	enum	—	Read-only: reported by AWS after creation. Allowed: `RUNNING, STOPPED, IMPAIRED`

ObservabilityAdminTelemetryPipelines # CLOUD CONTROL · AWS::ObservabilityAdmin::TelemetryPipelines

ObservabilityAdminTelemetryPipelines manages AWS::ObservabilityAdmin::TelemetryPipelines through the AWS Cloud Control API.

kubectl get observabilityadmintelemetrypipelines · example on GitHub

Example

# ObservabilityAdminTelemetryPipelines — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadmintelemetrypipelines
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminTelemetryPipelines
metadata:
  name: example-observabilityadmintelemetrypipelines
  namespace: default
spec:
  configuration:
    body: example
  name: example-observabilityadminte
  providerRef:
    name: example-observabilityadmintelemetrypipelines
    region: us-east-1
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`configuration`	object	yes	ObservabilityAdminTelemetryPipelinesTelemetryPipelineConfiguration is a nested property type of AWS::ObservabilityAdmin::TelemetryPipelines.
`configuration.body`	string	yes
`name`	string	—	Create-only in AWS: changing it requires replacing the resource.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`arn`	string	—	Read-only: reported by AWS after creation.
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`pipeline`	object	—	Read-only: reported by AWS after creation.
`pipeline.arn`	string	—
`pipeline.configuration`	object	—	ObservabilityAdminTelemetryPipelinesTelemetryPipelineConfiguration is a nested property type of AWS::ObservabilityAdmin::TelemetryPipelines.
`pipeline.configuration.body`	string	yes
`pipeline.createdTimeStamp`	number	—
`pipeline.lastUpdateTimeStamp`	number	—
`pipeline.name`	string	—
`pipeline.status`	enum	—	Allowed: `CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED`
`pipeline.statusReason`	object	—	ObservabilityAdminTelemetryPipelinesTelemetryPipelineStatusReason is a nested property type of AWS::ObservabilityAdmin::TelemetryPipelines.
`pipeline.statusReason.description`	string	—
`pipeline.tags`	array<object>	—	An array of key-value pairs to apply to this resource
`pipeline.tags[].key`	string	yes
`pipeline.tags[].value`	string	yes
`pipelineIdentifier`	string	—	Read-only: reported by AWS after creation.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`status`	enum	—	Read-only: reported by AWS after creation. Allowed: `CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED`
`statusReason`	object	—	Read-only: reported by AWS after creation.
`statusReason.description`	string	—

ObservabilityAdminTelemetryRule # CLOUD CONTROL · AWS::ObservabilityAdmin::TelemetryRule ⚠ DESTRUCTIVE SCOPE

Caution, destructive scope: account-wide telemetry rule. Provided for completeness; do not use from application namespaces. Restrict with AWSProvider.allowedNamespaces and RBAC. ObservabilityAdminTelemetryRule manages AWS::ObservabilityAdmin::TelemetryRule through the AWS Cloud Control API.

kubectl get observabilityadmintelemetryrules · example on GitHub

Example

# ObservabilityAdminTelemetryRule — Observability Admin
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/observabilityadmin.html#observabilityadmintelemetryrule
apiVersion: aws.konfig.io/v1alpha1
kind: ObservabilityAdminTelemetryRule
metadata:
  name: example-observabilityadmintelemetryrule
  namespace: default
spec:
  providerRef:
    name: example-observabilityadmintelemetryrule
    region: us-east-1
  rule:
    allRegions: false
    allowFieldUpdates: false
    destinationConfiguration:
      cloudtrailParameters:
        advancedEventSelectors:
        - fieldSelectors:
          - endsWith:
            - example
            equals:
            - example
            field: example
            notEndsWith:
            - example
            notEquals:
            - example
            notStartsWith:
            - example
            startsWith:
            - example
          name: example-observabilityadmintelemetryrule
      destinationPattern: example
      destinationType: cloud-watch-logs
      elbLoadBalancerLoggingParameters:
        fieldDelimiter: example
        outputFormat: plain
      kmsKeyArn: arn:aws:iam::123456789012:role/example-role
      logDeliveryParameters:
        logTypes:
        - example
      retentionInDays: 7
      vpcFlowLogParameters:
        logFormat: example
        maxAggregationInterval: 1
        trafficType: example
      wafLoggingParameters:
        logType: WAF_LOGS
        redactedFields:
        - method: example
          queryString: example
          uriPath: example
    regions:
    - example
    resourceType: example
    selectionCriteria: example
    telemetrySourceTypes:
    - example
    telemetryType: Logs
  ruleName: example-observabilityadmintelemetryrule
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`rule`	object	yes	ObservabilityAdminTelemetryRuleTelemetryRule is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.allRegions`	boolean	—	When true, the rule is replicated to all supported regions
`rule.allowFieldUpdates`	boolean	—
`rule.destinationConfiguration`	object	—	ObservabilityAdminTelemetryRuleTelemetryDestinationConfiguration is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.cloudtrailParameters`	object	—	ObservabilityAdminTelemetryRuleCloudtrailParameters is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors`	array<object>	yes	Create fine-grained selectors for AWS CloudTrail management and data.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors`	array<object>	yes	Contains all selector statements in an advanced event selector.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].endsWith`	array<string>	—	An operator that includes events that match the last few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].equals`	array<string>	—	An operator that includes events that match the exact value of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].field`	string	—	A field in a CloudTrail event record on which to filter events to be logged
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notEndsWith`	array<string>	—	An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notEquals`	array<string>	—	An operator that excludes events that match the exact value of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].notStartsWith`	array<string>	—	An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].fieldSelectors[].startsWith`	array<string>	—	An operator that includes events that match the first few characters of the event record field specified as the value of Field.
`rule.destinationConfiguration.cloudtrailParameters.advancedEventSelectors[].name`	string	—	An optional descriptive name for the advanced event selector
`rule.destinationConfiguration.destinationPattern`	string	—
`rule.destinationConfiguration.destinationType`	enum	—	Allowed: `cloud-watch-logs`
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters`	object	—	ObservabilityAdminTelemetryRuleELBLoadBalancerLoggingParameters is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters.fieldDelimiter`	string	—	A delimiter to delineate log fields
`rule.destinationConfiguration.elbLoadBalancerLoggingParameters.outputFormat`	enum	—	Allowed: `plain, json`
`rule.destinationConfiguration.kmsKeyArn`	string	—
`rule.destinationConfiguration.logDeliveryParameters`	object	—	Parameters for log delivery configuration
`rule.destinationConfiguration.logDeliveryParameters.logTypes`	array<string>	—	Types of logs to deliver
`rule.destinationConfiguration.retentionInDays`	integer	—
`rule.destinationConfiguration.vpcFlowLogParameters`	object	—	ObservabilityAdminTelemetryRuleVPCFlowLogParameters is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.vpcFlowLogParameters.logFormat`	string	—	The fields to include in the flow log record.
`rule.destinationConfiguration.vpcFlowLogParameters.maxAggregationInterval`	integer	—	The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
`rule.destinationConfiguration.vpcFlowLogParameters.trafficType`	string	—	The type of traffic captured for the flow log.
`rule.destinationConfiguration.wafLoggingParameters`	object	—	ObservabilityAdminTelemetryRuleWAFLoggingParameters is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.logType`	enum	—	Allowed: `WAF_LOGS`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter`	object	—	ObservabilityAdminTelemetryRuleLoggingFilter is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.defaultBehavior`	enum	—	Allowed: `KEEP, DROP`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters`	array<object>	—
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].behavior`	enum	—	Allowed: `KEEP, DROP`
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].conditions`	array<object>	—
`rule.destinationConfiguration.wafLoggingParameters.loggingFilter.filters[].requirement`	enum	—	Allowed: `MEETS_ALL, MEETS_ANY`
`rule.destinationConfiguration.wafLoggingParameters.redactedFields`	array<object>	—	Fields not to be included in the logs.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].method`	string	—	The method with which to match this rule.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].queryString`	string	—	The query string to find the resource to match this field to.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].singleHeader`	object	—	ObservabilityAdminTelemetryRuleSingleHeader is a nested property type of AWS::ObservabilityAdmin::TelemetryRule.
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].singleHeader.name`	string	yes	The name of the header
`rule.destinationConfiguration.wafLoggingParameters.redactedFields[].uriPath`	string	—	This is the URI path to match this rule to.
`rule.regions`	array<string>	—	List of AWS region codes where the rule should be replicated
`rule.resourceType`	string	yes
`rule.selectionCriteria`	string	—
`rule.telemetrySourceTypes`	array<string>	—
`rule.telemetryType`	enum	yes	Allowed: `Logs, Traces, Metrics`
`ruleName`	string	yes	The name of the telemetry rule Create-only in AWS: changing it requires replacing the resource.
`tags`	array<object>	—	An array of key-value pairs to apply to this resource
`tags[].key`	string	yes
`tags[].value`	string	yes

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`regionStatuses`	array<object>	—	Per-region replication status of the rule Read-only: reported by AWS after creation.
`regionStatuses[].region`	string	—	The AWS region code
`regionStatuses[].ruleArn`	string	—	The ARN of the rule in this region
`regionStatuses[].status`	string	—	The replication status of the rule in this region
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.
`ruleArn`	string	—	The arn of the telemetry rule Read-only: reported by AWS after creation.