annotations property

Input<Map<String, String>> annotations
final

Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Note: The Cloud Run API may add additional annotations that were not provided in your config. If terraform plan shows a diff where a server-side annotation is added, you can add it to your config or apply the lifecycle.ignore_changes rule to the metadata.0.annotations field.

Annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted. Use the following annotation keys to configure features on a Service:

  • 'run.googleapis.com/binary-authorization-breakglass' sets the Binary Authorization breakglass.
  • 'run.googleapis.com/binary-authorization' sets the Binary Authorization.
  • 'run.googleapis.com/client-name' sets the client name calling the Cloud Run API.
  • 'run.googleapis.com/custom-audiences' sets the custom audiences that can be used in the audience field of ID token for authenticated requests.
  • 'run.googleapis.com/description' sets a user defined description for the Service.
  • 'run.googleapis.com/ingress' sets the ingress settings for the Service. For example, '"run.googleapis.com/ingress" = "all"'.
  • 'run.googleapis.com/launch-stage' sets the launch stage when a preview feature is used. For example, '"run.googleapis.com/launch-stage": "BETA"'
  • 'run.googleapis.com/minScale' sets the minimum number of container instances of the Service.
  • 'run.googleapis.com/scalingMode' sets the type of scaling mode for the service. The supported values for scaling mode are "manual" and "automatic". If not provided, it defaults to "automatic".
  • 'run.googleapis.com/manualInstanceCount' sets the total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.

Implementation

final pulumi.Input<Map<String, String>> annotations;