All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.apimanagement.kotlin.GatewayArgs.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.apimanagement.kotlin

import com.pulumi.azure.apimanagement.GatewayArgs.builder
import com.pulumi.azure.apimanagement.kotlin.inputs.GatewayLocationDataArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.GatewayLocationDataArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 * Manages an API Management Gateway.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleService = new azure.apimanagement.Service("example", {
 *     name: "example-apim",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     publisherName: "pub1",
 *     publisherEmail: "[email protected]",
 *     skuName: "Consumption_0",
 * });
 * const exampleGateway = new azure.apimanagement.Gateway("example", {
 *     name: "example-gateway",
 *     apiManagementId: exampleService.id,
 *     description: "Example API Management gateway",
 *     locationData: {
 *         name: "example name",
 *         city: "example city",
 *         district: "example district",
 *         region: "example region",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_service = azure.apimanagement.Service("example",
 *     name="example-apim",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     publisher_name="pub1",
 *     publisher_email="[email protected]",
 *     sku_name="Consumption_0")
 * example_gateway = azure.apimanagement.Gateway("example",
 *     name="example-gateway",
 *     api_management_id=example_service.id,
 *     description="Example API Management gateway",
 *     location_data={
 *         "name": "example name",
 *         "city": "example city",
 *         "district": "example district",
 *         "region": "example region",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleService = new Azure.ApiManagement.Service("example", new()
 *     {
 *         Name = "example-apim",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         PublisherName = "pub1",
 *         PublisherEmail = "[email protected]",
 *         SkuName = "Consumption_0",
 *     });
 *     var exampleGateway = new Azure.ApiManagement.Gateway("example", new()
 *     {
 *         Name = "example-gateway",
 *         ApiManagementId = exampleService.Id,
 *         Description = "Example API Management gateway",
 *         LocationData = new Azure.ApiManagement.Inputs.GatewayLocationDataArgs
 *         {
 *             Name = "example name",
 *             City = "example city",
 *             District = "example district",
 *             Region = "example region",
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
 * 			Name:              pulumi.String("example-apim"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			PublisherName:     pulumi.String("pub1"),
 * 			PublisherEmail:    pulumi.String("[email protected]"),
 * 			SkuName:           pulumi.String("Consumption_0"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewGateway(ctx, "example", &apimanagement.GatewayArgs{
 * 			Name:            pulumi.String("example-gateway"),
 * 			ApiManagementId: exampleService.ID(),
 * 			Description:     pulumi.String("Example API Management gateway"),
 * 			LocationData: &apimanagement.GatewayLocationDataArgs{
 * 				Name:     pulumi.String("example name"),
 * 				City:     pulumi.String("example city"),
 * 				District: pulumi.String("example district"),
 * 				Region:   pulumi.String("example region"),
 * 			},
 * 		})
 * 		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.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.apimanagement.Service;
 * import com.pulumi.azure.apimanagement.ServiceArgs;
 * import com.pulumi.azure.apimanagement.Gateway;
 * import com.pulumi.azure.apimanagement.GatewayArgs;
 * import com.pulumi.azure.apimanagement.inputs.GatewayLocationDataArgs;
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleService = new Service("exampleService", ServiceArgs.builder()
 *             .name("example-apim")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .publisherName("pub1")
 *             .publisherEmail("[email protected]")
 *             .skuName("Consumption_0")
 *             .build());
 *         var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
 *             .name("example-gateway")
 *             .apiManagementId(exampleService.id())
 *             .description("Example API Management gateway")
 *             .locationData(GatewayLocationDataArgs.builder()
 *                 .name("example name")
 *                 .city("example city")
 *                 .district("example district")
 *                 .region("example region")
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleService:
 *     type: azure:apimanagement:Service
 *     name: example
 *     properties:
 *       name: example-apim
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       publisherName: pub1
 *       publisherEmail: [email protected]
 *       skuName: Consumption_0
 *   exampleGateway:
 *     type: azure:apimanagement:Gateway
 *     name: example
 *     properties:
 *       name: example-gateway
 *       apiManagementId: ${exampleService.id}
 *       description: Example API Management gateway
 *       locationData:
 *         name: example name
 *         city: example city
 *         district: example district
 *         region: example region
 * ```
 * 
 * ## Import
 * API Management Gateways can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/gateway:Gateway example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1
 * ```
 * @property apiManagementId The ID of the API Management Resource in which the gateway will be created. Changing this forces a new API Management Gateway resource to be created.
 * @property description The description of the API Management Gateway.
 * @property locationData A `location_data` block as documented below.
 * @property name The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.
 */
public data class GatewayArgs(
    public val apiManagementId: Output? = null,
    public val description: Output? = null,
    public val locationData: Output? = null,
    public val name: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.apimanagement.GatewayArgs =
        com.pulumi.azure.apimanagement.GatewayArgs.builder()
            .apiManagementId(apiManagementId?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .locationData(locationData?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .name(name?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [GatewayArgs].
 */
@PulumiTagMarker
public class GatewayArgsBuilder internal constructor() {
    private var apiManagementId: Output? = null

    private var description: Output? = null

    private var locationData: Output? = null

    private var name: Output? = null

    /**
     * @param value The ID of the API Management Resource in which the gateway will be created. Changing this forces a new API Management Gateway resource to be created.
     */
    @JvmName("paftvwqjwyvanfpq")
    public suspend fun apiManagementId(`value`: Output) {
        this.apiManagementId = value
    }

    /**
     * @param value The description of the API Management Gateway.
     */
    @JvmName("rlfumixieqtfxbdb")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value A `location_data` block as documented below.
     */
    @JvmName("ytnsiejoiiuhavve")
    public suspend fun locationData(`value`: Output) {
        this.locationData = value
    }

    /**
     * @param value The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.
     */
    @JvmName("lxbmqmdwkdqjsiwa")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The ID of the API Management Resource in which the gateway will be created. Changing this forces a new API Management Gateway resource to be created.
     */
    @JvmName("fhrkqpiqtiyuscan")
    public suspend fun apiManagementId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiManagementId = mapped
    }

    /**
     * @param value The description of the API Management Gateway.
     */
    @JvmName("nqpdcsypqgbvmfia")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value A `location_data` block as documented below.
     */
    @JvmName("ygicjnpusnsuajjq")
    public suspend fun locationData(`value`: GatewayLocationDataArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.locationData = mapped
    }

    /**
     * @param argument A `location_data` block as documented below.
     */
    @JvmName("prhrtndjkpkulnmd")
    public suspend fun locationData(argument: suspend GatewayLocationDataArgsBuilder.() -> Unit) {
        val toBeMapped = GatewayLocationDataArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.locationData = mapped
    }

    /**
     * @param value The name which should be used for the API Management Gateway. Changing this forces a new API Management Gateway to be created.
     */
    @JvmName("cgoiclgjqxjswicm")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    internal fun build(): GatewayArgs = GatewayArgs(
        apiManagementId = apiManagementId,
        description = description,
        locationData = locationData,
        name = name,
    )
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy