ServiceArgs class

The set of arguments for Service. The set of arguments for Service.

Constructors

ServiceArgs({Input<Map<String, String>?>? annotations, Input<ServiceBinaryAuthorization?>? binaryAuthorization, Input<ServiceBuildConfig?>? buildConfig, Input<String?>? client, Input<String?>? clientVersion, Input<List<String>?>? customAudiences, Input<bool?>? defaultUriDisabled, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<String?>? description, Input<bool?>? iapEnabled, Input<String?>? ingress, Input<bool?>? invokerIamDisabled, Input<Map<String, String>?>? labels, Input<String?>? launchStage, required Input<String> location, Input<ServiceMultiRegionSettings?>? multiRegionSettings, Input<String?>? name, Input<String?>? project, Input<ServiceScaling?>? scaling, Input<Map<String, String>?>? tags, required Input<ServiceTemplate> template, Input<List<ServiceTraffic>?>? traffics})
Creates a new ServiceArgs. annotations 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. binaryAuthorization Settings for the Binary Authorization feature. buildConfig Configuration for building a Cloud Run function. client Arbitrary identifier for the API client. clientVersion Arbitrary version identifier for the API client. customAudiences One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. defaultUriDisabled Disables public resolution of the default URI of this service. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtection Whether Terraform will be prevented from destroying the service. Defaults to true. description User-provided description of the Service. This field currently has a 512-character limit. iapEnabled Used to enable/disable IAP for the cloud-run service. ingress Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. invokerIamDisabled Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check. labels 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, launchStage The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. location The location of the cloud run service multiRegionSettings Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy name Name of the Service. project The ID of the project in which the resource belongs. scaling Scaling settings that apply to the whole service tags A map of resource manager tags. template The template used to create revisions for this Service. traffics Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
const
ServiceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<Map<String, String>?>?
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 in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.
final
binaryAuthorization → Input<ServiceBinaryAuthorization?>?
Settings for the Binary Authorization feature. Structure is documented below.
final
buildConfig → Input<ServiceBuildConfig?>?
Configuration for building a Cloud Run function. Structure is documented below.
final
client → Input<String?>?
Arbitrary identifier for the API client.
final
clientVersion → Input<String?>?
Arbitrary version identifier for the API client.
final
customAudiences → Input<List<String>?>?
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
final
defaultUriDisabled → Input<bool?>?
Disables public resolution of the default URI of this service.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
deletionProtection → Input<bool?>?
Whether Terraform will be prevented from destroying the service. Defaults to true. When aterraform destroy or pulumi up would delete the service, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a pulumi up or terraform destroy that would delete the service will fail. When the field is set to false, deleting the service is allowed.
final
description → Input<String?>?
User-provided description of the Service. This field currently has a 512-character limit.
final
hashCode → int
The hash code for this object.
no setterinherited
iapEnabled → Input<bool?>?
Used to enable/disable IAP for the cloud-run service.
final
ingress → Input<String?>?
Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values are: INGRESS_TRAFFIC_ALL, INGRESS_TRAFFIC_INTERNAL_ONLY, INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER.
final
invokerIamDisabled → Input<bool?>?
Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
final
labels → Input<Map<String, String>?>?
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://docs.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 Service. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
launchStage → Input<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 are: UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED.
final
location → Input<String>
The location of the cloud run service
final
multiRegionSettings → Input<ServiceMultiRegionSettings?>?
Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy Structure is documented below.
final
name → Input<String?>?
Name of the Service.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaling → Input<ServiceScaling?>?
Scaling settings that apply to the whole service Structure is documented below.
final
tags → Input<Map<String, String>?>?
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
final
template → Input<ServiceTemplate>
The template used to create revisions for this Service. Structure is documented below.
final
traffics → Input<List<ServiceTraffic>?>?
Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited