Managed Prometheus

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

API Group: aws.konfig.io/v1alpha1

PrometheusAlertManagerDefinition # GA

PrometheusAlertManagerDefinition is the Schema for managing alert manager definitions in Amazon Managed Prometheus workspaces.

kubectl get prometheusalertmanagerdefinitions · example on GitHub

Example

# PrometheusAlertManagerDefinition — Managed Prometheus
# 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/amp.html#prometheusalertmanagerdefinition
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusAlertManagerDefinition
metadata:
  name: example-prometheusalertmanagerdefinition
  namespace: default
spec:
  definition: example
  providerRef:
    name: example-prometheusalertmanagerdefinition
    region: us-east-1
  workspaceRef:
    name: example-prometheusalertmanagerdefinition

Spec

Field	Type	Required	Description
`definition`	string	yes	Definition is the alert manager definition, as a YAML string.
`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.
`workspaceRef`	object	yes	WorkspaceRef references the Prometheus workspace holding the definition.
`workspaceRef.name`	string	—	Name of a PrometheusWorkspace CR in the same namespace.
`workspaceRef.workspaceId`	string	—	WorkspaceID is a direct AWS workspace ID (ws-...), bypassing CR lookup.

Status

Field	Type	Required	Description
`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.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`workspaceId`	string	—	WorkspaceID is the resolved AWS workspace ID the definition was created in.

PrometheusAnomalyDetector # CLOUD CONTROL · AWS::APS::AnomalyDetector

PrometheusAnomalyDetector manages AWS::APS::AnomalyDetector through the AWS Cloud Control API.

kubectl get prometheusanomalydetectors · example on GitHub

Example

# PrometheusAnomalyDetector — Managed Prometheus
# 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/amp.html#prometheusanomalydetector
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusAnomalyDetector
metadata:
  name: example-prometheusanomalydetector
  namespace: default
spec:
  alias: example
  configuration:
    randomCutForest:
      ignoreNearExpectedFromAbove:
        amount: 1
        ratio: 1
      ignoreNearExpectedFromBelow:
        amount: 1
        ratio: 1
      query: example
      sampleSize: 256
      shingleSize: 2
  evaluationIntervalInSeconds: 300
  labels:
  - key: example
    value: example
  missingDataAction:
    markAsAnomaly: false
    skip: false
  providerRef:
    name: example-prometheusanomalydetector
    region: us-east-1
  tags:
  - key: example
    value: example
  workspace: example

Spec

Field	Type	Required	Description
`alias`	string	yes	The AnomalyDetector alias.
`configuration`	object	yes	Determines the anomaly detector's algorithm and its configuration.
`configuration.randomCutForest`	object	yes	PrometheusAnomalyDetectorRandomCutForestConfiguration is a nested property type of AWS::APS::AnomalyDetector.
`configuration.randomCutForest.ignoreNearExpectedFromAbove`	object	—	PrometheusAnomalyDetectorRandomCutForestConfigurationIgnoreNearExpectedFromAbove is a nested property type of AWS::APS::AnomalyDetector.
`configuration.randomCutForest.ignoreNearExpectedFromAbove.amount`	number	—
`configuration.randomCutForest.ignoreNearExpectedFromAbove.ratio`	number	—
`configuration.randomCutForest.ignoreNearExpectedFromBelow`	object	—	PrometheusAnomalyDetectorRandomCutForestConfigurationIgnoreNearExpectedFromBelow is a nested property type of AWS::APS::AnomalyDetector.
`configuration.randomCutForest.ignoreNearExpectedFromBelow.amount`	number	—
`configuration.randomCutForest.ignoreNearExpectedFromBelow.ratio`	number	—
`configuration.randomCutForest.query`	string	yes
`configuration.randomCutForest.sampleSize`	integer	—
`configuration.randomCutForest.shingleSize`	integer	—
`evaluationIntervalInSeconds`	integer	—	The AnomalyDetector period of detection and metric generation.
`labels`	array<object>	—	An array of key-value pairs to provide meta-data.
`labels[].key`	string	yes
`labels[].value`	string	yes
`missingDataAction`	object	—	The action to perform when running the expression returns no data.
`missingDataAction.markAsAnomaly`	boolean	—
`missingDataAction.skip`	boolean	—
`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
`workspace`	string	yes	Required to identify a specific APS Workspace associated with this Anomaly Detector.

Status

Field	Type	Required	Description
`arn`	string	—	The AnomalyDetector ARN.
`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.

