Docs Packages
  1. Pulumi Registry
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1
  6. Config
google-native logo
Google Cloud Native v0.30.0, Apr 14 23

google-native.apigateway/v1.Config

Explore with Pulumi AI

Creates a new ApiConfig in a given project and location. Auto-naming is currently not supported for this resource.

Create Config Resource

new Config(name: string, args: ConfigArgs, opts?: CustomResourceOptions);
@overload
def Config(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           api_config_id: Optional[str] = None,
           api_id: Optional[str] = None,
           display_name: Optional[str] = None,
           gateway_service_account: Optional[str] = None,
           grpc_services: Optional[Sequence[ApigatewayApiConfigGrpcServiceDefinitionArgs]] = None,
           labels: Optional[Mapping[str, str]] = None,
           location: Optional[str] = None,
           managed_service_configs: Optional[Sequence[ApigatewayApiConfigFileArgs]] = None,
           openapi_documents: Optional[Sequence[ApigatewayApiConfigOpenApiDocumentArgs]] = None,
           project: Optional[str] = None)
@overload
def Config(resource_name: str,
           args: ConfigArgs,
           opts: Optional[ResourceOptions] = None)
func NewConfig(ctx *Context, name string, args ConfigArgs, opts ...ResourceOption) (*Config, error)
public Config(string name, ConfigArgs args, CustomResourceOptions? opts = null)
public Config(String name, ConfigArgs args)
public Config(String name, ConfigArgs args, CustomResourceOptions options)

type: google-native:apigateway/v1:Config
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Config Resource Properties

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

Inputs

The Config resource accepts the following input properties:

ApiConfigId string

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

ApiId string
DisplayName string

Optional. Display name.

GatewayServiceAccount string

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

GrpcServices List<Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigGrpcServiceDefinitionArgs>

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

Labels Dictionary<string, string>

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Location string
ManagedServiceConfigs List<Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFileArgs>

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

OpenapiDocuments List<Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigOpenApiDocumentArgs>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

Project string
ApiConfigId string

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

ApiId string
DisplayName string

Optional. Display name.

GatewayServiceAccount string

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

GrpcServices []ApigatewayApiConfigGrpcServiceDefinitionArgs

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

Labels map[string]string

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Location string
ManagedServiceConfigs []ApigatewayApiConfigFileArgs

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

OpenapiDocuments []ApigatewayApiConfigOpenApiDocumentArgs

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

Project string
apiConfigId String

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

apiId String
displayName String

Optional. Display name.

gatewayServiceAccount String

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

grpcServices List<ApigatewayApiConfigGrpcServiceDefinitionArgs>

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

labels Map<String,String>

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

location String
managedServiceConfigs List<ApigatewayApiConfigFileArgs>

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

openapiDocuments List<ApigatewayApiConfigOpenApiDocumentArgs>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

project String
apiConfigId string

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

apiId string
displayName string

Optional. Display name.

gatewayServiceAccount string

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

grpcServices ApigatewayApiConfigGrpcServiceDefinitionArgs[]

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

labels {[key: string]: string}

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

location string
managedServiceConfigs ApigatewayApiConfigFileArgs[]

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

openapiDocuments ApigatewayApiConfigOpenApiDocumentArgs[]

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

project string
api_config_id str

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

api_id str
display_name str

Optional. Display name.

gateway_service_account str

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

grpc_services Sequence[ApigatewayApiConfigGrpcServiceDefinitionArgs]

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

labels Mapping[str, str]

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

location str
managed_service_configs Sequence[ApigatewayApiConfigFileArgs]

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

openapi_documents Sequence[ApigatewayApiConfigOpenApiDocumentArgs]

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

project str
apiConfigId String

Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.

apiId String
displayName String

Optional. Display name.

gatewayServiceAccount String

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

grpcServices List<Property Map>

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

labels Map<String>

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

location String
managedServiceConfigs List<Property Map>

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

openapiDocuments List<Property Map>

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

project String

Outputs

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

CreateTime string

Created time.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

ServiceConfigId string

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

State string

State of the API Config.

UpdateTime string

Updated time.

CreateTime string

Created time.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

ServiceConfigId string

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

State string

State of the API Config.

UpdateTime string

Updated time.

createTime String

Created time.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

serviceConfigId String

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

state String

State of the API Config.

updateTime String

Updated time.

createTime string

Created time.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

serviceConfigId string

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

state string

State of the API Config.

updateTime string

Updated time.

create_time str

Created time.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

service_config_id str

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

state str

State of the API Config.

update_time str

Updated time.

createTime String

Created time.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

serviceConfigId String

The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

state String

State of the API Config.

updateTime String

Updated time.

Supporting Types

ApigatewayApiConfigFile

Contents string

The bytes that constitute the file.

Path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

Contents string

The bytes that constitute the file.

Path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents String

The bytes that constitute the file.

path String

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents string

The bytes that constitute the file.

path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents str

The bytes that constitute the file.

path str

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents String

The bytes that constitute the file.

path String

The file path (full or relative path). This is typically the path of the file when it is uploaded.

ApigatewayApiConfigFileResponse

Contents string

The bytes that constitute the file.

Path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

Contents string

The bytes that constitute the file.

Path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents String

The bytes that constitute the file.

path String

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents string

The bytes that constitute the file.

path string

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents str

The bytes that constitute the file.

path str

The file path (full or relative path). This is typically the path of the file when it is uploaded.

contents String

The bytes that constitute the file.

path String

The file path (full or relative path). This is typically the path of the file when it is uploaded.

ApigatewayApiConfigGrpcServiceDefinition

FileDescriptorSet Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFile

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Source List<Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFile>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

FileDescriptorSet ApigatewayApiConfigFile

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Source []ApigatewayApiConfigFile

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet ApigatewayApiConfigFile

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source List<ApigatewayApiConfigFile>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet ApigatewayApiConfigFile

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source ApigatewayApiConfigFile[]

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

file_descriptor_set ApigatewayApiConfigFile

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source Sequence[ApigatewayApiConfigFile]

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet Property Map

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source List<Property Map>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

ApigatewayApiConfigGrpcServiceDefinitionResponse

FileDescriptorSet Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFileResponse

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Source List<Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFileResponse>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

FileDescriptorSet ApigatewayApiConfigFileResponse

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

Source []ApigatewayApiConfigFileResponse

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet ApigatewayApiConfigFileResponse

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source List<ApigatewayApiConfigFileResponse>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet ApigatewayApiConfigFileResponse

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source ApigatewayApiConfigFileResponse[]

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

file_descriptor_set ApigatewayApiConfigFileResponse

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source Sequence[ApigatewayApiConfigFileResponse]

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

fileDescriptorSet Property Map

Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb

source List<Property Map>

Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.

ApigatewayApiConfigOpenApiDocument

Document ApigatewayApiConfigFile

The OpenAPI Specification document file.

document ApigatewayApiConfigFile

The OpenAPI Specification document file.

document ApigatewayApiConfigFile

The OpenAPI Specification document file.

document ApigatewayApiConfigFile

The OpenAPI Specification document file.

document Property Map

The OpenAPI Specification document file.

ApigatewayApiConfigOpenApiDocumentResponse

Document ApigatewayApiConfigFileResponse

The OpenAPI Specification document file.

document ApigatewayApiConfigFileResponse

The OpenAPI Specification document file.

document ApigatewayApiConfigFileResponse

The OpenAPI Specification document file.

document ApigatewayApiConfigFileResponse

The OpenAPI Specification document file.

document Property Map

The OpenAPI Specification document file.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0