ApiConfig class

An API Configuration is an association of an API Controller Config and a Gateway Config

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about ApiConfig, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Import

ApiConfig can be imported using any of these accepted formats:

• projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}
• {{project}}/{{api}}/{{api_config_id}}
• {{api}}/{{api_config_id}}

When using the pulumi import command, ApiConfig can be imported using one of the formats above. For example:

$ pulumi import gcp:apigateway/apiConfig:ApiConfig default projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}
$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{project}}/{{api}}/{{api_config_id}}
$ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{api}}/{{api_config_id}}

Constructors

ApiConfig(String name, {ApiConfigArgs? args, CustomResourceOptions? options})

Creates a new ApiConfig. name The Pulumi resource name. args Arguments used to configure this ApiConfig. The set of arguments for ApiConfig. options Resource options controlling this resource's behavior.

ApiConfig.reference(String urn)

Creates a typed reference to an existing ApiConfig resource.

Properties

api ↔ Output<String>

The API to attach the config to.

late, final

apiConfigId ↔ Output<String>

Identifier to assign to the API Config. Must be unique within scope of the parent resource(api).

late, final

apiConfigIdPrefix ↔ Output<String>

Creates a unique name beginning with the specified prefix. If this and apiConfigId are unspecified, a random value is chosen for the name.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

A user-visible name for the API.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

gatewayConfig ↔ Output<ApiConfigGatewayConfig?>

Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account Structure is documented below.

late, final

grpcServices ↔ Output<List<ApiConfigGrpcService>?>

gRPC service definition files. If specified, openapiDocuments must not be included. Structure is documented below.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

Resource labels to represent user-provided metadata.

late, final

managedServiceConfigs ↔ Output<List<ApiConfigManagedServiceConfig>?>

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. Structure is documented below.

late, final

name ↔ Output<String>

The resource name of the API Config.

late, final

openapiDocuments ↔ Output<List<ApiConfigOpenapiDocument>?>

OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. Structure is documented below.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceConfigId ↔ Output<String>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ApiConfigState? state, CustomResourceOptions? options}) → ApiConfig

Gets an existing ApiConfig resource's state with the given name and id.