PrometheusResourcePolicy # CLOUD CONTROL · AWS::APS::ResourcePolicy

PrometheusResourcePolicy manages AWS::APS::ResourcePolicy through the AWS Cloud Control API.

kubectl get prometheusresourcepolicies · example on GitHub

Example

# PrometheusResourcePolicy — Managed Prometheus
# 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/amp.html#prometheusresourcepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusResourcePolicy
metadata:
  name: example-prometheusresourcepolicy
  namespace: default
spec:
  policyDocument: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"],
    "Resource": "*"}]}'
  providerRef:
    name: example-prometheusresourcepolicy
    region: us-east-1
  workspaceArn: arn:aws:iam::123456789012:role/example-role

Spec

Field	Type	Required	Description
`policyDocument`	string	yes	The JSON to use as the Resource-based Policy.
`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.
`workspaceArn`	string	yes	The Arn of an APS Workspace that the PolicyDocument will be attached to.

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.

PrometheusRuleGroupsNamespace # GA

PrometheusRuleGroupsNamespace is the Schema for managing rule groups namespaces in Amazon Managed Prometheus workspaces.

kubectl get prometheusrulegroupsnamespaces · example on GitHub

Example

# PrometheusRuleGroupsNamespace — Managed Prometheus
# 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/amp.html#prometheusrulegroupsnamespace
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusRuleGroupsNamespace
metadata:
  name: example-prometheusrulegroupsnamespace
  namespace: default
spec:
  data: example
  name: example-prometheusrulegroupsnamespace
  providerRef:
    name: example-prometheusrulegroupsnamespace
    region: us-east-1
  tags:
    environment: dev
    team: platform
  workspaceRef:
    name: example-prometheusrulegroupsnamespace

Spec

Field	Type	Required	Description
`data`	string	yes	Data is the rule groups file for the namespace, as a YAML string.
`name`	string	yes	Name is the name of the rule groups namespace.
`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`	map<string>	—	Tags are AWS resource tags to apply at creation time.
`workspaceRef`	object	yes	WorkspaceRef references the Prometheus workspace containing the namespace.
`workspaceRef.name`	string	—	Name of a PrometheusWorkspace CR in the same namespace.
`workspaceRef.workspaceId`	string	—	WorkspaceID is a direct AWS workspace ID (ws-...), bypassing CR lookup.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the rule groups namespace.
`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.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`workspaceId`	string	—	WorkspaceID is the resolved AWS workspace ID the namespace was created in.

PrometheusScraper # CLOUD CONTROL · AWS::APS::Scraper

PrometheusScraper manages AWS::APS::Scraper through the AWS Cloud Control API.

kubectl get prometheusscrapers · example on GitHub

Example

# PrometheusScraper — Managed Prometheus
# 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/amp.html#prometheusscraper
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusScraper
metadata:
  name: example-prometheusscraper
  namespace: default
spec:
  alias: example
  destination:
    ampConfiguration:
      workspaceArn: arn:aws:iam::123456789012:role/example-role
    cloudWatchConfiguration:
      datasetArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-prometheusscraper
    region: us-east-1
  roleConfiguration:
    sourceRoleArn: arn:aws:iam::123456789012:role/example-role
    targetRoleArn: arn:aws:iam::123456789012:role/example-role
  scrapeConfiguration:
    configurationBlob: example
  scraperLoggingConfiguration:
    loggingDestination:
      cloudWatchLogs:
        logGroupArn: arn:aws:iam::123456789012:role/example-role
    scraperComponents:
    - type: SERVICE_DISCOVERY
  source:
    eksConfiguration:
      clusterArn: arn:aws:iam::123456789012:role/example-role
      securityGroupIds:
      - example
      subnetIds:
      - example
    vpcConfiguration:
      securityGroupIds:
      - example
      subnetIds:
      - example
  tags:
  - key: example
    value: example

Spec

