com.pulumi.gcp.apigateway.kotlin.Api.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.apigateway.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Api].
*/
@PulumiTagMarker
public class ApiResourceBuilder internal constructor() {
public var name: String? = null
public var args: ApiArgs = ApiArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ApiArgsBuilder.() -> Unit) {
val builder = ApiArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Api {
val builtJavaResource = com.pulumi.gcp.apigateway.Api(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Api(builtJavaResource)
}
}
/**
* A consumable API that can be used by multiple Gateways.
* To get more information about Api, see:
* * [API documentation](https://cloud.google.com/api-gateway/docs/reference/rest/v1beta/projects.locations.apis)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/api-gateway/docs/quickstart)
* ## Example Usage
* ### Apigateway Api Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const api = new gcp.apigateway.Api("api", {apiId: "my-api"});
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* api = gcp.apigateway.Api("api", api_id="my-api")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var api = new Gcp.ApiGateway.Api("api", new()
* {
* ApiId = "my-api",
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/apigateway"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := apigateway.NewApi(ctx, "api", &apigateway.ApiArgs{
* ApiId: pulumi.String("my-api"),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.apigateway.Api;
* import com.pulumi.gcp.apigateway.ApiArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var api = new Api("api", ApiArgs.builder()
* .apiId("my-api")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* api:
* type: gcp:apigateway:Api
* properties:
* apiId: my-api
* ```
*
* ## Import
* Api can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/global/apis/{{api_id}}`
* * `{{project}}/{{api_id}}`
* * `{{api_id}}`
* When using the `pulumi import` command, Api can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:apigateway/api:Api default projects/{{project}}/locations/global/apis/{{api_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/api:Api default {{project}}/{{api_id}}
* ```
* ```sh
* $ pulumi import gcp:apigateway/api:Api default {{api_id}}
* ```
*/
public class Api internal constructor(
override val javaResource: com.pulumi.gcp.apigateway.Api,
) : KotlinCustomResource(javaResource, ApiMapper) {
/**
* Identifier to assign to the API. Must be unique within scope of the parent resource(project)
* - - -
*/
public val apiId: Output
get() = javaResource.apiId().applyValue({ args0 -> args0 })
/**
* Creation timestamp in RFC3339 text format.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* A user-visible name for the API.
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Resource labels to represent user-provided metadata.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effective_labels` for all of the labels present on the resource.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed).
* If not specified, a new Service will automatically be created in the same project as this API.
*/
public val managedService: Output
get() = javaResource.managedService().applyValue({ args0 -> args0 })
/**
* The resource name of the API. Format `projects/{{project}}/locations/global/apis/{{apiId}}`
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
}
public object ApiMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.apigateway.Api::class == javaResource::class
override fun map(javaResource: Resource): Api = Api(javaResource as com.pulumi.gcp.apigateway.Api)
}
/**
* @see [Api].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Api].
*/
public suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api {
val builder = ApiResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Api].
* @param name The _unique_ name of the resulting resource.
*/
public fun api(name: String): Api {
val builder = ApiResourceBuilder()
builder.name(name)
return builder.build()
}