com.pulumi.azure.apimanagement.kotlin.GatewayHostNameConfiguration.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.apimanagement.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
/**
* Builder for [GatewayHostNameConfiguration].
*/
@PulumiTagMarker
public class GatewayHostNameConfigurationResourceBuilder internal constructor() {
public var name: String? = null
public var args: GatewayHostNameConfigurationArgs = GatewayHostNameConfigurationArgs()
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 GatewayHostNameConfigurationArgsBuilder.() -> Unit) {
val builder = GatewayHostNameConfigurationArgsBuilder()
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(): GatewayHostNameConfiguration {
val builtJavaResource =
com.pulumi.azure.apimanagement.GatewayHostNameConfiguration(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return GatewayHostNameConfiguration(builtJavaResource)
}
}
/**
* Manages an API Management Gateway Host Name Configuration.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* import * as std from "@pulumi/std";
* 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",
* },
* });
* const exampleCertificate = new azure.apimanagement.Certificate("example", {
* name: "example-cert",
* apiManagementName: exampleService.name,
* resourceGroupName: example.name,
* data: std.filebase64({
* input: "example.pfx",
* }).then(invoke => invoke.result),
* });
* const exampleGatewayHostNameConfiguration = new azure.apimanagement.GatewayHostNameConfiguration("example", {
* name: "example-host-name-configuration",
* apiManagementId: exampleService.id,
* gatewayName: exampleGateway.name,
* certificateId: exampleCertificate.id,
* hostName: "example-host-name",
* requestClientCertificateEnabled: true,
* http2Enabled: true,
* tls10Enabled: true,
* tls11Enabled: false,
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* import pulumi_std as std
* 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=azure.apimanagement.GatewayLocationDataArgs(
* name="example name",
* city="example city",
* district="example district",
* region="example region",
* ))
* example_certificate = azure.apimanagement.Certificate("example",
* name="example-cert",
* api_management_name=example_service.name,
* resource_group_name=example.name,
* data=std.filebase64(input="example.pfx").result)
* example_gateway_host_name_configuration = azure.apimanagement.GatewayHostNameConfiguration("example",
* name="example-host-name-configuration",
* api_management_id=example_service.id,
* gateway_name=example_gateway.name,
* certificate_id=example_certificate.id,
* host_name="example-host-name",
* request_client_certificate_enabled=True,
* http2_enabled=True,
* tls10_enabled=True,
* tls11_enabled=False)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* using Std = Pulumi.Std;
* 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",
* },
* });
* var exampleCertificate = new Azure.ApiManagement.Certificate("example", new()
* {
* Name = "example-cert",
* ApiManagementName = exampleService.Name,
* ResourceGroupName = example.Name,
* Data = Std.Filebase64.Invoke(new()
* {
* Input = "example.pfx",
* }).Apply(invoke => invoke.Result),
* });
* var exampleGatewayHostNameConfiguration = new Azure.ApiManagement.GatewayHostNameConfiguration("example", new()
* {
* Name = "example-host-name-configuration",
* ApiManagementId = exampleService.Id,
* GatewayName = exampleGateway.Name,
* CertificateId = exampleCertificate.Id,
* HostName = "example-host-name",
* RequestClientCertificateEnabled = true,
* Http2Enabled = true,
* Tls10Enabled = true,
* Tls11Enabled = false,
* });
* });
* ```
* ```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-std/sdk/go/std"
* "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
* }
* exampleGateway, 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
* }
* invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
* Input: "example.pfx",
* }, nil)
* if err != nil {
* return err
* }
* exampleCertificate, err := apimanagement.NewCertificate(ctx, "example", &apimanagement.CertificateArgs{
* Name: pulumi.String("example-cert"),
* ApiManagementName: exampleService.Name,
* ResourceGroupName: example.Name,
* Data: invokeFilebase64.Result,
* })
* if err != nil {
* return err
* }
* _, err = apimanagement.NewGatewayHostNameConfiguration(ctx, "example", &apimanagement.GatewayHostNameConfigurationArgs{
* Name: pulumi.String("example-host-name-configuration"),
* ApiManagementId: exampleService.ID(),
* GatewayName: exampleGateway.Name,
* CertificateId: exampleCertificate.ID(),
* HostName: pulumi.String("example-host-name"),
* RequestClientCertificateEnabled: pulumi.Bool(true),
* Http2Enabled: pulumi.Bool(true),
* Tls10Enabled: pulumi.Bool(true),
* Tls11Enabled: pulumi.Bool(false),
* })
* 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 com.pulumi.azure.apimanagement.Certificate;
* import com.pulumi.azure.apimanagement.CertificateArgs;
* import com.pulumi.azure.apimanagement.GatewayHostNameConfiguration;
* import com.pulumi.azure.apimanagement.GatewayHostNameConfigurationArgs;
* 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());
* var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
* .name("example-cert")
* .apiManagementName(exampleService.name())
* .resourceGroupName(example.name())
* .data(StdFunctions.filebase64(Filebase64Args.builder()
* .input("example.pfx")
* .build()).result())
* .build());
* var exampleGatewayHostNameConfiguration = new GatewayHostNameConfiguration("exampleGatewayHostNameConfiguration", GatewayHostNameConfigurationArgs.builder()
* .name("example-host-name-configuration")
* .apiManagementId(exampleService.id())
* .gatewayName(exampleGateway.name())
* .certificateId(exampleCertificate.id())
* .hostName("example-host-name")
* .requestClientCertificateEnabled(true)
* .http2Enabled(true)
* .tls10Enabled(true)
* .tls11Enabled(false)
* .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
* exampleCertificate:
* type: azure:apimanagement:Certificate
* name: example
* properties:
* name: example-cert
* apiManagementName: ${exampleService.name}
* resourceGroupName: ${example.name}
* data:
* fn::invoke:
* Function: std:filebase64
* Arguments:
* input: example.pfx
* Return: result
* exampleGatewayHostNameConfiguration:
* type: azure:apimanagement:GatewayHostNameConfiguration
* name: example
* properties:
* name: example-host-name-configuration
* apiManagementId: ${exampleService.id}
* gatewayName: ${exampleGateway.name}
* certificateId: ${exampleCertificate.id}
* hostName: example-host-name
* requestClientCertificateEnabled: true
* http2Enabled: true
* tls10Enabled: true
* tls11Enabled: false
* ```
*
* ## Import
* API Management Gateway Host Name Configuration can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:apimanagement/gatewayHostNameConfiguration:GatewayHostNameConfiguration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1/hostnameConfigurations/hc1
* ```
*/
public class GatewayHostNameConfiguration internal constructor(
override val javaResource: com.pulumi.azure.apimanagement.GatewayHostNameConfiguration,
) : KotlinCustomResource(javaResource, GatewayHostNameConfigurationMapper) {
/**
* The ID of the API Management Service. Changing this forces a new resource to be created.
*/
public val apiManagementId: Output
get() = javaResource.apiManagementId().applyValue({ args0 -> args0 })
/**
* The certificate ID to be used for TLS connection establishment.
*/
public val certificateId: Output
get() = javaResource.certificateId().applyValue({ args0 -> args0 })
/**
* The name of the API Management Gateway. Changing this forces a new resource to be created.
*/
public val gatewayName: Output
get() = javaResource.gatewayName().applyValue({ args0 -> args0 })
/**
* The host name to use for the API Management Gateway Host Name Configuration.
*/
public val hostName: Output
get() = javaResource.hostName().applyValue({ args0 -> args0 })
/**
* Whether HTTP/2.0 is supported. Defaults to `true`.
*/
public val http2Enabled: Output?
get() = javaResource.http2Enabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the API Management Gateway Host Name Configuration. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Whether the API Management Gateway requests a client certificate.
*/
public val requestClientCertificateEnabled: Output?
get() = javaResource.requestClientCertificateEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Whether TLS 1.0 is supported.
*/
public val tls10Enabled: Output?
get() = javaResource.tls10Enabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Whether TLS 1.1 is supported.
*/
public val tls11Enabled: Output?
get() = javaResource.tls11Enabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object GatewayHostNameConfigurationMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.apimanagement.GatewayHostNameConfiguration::class == javaResource::class
override fun map(javaResource: Resource): GatewayHostNameConfiguration =
GatewayHostNameConfiguration(
javaResource as
com.pulumi.azure.apimanagement.GatewayHostNameConfiguration,
)
}
/**
* @see [GatewayHostNameConfiguration].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [GatewayHostNameConfiguration].
*/
public suspend fun gatewayHostNameConfiguration(
name: String,
block: suspend GatewayHostNameConfigurationResourceBuilder.() -> Unit,
):
GatewayHostNameConfiguration {
val builder = GatewayHostNameConfigurationResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [GatewayHostNameConfiguration].
* @param name The _unique_ name of the resulting resource.
*/
public fun gatewayHostNameConfiguration(name: String): GatewayHostNameConfiguration {
val builder = GatewayHostNameConfigurationResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy