Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1
  6. getConfig

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigateway/v1.getConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Gets details of a single ApiConfig.

Using getConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>
Copy
def get_config(api_id: Optional[str] = None,
               config_id: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               view: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetConfigResult
def get_config_output(api_id: Optional[pulumi.Input[str]] = None,
               config_id: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               view: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]
Copy
func LookupConfig(ctx *Context, args *LookupConfigArgs, opts ...InvokeOption) (*LookupConfigResult, error)
func LookupConfigOutput(ctx *Context, args *LookupConfigOutputArgs, opts ...InvokeOption) LookupConfigResultOutput
Copy

> Note: This function is named LookupConfig in the Go SDK.

public static class GetConfig 
{
    public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
public static Output<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:apigateway/v1:getConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId This property is required. string
ConfigId This property is required. string
Location This property is required. string
Project string
View string
ApiId This property is required. string
ConfigId This property is required. string
Location This property is required. string
Project string
View string
apiId This property is required. String
configId This property is required. String
location This property is required. String
project String
view String
apiId This property is required. string
configId This property is required. string
location This property is required. string
project string
view string
api_id This property is required. str
config_id This property is required. str
location This property is required. str
project str
view str
apiId This property is required. String
configId This property is required. String
location This property is required. String
project String
view String

getConfig Result

The following output properties are available:

CreateTime string
Created time.
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.Outputs.ApigatewayApiConfigGrpcServiceDefinitionResponse>
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
ManagedServiceConfigs List<Pulumi.GoogleNative.APIGateway.V1.Outputs.ApigatewayApiConfigFileResponse>
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.
Name string
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
OpenapiDocuments List<Pulumi.GoogleNative.APIGateway.V1.Outputs.ApigatewayApiConfigOpenApiDocumentResponse>
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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.
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 []ApigatewayApiConfigGrpcServiceDefinitionResponse
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
ManagedServiceConfigs []ApigatewayApiConfigFileResponse
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.
Name string
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
OpenapiDocuments []ApigatewayApiConfigOpenApiDocumentResponse
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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.
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<ApigatewayApiConfigGrpcServiceDefinitionResponse>
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
managedServiceConfigs List<ApigatewayApiConfigFileResponse>
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.
name String
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
openapiDocuments List<ApigatewayApiConfigOpenApiDocumentResponse>
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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.
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 ApigatewayApiConfigGrpcServiceDefinitionResponse[]
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
managedServiceConfigs ApigatewayApiConfigFileResponse[]
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.
name string
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
openapiDocuments ApigatewayApiConfigOpenApiDocumentResponse[]
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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.
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[ApigatewayApiConfigGrpcServiceDefinitionResponse]
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
managed_service_configs Sequence[ApigatewayApiConfigFileResponse]
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.
name str
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
openapi_documents Sequence[ApigatewayApiConfigOpenApiDocumentResponse]
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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.
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
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.
name String
Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}
openapiDocuments List<Property Map>
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
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

ApigatewayApiConfigFileResponse

Contents This property is required. string
The bytes that constitute the file.
Path This property is required. string
The file path (full or relative path). This is typically the path of the file when it is uploaded.
Contents This property is required. string
The bytes that constitute the file.
Path This property is required. string
The file path (full or relative path). This is typically the path of the file when it is uploaded.
contents This property is required. String
The bytes that constitute the file.
path This property is required. String
The file path (full or relative path). This is typically the path of the file when it is uploaded.
contents This property is required. string
The bytes that constitute the file.
path This property is required. string
The file path (full or relative path). This is typically the path of the file when it is uploaded.
contents This property is required. str
The bytes that constitute the file.
path This property is required. str
The file path (full or relative path). This is typically the path of the file when it is uploaded.
contents This property is required. String
The bytes that constitute the file.
path This property is required. String
The file path (full or relative path). This is typically the path of the file when it is uploaded.

ApigatewayApiConfigGrpcServiceDefinitionResponse

FileDescriptorSet This property is required. 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 This property is required. 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 This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

ApigatewayApiConfigOpenApiDocumentResponse

Document This property is required. Pulumi.GoogleNative.APIGateway.V1.Inputs.ApigatewayApiConfigFileResponse
The OpenAPI Specification document file.
Document This property is required. ApigatewayApiConfigFileResponse
The OpenAPI Specification document file.
document This property is required. ApigatewayApiConfigFileResponse
The OpenAPI Specification document file.
document This property is required. ApigatewayApiConfigFileResponse
The OpenAPI Specification document file.
document This property is required. ApigatewayApiConfigFileResponse
The OpenAPI Specification document file.
document This property is required. Property Map
The OpenAPI Specification document file.

Package Details

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

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native