Skip to content

Latest commit

 

History

History
1069 lines (629 loc) · 55.6 KB

cloud_run_v2_job.md

File metadata and controls

1069 lines (629 loc) · 55.6 KB
Raw
permalink
/cloud_run_v2_job/

cloud_run_v2_job

cloud_run_v2_job represents the google_cloud_run_v2_job Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

Fields

fn new

new()

google.cloud_run_v2_job.new injects a new google_cloud_run_v2_job Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
google.cloud_run_v2_job.new('some_id')

You can get the reference to the id field of the created google.cloud_run_v2_job using the reference:

$._ref.google_cloud_run_v2_job.some_id.get('id')

This is the same as directly entering "${ google_cloud_run_v2_job.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

  • resourceLabel (string): The name label of the block.
  • annotations (obj): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.

This field follows Kubernetes annotations' namespacing, limits, and rules. When null, the annotations field will be omitted from the resulting object.

  • client (string): Arbitrary identifier for the API client. When null, the client field will be omitted from the resulting object.
  • client_version (string): Arbitrary version identifier for the API client. When null, the client_version field will be omitted from the resulting object.
  • labels (obj): Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. When null, the labels field will be omitted from the resulting object.

  • launch_stage (string): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When null, the launch_stage field will be omitted from the resulting object.

  • location (string): The location of the cloud run job When null, the location field will be omitted from the resulting object.
  • name (string): Name of the Job.
  • project (string): Set the project field on the resulting resource block. When null, the project field will be omitted from the resulting object.
  • binary_authorization (list[obj]): Settings for the Binary Authorization feature. When null, the binary_authorization sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.binary_authorization.new constructor.
  • template (list[obj]): The template used to create executions for this Job. When null, the template sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.new constructor.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.timeouts.new constructor.

Returns:

  • A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

google.cloud_run_v2_job.newAttrs constructs a new object with attributes and blocks configured for the cloud_run_v2_job Terraform resource.

Unlike google.cloud_run_v2_job.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

  • annotations (obj): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job.

This field follows Kubernetes annotations' namespacing, limits, and rules. When null, the annotations field will be omitted from the resulting object.

  • client (string): Arbitrary identifier for the API client. When null, the client field will be omitted from the resulting object.
  • client_version (string): Arbitrary version identifier for the API client. When null, the client_version field will be omitted from the resulting object.
  • labels (obj): Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. When null, the labels field will be omitted from the resulting object.

  • launch_stage (string): The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"] When null, the launch_stage field will be omitted from the resulting object.

  • location (string): The location of the cloud run job When null, the location field will be omitted from the resulting object.
  • name (string): Name of the Job.
  • project (string): Set the project field on the resulting object. When null, the project field will be omitted from the resulting object.
  • binary_authorization (list[obj]): Settings for the Binary Authorization feature. When null, the binary_authorization sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.binary_authorization.new constructor.
  • template (list[obj]): The template used to create executions for this Job. When null, the template sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.new constructor.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.timeouts.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new cloud_run_v2_job resource into the root Terraform configuration.

fn withAnnotations

withAnnotations()

google.obj.withAnnotations constructs a mixin object that can be merged into the obj Terraform resource block to set or update the annotations field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the annotations field.

fn withBinaryAuthorization

withBinaryAuthorization()

google.list[obj].withBinaryAuthorization constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the binary_authorization field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withBinaryAuthorizationMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the binary_authorization field.

fn withBinaryAuthorizationMixin

withBinaryAuthorizationMixin()

google.list[obj].withBinaryAuthorizationMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the binary_authorization field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withBinaryAuthorization function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the binary_authorization field.

fn withClient

withClient()

google.string.withClient constructs a mixin object that can be merged into the string Terraform resource block to set or update the client field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the client field.

fn withClientVersion

withClientVersion()

google.string.withClientVersion constructs a mixin object that can be merged into the string Terraform resource block to set or update the client_version field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the client_version field.

fn withLabels

withLabels()

google.obj.withLabels constructs a mixin object that can be merged into the obj Terraform resource block to set or update the labels field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the labels field.

fn withLaunchStage

withLaunchStage()

google.string.withLaunchStage constructs a mixin object that can be merged into the string Terraform resource block to set or update the launch_stage field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the launch_stage field.

fn withLocation

withLocation()

google.string.withLocation constructs a mixin object that can be merged into the string Terraform resource block to set or update the location field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the location field.

fn withName

withName()