Field	Type	Required	Description
`alias`	string	—	Scraper alias.
`destination`	object	yes	PrometheusScraperDestination is a nested property type of AWS::APS::Scraper.
`destination.ampConfiguration`	object	—	Configuration for Amazon Managed Prometheus metrics destination
`destination.ampConfiguration.workspaceArn`	string	yes	ARN of an Amazon Managed Prometheus workspace
`destination.cloudWatchConfiguration`	object	—	Configuration for CloudWatch metrics destination
`destination.cloudWatchConfiguration.datasetArn`	string	yes	ARN of a CloudWatch dataset
`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.
`roleConfiguration`	object	—	PrometheusScraperRoleConfiguration is a nested property type of AWS::APS::Scraper.
`roleConfiguration.sourceRoleArn`	string	—	IAM Role in source account
`roleConfiguration.targetRoleArn`	string	—	IAM Role in the target account
`scrapeConfiguration`	object	yes	PrometheusScraperScrapeConfiguration is a nested property type of AWS::APS::Scraper.
`scrapeConfiguration.configurationBlob`	string	—	Prometheus compatible scrape configuration in base64 encoded blob format
`scraperLoggingConfiguration`	object	—	PrometheusScraperScraperLoggingConfiguration is a nested property type of AWS::APS::Scraper.
`scraperLoggingConfiguration.loggingDestination`	object	yes	PrometheusScraperScraperLoggingDestination is a nested property type of AWS::APS::Scraper.
`scraperLoggingConfiguration.loggingDestination.cloudWatchLogs`	object	—	PrometheusScraperCloudWatchLogDestination is a nested property type of AWS::APS::Scraper.
`scraperLoggingConfiguration.loggingDestination.cloudWatchLogs.logGroupArn`	string	—	ARN of the CloudWatch log group
`scraperLoggingConfiguration.scraperComponents`	array<object>	yes
`scraperLoggingConfiguration.scraperComponents[].config`	object	—	PrometheusScraperComponentConfig is a nested property type of AWS::APS::Scraper.
`scraperLoggingConfiguration.scraperComponents[].config.options`	map<string>	—
`scraperLoggingConfiguration.scraperComponents[].type`	enum	yes	Allowed: `SERVICE_DISCOVERY, COLLECTOR, EXPORTER`
`source`	object	yes	Create-only in AWS: changing it requires replacing the resource.
`source.eksConfiguration`	object	—	Configuration for EKS metrics source
`source.eksConfiguration.clusterArn`	string	yes	ARN of an EKS cluster
`source.eksConfiguration.securityGroupIds`	array<string>	—	List of security group IDs
`source.eksConfiguration.subnetIds`	array<string>	yes	List of subnet IDs
`source.vpcConfiguration`	object	—	Configuration for VPC metrics source
`source.vpcConfiguration.securityGroupIds`	array<string>	yes	List of security group IDs
`source.vpcConfiguration.subnetIds`	array<string>	yes	List of subnet IDs
`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	—	Scraper ARN.
`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.
`roleArn`	string	—	IAM role ARN for the scraper.
`scraperId`	string	—	Required to identify a specific scraper.

PrometheusWorkspace # GA

PrometheusWorkspace is the Schema for managing Amazon Managed Prometheus workspaces.

kubectl get prometheusworkspaces · example on GitHub

Example

# PrometheusWorkspace — Managed Prometheus
# 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/amp.html#prometheusworkspace
apiVersion: aws.konfig.io/v1alpha1
kind: PrometheusWorkspace
metadata:
  name: example-prometheusworkspace
  namespace: default
spec:
  alias: example
  kmsKeyArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-prometheusworkspace
    region: us-east-1
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`alias`	string	—	Alias is a friendly name assigned to the workspace.
`kmsKeyArn`	string	—	KMSKeyARN is the ARN of a customer managed KMS key used to encrypt data in the workspace.
`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`	map<string>	—	Tags are AWS resource tags to apply at creation time.

Status

Field	Type	Required	Description
`arn`	string	—	ARN is the ARN of the workspace.
`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.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`prometheusEndpoint`	string	—	PrometheusEndpoint is the Prometheus endpoint URL of the workspace.
`status`	string	—	Status is the current AWS status of the workspace (CREATING, ACTIVE, ...).
`workspaceId`	string	—	WorkspaceID is the unique ID of the workspace (ws-...).