getConfig

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:

ApiId string
ConfigId string
Location string
Project string
View string
ApiId string
ConfigId string
Location string
Project string
View string
apiId String
configId String
location String
project String
view String
apiId string
configId string
location string
project string
view string
apiId String
configId String
location String
project String
view String

getConfig Result

The following output properties are available:

CreateTime string

Created time.

DisplayName string

Optional. Display name.

GatewayConfig Pulumi.GoogleNative.APIGateway.V1Beta.Outputs.ApigatewayGatewayConfigResponse

Immutable. Gateway specific configuration.

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.V1Beta.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.V1Beta.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.V1Beta.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.

GatewayConfig ApigatewayGatewayConfigResponse

Immutable. Gateway specific configuration.

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.

gatewayConfig ApigatewayGatewayConfigResponse

Immutable. Gateway specific configuration.

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.

gatewayConfig ApigatewayGatewayConfigResponse

Immutable. Gateway specific configuration.

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_config ApigatewayGatewayConfigResponse

Immutable. Gateway specific configuration.

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.

gatewayConfig Property Map

Immutable. Gateway specific configuration.

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 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.

ApigatewayApiConfigGrpcServiceDefinitionResponse

FileDescriptorSet Pulumi.GoogleNative.APIGateway.V1Beta.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.V1Beta.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.

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.

ApigatewayBackendConfigResponse

GoogleServiceAccount string

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).

GoogleServiceAccount string

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).

googleServiceAccount String

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).

googleServiceAccount string

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_account str

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).

googleServiceAccount String

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

BackendConfig Pulumi.GoogleNative.APIGateway.V1Beta.Inputs.ApigatewayBackendConfigResponse

Backend settings that are applied to all backends of the Gateway.

BackendConfig ApigatewayBackendConfigResponse

Backend settings that are applied to all backends of the Gateway.

backendConfig ApigatewayBackendConfigResponse

Backend settings that are applied to all backends of the Gateway.

backendConfig ApigatewayBackendConfigResponse

Backend settings that are applied to all backends of the Gateway.

backend_config ApigatewayBackendConfigResponse

Backend settings that are applied to all backends of the Gateway.

backendConfig Property Map

Backend settings that are applied to all backends of the Gateway.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0