google.string.withName constructs a mixin object that can be merged into the string Terraform resource block to set or update the name field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the name field.

fn withProject

withProject()

google.string.withProject constructs a mixin object that can be merged into the string Terraform resource block to set or update the project field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the project field.

fn withTemplate

withTemplate()

google.list[obj].withTemplate constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the template field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the google.list[obj].withTemplateMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the template field.

fn withTemplateMixin

withTemplateMixin()

google.list[obj].withTemplateMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the template field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the google.list[obj].withTemplate function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (list[obj]): The value to set for the template field.

fn withTimeouts

withTimeouts()

google.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the google.obj.withTimeoutsMixin function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

google.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the google.obj.withTimeouts function.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

obj binary_authorization

fn binary_authorization.new

new()

google.cloud_run_v2_job.binary_authorization.new constructs a new object with attributes and blocks configured for the binary_authorization Terraform sub block.

Args:

  • breakglass_justification (string): If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass When null, the breakglass_justification field will be omitted from the resulting object.
  • use_default (bool): If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled. When null, the use_default field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the binary_authorization sub block.

obj template

fn template.new

new()

google.cloud_run_v2_job.template.new constructs a new object with attributes and blocks configured for the template Terraform sub block.

Args:

  • annotations (obj): Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

This field follows Kubernetes annotations' namespacing, limits, and rules. When null, the annotations field will be omitted from the resulting object.

Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate. When null, the labels field will be omitted from the resulting object.

  • parallelism (number): Specifies the maximum desired number of tasks the execution should run at given time. Must be <= taskCount. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism. When null, the parallelism field will be omitted from the resulting object.
  • task_count (number): Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ When null, the task_count field will be omitted from the resulting object.
  • template (list[obj]): Describes the task(s) that will be created when executing an execution When null, the template sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.new constructor.

Returns:

  • An attribute object that represents the template sub block.

obj template.template

fn template.template.new

new()

google.cloud_run_v2_job.template.template.new constructs a new object with attributes and blocks configured for the template Terraform sub block.

Args:

  • encryption_key (string): A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek When null, the encryption_key field will be omitted from the resulting object.
  • execution_environment (string): The execution environment being used to host this Task. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"] When null, the execution_environment field will be omitted from the resulting object.
  • max_retries (number): Number of retries allowed per Task, before marking this Task failed. When null, the max_retries field will be omitted from the resulting object.
  • service_account (string): Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. When null, the service_account field will be omitted from the resulting object.
  • timeout (string): Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". When null, the timeout field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the template sub block.

obj template.template.containers

fn template.template.containers.new

new()

google.cloud_run_v2_job.template.template.containers.new constructs a new object with attributes and blocks configured for the containers Terraform sub block.

Args:

  • args (list): Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell When null, the args field will be omitted from the resulting object.
  • command (list): Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell When null, the command field will be omitted from the resulting object.
  • image (string): URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images
  • name (string): Name of the container specified as a DNS_LABEL. When null, the name field will be omitted from the resulting object.
  • working_dir (string): Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. When null, the working_dir field will be omitted from the resulting object.
  • env (list[obj]): List of environment variables to set in the container. When null, the env sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.env.new constructor.
  • liveness_probe (list[obj]): Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes This field is not supported in Cloud Run Job currently. When null, the liveness_probe sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.liveness_probe.new constructor.
  • ports (list[obj]): List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible.

If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on When null, the ports sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.ports.new constructor.

Returns:

  • An attribute object that represents the containers sub block.

obj template.template.containers.env

fn template.template.containers.env.new

new()

google.cloud_run_v2_job.template.template.containers.env.new constructs a new object with attributes and blocks configured for the env Terraform sub block.

Args:

  • name (string): Name of the environment variable. Must be a C_IDENTIFIER, and mnay not exceed 32768 characters.
  • value (string): Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "", and the maximum length is 32768 bytes When null, the value field will be omitted from the resulting object.
  • value_source (list[obj]): Source for the environment variable's value. When null, the value_source sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.env.value_source.new constructor.

Returns:

  • An attribute object that represents the env sub block.

obj template.template.containers.env.value_source

fn template.template.containers.env.value_source.new

new()

google.cloud_run_v2_job.template.template.containers.env.value_source.new constructs a new object with attributes and blocks configured for the value_source Terraform sub block.

Args:

Returns:

  • An attribute object that represents the value_source sub block.

obj template.template.containers.env.value_source.secret_key_ref

fn template.template.containers.env.value_source.secret_key_ref.new

new()

google.cloud_run_v2_job.template.template.containers.env.value_source.secret_key_ref.new constructs a new object with attributes and blocks configured for the secret_key_ref Terraform sub block.

Args:

  • secret (string): The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project.
  • version (string): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version.

Returns:

  • An attribute object that represents the secret_key_ref sub block.

obj template.template.containers.liveness_probe

fn template.template.containers.liveness_probe.new

new()

google.cloud_run_v2_job.template.template.containers.liveness_probe.new constructs a new object with attributes and blocks configured for the liveness_probe Terraform sub block.

Args:

  • failure_threshold (number): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When null, the failure_threshold field will be omitted from the resulting object.
  • initial_delay_seconds (number): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When null, the initial_delay_seconds field will be omitted from the resulting object.
  • period_seconds (number): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When null, the period_seconds field will be omitted from the resulting object.
  • timeout_seconds (number): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When null, the timeout_seconds field will be omitted from the resulting object.
  • http_get (list[obj]): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When null, the http_get sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.liveness_probe.http_get.new constructor.
  • tcp_socket (list[obj]): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When null, the tcp_socket sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.liveness_probe.tcp_socket.new constructor.

Returns:

  • An attribute object that represents the liveness_probe sub block.

obj template.template.containers.liveness_probe.http_get

fn template.template.containers.liveness_probe.http_get.new

new()

google.cloud_run_v2_job.template.template.containers.liveness_probe.http_get.new constructs a new object with attributes and blocks configured for the http_get Terraform sub block.

Args:

  • path (string): Path to access on the HTTP server. Defaults to '/'. When null, the path field will be omitted from the resulting object.
  • http_headers (list[obj]): Custom headers to set in the request. HTTP allows repeated headers. When null, the http_headers sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.liveness_probe.http_get.http_headers.new constructor.

Returns:

  • An attribute object that represents the http_get sub block.

obj template.template.containers.liveness_probe.http_get.http_headers

fn template.template.containers.liveness_probe.http_get.http_headers.new

new()

google.cloud_run_v2_job.template.template.containers.liveness_probe.http_get.http_headers.new constructs a new object with attributes and blocks configured for the http_headers Terraform sub block.

Args:

  • name (string): The header field name
  • value (string): The header field value When null, the value field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the http_headers sub block.

obj template.template.containers.liveness_probe.tcp_socket

fn template.template.containers.liveness_probe.tcp_socket.new

new()

google.cloud_run_v2_job.template.template.containers.liveness_probe.tcp_socket.new constructs a new object with attributes and blocks configured for the tcp_socket Terraform sub block.

Args:

  • port (number): Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. When null, the port field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the tcp_socket sub block.

obj template.template.containers.ports

fn template.template.containers.ports.new

new()

google.cloud_run_v2_job.template.template.containers.ports.new constructs a new object with attributes and blocks configured for the ports Terraform sub block.

Args:

  • container_port (number): Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536. When null, the container_port field will be omitted from the resulting object.
  • name (string): If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". When null, the name field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the ports sub block.

obj template.template.containers.resources

fn template.template.containers.resources.new

new()

google.cloud_run_v2_job.template.template.containers.resources.new constructs a new object with attributes and blocks configured for the resources Terraform sub block.

Args:

Returns:

  • An attribute object that represents the resources sub block.

obj template.template.containers.startup_probe

fn template.template.containers.startup_probe.new

new()

google.cloud_run_v2_job.template.template.containers.startup_probe.new constructs a new object with attributes and blocks configured for the startup_probe Terraform sub block.

Args:

  • failure_threshold (number): Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. When null, the failure_threshold field will be omitted from the resulting object.
  • initial_delay_seconds (number): Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When null, the initial_delay_seconds field will be omitted from the resulting object.
  • period_seconds (number): How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds When null, the period_seconds field will be omitted from the resulting object.
  • timeout_seconds (number): Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes When null, the timeout_seconds field will be omitted from the resulting object.
  • http_get (list[obj]): HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified. When null, the http_get sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.startup_probe.http_get.new constructor.
  • tcp_socket (list[obj]): TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified. When null, the tcp_socket sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.startup_probe.tcp_socket.new constructor.

Returns:

  • An attribute object that represents the startup_probe sub block.

obj template.template.containers.startup_probe.http_get

fn template.template.containers.startup_probe.http_get.new

new()

google.cloud_run_v2_job.template.template.containers.startup_probe.http_get.new constructs a new object with attributes and blocks configured for the http_get Terraform sub block.

