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
google-native.apigateway/v1beta.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
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>
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]
func LookupConfig(ctx *Context, args *LookupConfigArgs, opts ...InvokeOption) (*LookupConfigResult, error)
func LookupConfigOutput(ctx *Context, args *LookupConfigOutputArgs, opts ...InvokeOption) LookupConfigResultOutput
> 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)
}
public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:apigateway/v1beta:getConfig
arguments:
# arguments dictionary
The following arguments are supported:
getConfig Result
The following output properties are available:
- Create
Time string - Created time.
- Display
Name string - Optional. Display name.
- Gateway
Config Pulumi.Google Native. APIGateway. V1Beta. Outputs. Apigateway Gateway Config Response - Immutable. Gateway specific configuration.
- Gateway
Service stringAccount - 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 List<Pulumi.Google Native. APIGateway. V1Beta. Outputs. Apigateway Api Config Grpc Service Definition Response> - 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
- Managed
Service List<Pulumi.Configs Google Native. APIGateway. V1Beta. Outputs. Apigateway Api Config File Response> - 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}
- Openapi
Documents List<Pulumi.Google Native. APIGateway. V1Beta. Outputs. Apigateway Api Config Open Api Document Response> - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- Service
Config stringId - The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
- State string
- State of the API Config.
- Update
Time string - Updated time.
- Create
Time string - Created time.
- Display
Name string - Optional. Display name.
- Gateway
Config ApigatewayGateway Config Response - Immutable. Gateway specific configuration.
- Gateway
Service stringAccount - 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 []ApigatewayApi Config Grpc Service Definition Response - 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
- Managed
Service []ApigatewayConfigs Api Config File Response - 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}
- Openapi
Documents []ApigatewayApi Config Open Api Document Response - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- Service
Config stringId - The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
- State string
- State of the API Config.
- Update
Time string - Updated time.
- create
Time String - Created time.
- display
Name String - Optional. Display name.
- gateway
Config ApigatewayGateway Config Response - Immutable. Gateway specific configuration.
- gateway
Service StringAccount - 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 List<ApigatewayApi Config Grpc Service Definition Response> - 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
- managed
Service List<ApigatewayConfigs Api Config File Response> - 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}
- openapi
Documents List<ApigatewayApi Config Open Api Document Response> - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- service
Config StringId - The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
- state String
- State of the API Config.
- update
Time String - Updated time.
- create
Time string - Created time.
- display
Name string - Optional. Display name.
- gateway
Config ApigatewayGateway Config Response - Immutable. Gateway specific configuration.
- gateway
Service stringAccount - 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 ApigatewayApi Config Grpc Service Definition Response[] - 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
- managed
Service ApigatewayConfigs Api Config File Response[] - 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}
- openapi
Documents ApigatewayApi Config Open Api Document Response[] - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- service
Config stringId - The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
- state string
- State of the API Config.
- update
Time string - Updated time.
- create_
time str - Created time.
- display_
name str - Optional. Display name.
- gateway_
config ApigatewayGateway Config Response - Immutable. Gateway specific configuration.
- gateway_
service_ straccount - 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[ApigatewayApi Config Grpc Service Definition Response] - 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_ Sequence[Apigatewayconfigs Api Config File Response] - 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[ApigatewayApi Config Open Api Document Response] - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- service_
config_ strid - 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.
- create
Time String - Created time.
- display
Name String - Optional. Display name.
- gateway
Config Property Map - Immutable. Gateway specific configuration.
- gateway
Service StringAccount - 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 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
- managed
Service List<Property Map>Configs - 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}
- openapi
Documents List<Property Map> - Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
- service
Config StringId - The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).
- state String
- State of the API Config.
- update
Time String - Updated time.
Supporting Types
ApigatewayApiConfigFileResponse
ApigatewayApiConfigGrpcServiceDefinitionResponse
- File
Descriptor Pulumi.Set Google Native. APIGateway. V1Beta. Inputs. Apigateway Api Config File Response - 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.
Google Native. APIGateway. V1Beta. Inputs. Apigateway Api Config File Response> - 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 ApigatewaySet Api Config File Response - 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
[]Apigateway
Api Config File Response - 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 ApigatewaySet Api Config File Response - 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<Apigateway
Api Config File Response> - 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 ApigatewaySet Api Config File Response - 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
Apigateway
Api Config File Response[] - 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_ Apigatewayset Api Config File Response - 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[Apigateway
Api Config File Response] - 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 Property MapSet - 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.
ApigatewayApiConfigOpenApiDocumentResponse
- Document
Pulumi.
Google Native. APIGateway. V1Beta. Inputs. Apigateway Api Config File Response - The OpenAPI Specification document file.
- Document
Apigateway
Api Config File Response - The OpenAPI Specification document file.
- document
Apigateway
Api Config File Response - The OpenAPI Specification document file.
- document
Apigateway
Api Config File Response - The OpenAPI Specification document file.
- document
Apigateway
Api Config File Response - The OpenAPI Specification document file.
- document Property Map
- The OpenAPI Specification document file.
ApigatewayBackendConfigResponse
- Google
Service stringAccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
- Google
Service stringAccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
- google
Service StringAccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
- google
Service stringAccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
- google_
service_ straccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
- google
Service StringAccount - Google Cloud IAM service account used to sign OIDC tokens for backends that have authentication configured (https://cloud.google.com/service-infrastructure/docs/service-management/reference/rest/v1/services.configs#backend). This may either be the Service Account's email (i.e. "{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com") or its full resource name (i.e. "projects/{PROJECT}/accounts/{UNIQUE_ID}"). This is most often used when the backend is a GCP resource such as a Cloud Run Service or an IAP-secured service. Note that this token is always sent as an authorization header bearer token. The audience of the OIDC token is configured in the associated Service Config in the BackendRule option (https://github.com/googleapis/googleapis/blob/master/google/api/backend.proto#L125).
ApigatewayGatewayConfigResponse
- Backend
Config Pulumi.Google Native. APIGateway. V1Beta. Inputs. Apigateway Backend Config Response - Backend settings that are applied to all backends of the Gateway.
- Backend
Config ApigatewayBackend Config Response - Backend settings that are applied to all backends of the Gateway.
- backend
Config ApigatewayBackend Config Response - Backend settings that are applied to all backends of the Gateway.
- backend
Config ApigatewayBackend Config Response - Backend settings that are applied to all backends of the Gateway.
- backend_
config ApigatewayBackend Config Response - Backend settings that are applied to all backends of the Gateway.
- backend
Config Property Map - Backend settings that are applied to all backends of the Gateway.
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