Service

This resource creates and rolls out a Cloud Endpoints service using OpenAPI or gRPC. View the relevant docs for OpenAPI and gRPC.

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

def Service(resource_name, opts=None, grpc_config=None, openapi_config=None, project=None, protoc_output_base64=None, service_name=None, __props__=None);

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Service resource accepts the following input properties:

ServiceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
GrpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
OpenapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
Project string: The project ID that the service belongs to. If not provided, provider project is used.
ProtocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

ServiceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
GrpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
OpenapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
Project string: The project ID that the service belongs to. If not provided, provider project is used.
ProtocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

serviceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
grpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
openapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
project string: The project ID that the service belongs to. If not provided, provider project is used.
protocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

service_name str: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.
grpc_config str: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
openapi_config str: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
project str: The project ID that the service belongs to. If not provided, provider project is used.
protoc_output_base64 str: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Apis List<ServiceApi>: A list of API objects.
ConfigId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
DnsAddress string: The address at which the service can be found - usually the same as the service name.
Endpoints List<ServiceEndpoint>: A list of Endpoint objects.
Id string: The provider-assigned unique ID for this managed resource.

Apis []ServiceApi: A list of API objects.
ConfigId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
DnsAddress string: The address at which the service can be found - usually the same as the service name.
Endpoints []ServiceEndpoint: A list of Endpoint objects.
Id string: The provider-assigned unique ID for this managed resource.

apis ServiceApi[]: A list of API objects.
configId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
dnsAddress string: The address at which the service can be found - usually the same as the service name.
endpoints ServiceEndpoint[]: A list of Endpoint objects.
id string: The provider-assigned unique ID for this managed resource.

apis List[ServiceApi]: A list of API objects.
config_id str: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
dns_address str: The address at which the service can be found - usually the same as the service name.
endpoints List[ServiceEndpoint]: A list of Endpoint objects.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Service Resource

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service

static get(resource_name, id, opts=None, apis=None, config_id=None, dns_address=None, endpoints=None, grpc_config=None, openapi_config=None, project=None, protoc_output_base64=None, service_name=None, __props__=None);

func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)

public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Apis List<ServiceApiArgs>: A list of API objects.
ConfigId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
DnsAddress string: The address at which the service can be found - usually the same as the service name.
Endpoints List<ServiceEndpointArgs>: A list of Endpoint objects.
GrpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
OpenapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
Project string: The project ID that the service belongs to. If not provided, provider project is used.
ProtocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
ServiceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.

Apis []ServiceApi: A list of API objects.
ConfigId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
DnsAddress string: The address at which the service can be found - usually the same as the service name.
Endpoints []ServiceEndpoint: A list of Endpoint objects.
GrpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
OpenapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
Project string: The project ID that the service belongs to. If not provided, provider project is used.
ProtocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
ServiceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.

apis ServiceApi[]: A list of API objects.
configId string: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
dnsAddress string: The address at which the service can be found - usually the same as the service name.
endpoints ServiceEndpoint[]: A list of Endpoint objects.
grpcConfig string: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
openapiConfig string: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
project string: The project ID that the service belongs to. If not provided, provider project is used.
protocOutputBase64 string: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
serviceName string: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.

apis List[ServiceApi]: A list of API objects.
config_id str: The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.
dns_address str: The address at which the service can be found - usually the same as the service name.
endpoints List[ServiceEndpoint]: A list of Endpoint objects.
grpc_config str: The full text of the Service Config YAML file (Example located here). If provided, must also provide protoc_output_base64. open_api config must not be provided.
openapi_config str: The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpc_config and protoc_output_base64 must be specified.
project str: The project ID that the service belongs to. If not provided, provider project is used.
protoc_output_base64 str: The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.
service_name str: The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.