Args:

  • path (string): Path to access on the HTTP server. Defaults to '/'. When null, the path field will be omitted from the resulting object.
  • http_headers (list[obj]): Custom headers to set in the request. HTTP allows repeated headers. When null, the http_headers sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.containers.startup_probe.http_get.http_headers.new constructor.

Returns:

  • An attribute object that represents the http_get sub block.

obj template.template.containers.startup_probe.http_get.http_headers

fn template.template.containers.startup_probe.http_get.http_headers.new

new()

google.cloud_run_v2_job.template.template.containers.startup_probe.http_get.http_headers.new constructs a new object with attributes and blocks configured for the http_headers Terraform sub block.

Args:

  • name (string): The header field name
  • value (string): The header field value When null, the value field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the http_headers sub block.

obj template.template.containers.startup_probe.tcp_socket

fn template.template.containers.startup_probe.tcp_socket.new

new()

google.cloud_run_v2_job.template.template.containers.startup_probe.tcp_socket.new constructs a new object with attributes and blocks configured for the tcp_socket Terraform sub block.

Args:

  • port (number): Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to 8080. When null, the port field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the tcp_socket sub block.

obj template.template.containers.volume_mounts

fn template.template.containers.volume_mounts.new

new()

google.cloud_run_v2_job.template.template.containers.volume_mounts.new constructs a new object with attributes and blocks configured for the volume_mounts Terraform sub block.

Args:

  • mount_path (string): Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
  • name (string): This must match the Name of a Volume.

Returns:

  • An attribute object that represents the volume_mounts sub block.

obj template.template.volumes

fn template.template.volumes.new

new()

google.cloud_run_v2_job.template.template.volumes.new constructs a new object with attributes and blocks configured for the volumes Terraform sub block.

Args:

Returns:

  • An attribute object that represents the volumes sub block.

obj template.template.volumes.cloud_sql_instance

fn template.template.volumes.cloud_sql_instance.new

new()

google.cloud_run_v2_job.template.template.volumes.cloud_sql_instance.new constructs a new object with attributes and blocks configured for the cloud_sql_instance Terraform sub block.

Args:

Returns:

  • An attribute object that represents the cloud_sql_instance sub block.

obj template.template.volumes.secret

fn template.template.volumes.secret.new

new()

google.cloud_run_v2_job.template.template.volumes.secret.new constructs a new object with attributes and blocks configured for the secret Terraform sub block.

Args:

  • default_mode (number): Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. When null, the default_mode field will be omitted from the resulting object.
  • secret (string): The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
  • items (list[obj]): If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. When null, the items sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.volumes.secret.items.new constructor.

Returns:

  • An attribute object that represents the secret sub block.

obj template.template.volumes.secret.items

fn template.template.volumes.secret.items.new

new()

google.cloud_run_v2_job.template.template.volumes.secret.items.new constructs a new object with attributes and blocks configured for the items Terraform sub block.

Args:

  • mode (number): Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. When null, the mode field will be omitted from the resulting object.
  • path (string): The relative path of the secret in the container.
  • version (string): The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version

Returns:

  • An attribute object that represents the items sub block.

obj template.template.vpc_access

fn template.template.vpc_access.new

new()

google.cloud_run_v2_job.template.template.vpc_access.new constructs a new object with attributes and blocks configured for the vpc_access Terraform sub block.

Args:

  • connector (string): VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. When null, the connector field will be omitted from the resulting object.
  • egress (string): Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"] When null, the egress field will be omitted from the resulting object.
  • network_interfaces (list[obj]): Direct VPC egress settings. Currently only single network interface is supported. When null, the network_interfaces sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the google.cloud_run_v2_job.template.template.vpc_access.network_interfaces.new constructor.

Returns:

  • An attribute object that represents the vpc_access sub block.

obj template.template.vpc_access.network_interfaces

fn template.template.vpc_access.network_interfaces.new

new()

google.cloud_run_v2_job.template.template.vpc_access.network_interfaces.new constructs a new object with attributes and blocks configured for the network_interfaces Terraform sub block.

Args:

  • network (string): The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. When null, the network field will be omitted from the resulting object.
  • subnetwork (string): The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. When null, the subnetwork field will be omitted from the resulting object.
  • tags (list): Network tags applied to this Cloud Run job. When null, the tags field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the network_interfaces sub block.

obj timeouts

fn timeouts.new

new()

google.cloud_run_v2_job.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
  • delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
  • update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.