com.pulumi.azure.appplatform.kotlin.SpringCloudGateway.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.appplatform.kotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayApiMetadata
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayClientAuthorization
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayCors
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayLocalResponseCachePerInstance
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayLocalResponseCachePerRoute
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayQuota
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewaySso
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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayApiMetadata.Companion.toKotlin as springCloudGatewayApiMetadataToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayClientAuthorization.Companion.toKotlin as springCloudGatewayClientAuthorizationToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayCors.Companion.toKotlin as springCloudGatewayCorsToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayLocalResponseCachePerInstance.Companion.toKotlin as springCloudGatewayLocalResponseCachePerInstanceToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayLocalResponseCachePerRoute.Companion.toKotlin as springCloudGatewayLocalResponseCachePerRouteToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewayQuota.Companion.toKotlin as springCloudGatewayQuotaToKotlin
import com.pulumi.azure.appplatform.kotlin.outputs.SpringCloudGatewaySso.Companion.toKotlin as springCloudGatewaySsoToKotlin
/**
* Builder for [SpringCloudGateway].
*/
@PulumiTagMarker
public class SpringCloudGatewayResourceBuilder internal constructor() {
public var name: String? = null
public var args: SpringCloudGatewayArgs = SpringCloudGatewayArgs()
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 SpringCloudGatewayArgsBuilder.() -> Unit) {
val builder = SpringCloudGatewayArgsBuilder()
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(): SpringCloudGateway {
val builtJavaResource = com.pulumi.azure.appplatform.SpringCloudGateway(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return SpringCloudGateway(builtJavaResource)
}
}
/**
* > **NOTE:** This resource is applicable only for Spring Cloud Service with enterprise tier.
* Manages a Spring Cloud 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",
* location: "West Europe",
* });
* const exampleSpringCloudService = new azure.appplatform.SpringCloudService("example", {
* name: "example",
* location: example.location,
* resourceGroupName: example.name,
* skuName: "E0",
* });
* const exampleSpringCloudGateway = new azure.appplatform.SpringCloudGateway("example", {
* name: "default",
* springCloudServiceId: exampleSpringCloudService.id,
* httpsOnly: false,
* publicNetworkAccessEnabled: true,
* instanceCount: 2,
* apiMetadata: {
* description: "example description",
* documentationUrl: "https://www.example.com/docs",
* serverUrl: "https://wwww.example.com",
* title: "example title",
* version: "1.0",
* },
* cors: {
* credentialsAllowed: false,
* allowedHeaders: ["*"],
* allowedMethods: ["PUT"],
* allowedOrigins: ["example.com"],
* exposedHeaders: ["x-example-header"],
* maxAgeSeconds: 86400,
* },
* quota: {
* cpu: "1",
* memory: "2Gi",
* },
* sso: {
* clientId: "example id",
* clientSecret: "example secret",
* issuerUri: "https://www.test.com/issueToken",
* scopes: ["read"],
* },
* localResponseCachePerInstance: {
* size: "100MB",
* timeToLive: "30s",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example",
* location="West Europe")
* example_spring_cloud_service = azure.appplatform.SpringCloudService("example",
* name="example",
* location=example.location,
* resource_group_name=example.name,
* sku_name="E0")
* example_spring_cloud_gateway = azure.appplatform.SpringCloudGateway("example",
* name="default",
* spring_cloud_service_id=example_spring_cloud_service.id,
* https_only=False,
* public_network_access_enabled=True,
* instance_count=2,
* api_metadata=azure.appplatform.SpringCloudGatewayApiMetadataArgs(
* description="example description",
* documentation_url="https://www.example.com/docs",
* server_url="https://wwww.example.com",
* title="example title",
* version="1.0",
* ),
* cors=azure.appplatform.SpringCloudGatewayCorsArgs(
* credentials_allowed=False,
* allowed_headers=["*"],
* allowed_methods=["PUT"],
* allowed_origins=["example.com"],
* exposed_headers=["x-example-header"],
* max_age_seconds=86400,
* ),
* quota=azure.appplatform.SpringCloudGatewayQuotaArgs(
* cpu="1",
* memory="2Gi",
* ),
* sso=azure.appplatform.SpringCloudGatewaySsoArgs(
* client_id="example id",
* client_secret="example secret",
* issuer_uri="https://www.test.com/issueToken",
* scopes=["read"],
* ),
* local_response_cache_per_instance=azure.appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs(
* size="100MB",
* time_to_live="30s",
* ))
* ```
* ```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",
* Location = "West Europe",
* });
* var exampleSpringCloudService = new Azure.AppPlatform.SpringCloudService("example", new()
* {
* Name = "example",
* Location = example.Location,
* ResourceGroupName = example.Name,
* SkuName = "E0",
* });
* var exampleSpringCloudGateway = new Azure.AppPlatform.SpringCloudGateway("example", new()
* {
* Name = "default",
* SpringCloudServiceId = exampleSpringCloudService.Id,
* HttpsOnly = false,
* PublicNetworkAccessEnabled = true,
* InstanceCount = 2,
* ApiMetadata = new Azure.AppPlatform.Inputs.SpringCloudGatewayApiMetadataArgs
* {
* Description = "example description",
* DocumentationUrl = "https://www.example.com/docs",
* ServerUrl = "https://wwww.example.com",
* Title = "example title",
* Version = "1.0",
* },
* Cors = new Azure.AppPlatform.Inputs.SpringCloudGatewayCorsArgs
* {
* CredentialsAllowed = false,
* AllowedHeaders = new[]
* {
* "*",
* },
* AllowedMethods = new[]
* {
* "PUT",
* },
* AllowedOrigins = new[]
* {
* "example.com",
* },
* ExposedHeaders = new[]
* {
* "x-example-header",
* },
* MaxAgeSeconds = 86400,
* },
* Quota = new Azure.AppPlatform.Inputs.SpringCloudGatewayQuotaArgs
* {
* Cpu = "1",
* Memory = "2Gi",
* },
* Sso = new Azure.AppPlatform.Inputs.SpringCloudGatewaySsoArgs
* {
* ClientId = "example id",
* ClientSecret = "example secret",
* IssuerUri = "https://www.test.com/issueToken",
* Scopes = new[]
* {
* "read",
* },
* },
* LocalResponseCachePerInstance = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs
* {
* Size = "100MB",
* TimeToLive = "30s",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appplatform"
* "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"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleSpringCloudService, err := appplatform.NewSpringCloudService(ctx, "example", &appplatform.SpringCloudServiceArgs{
* Name: pulumi.String("example"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* SkuName: pulumi.String("E0"),
* })
* if err != nil {
* return err
* }
* _, err = appplatform.NewSpringCloudGateway(ctx, "example", &appplatform.SpringCloudGatewayArgs{
* Name: pulumi.String("default"),
* SpringCloudServiceId: exampleSpringCloudService.ID(),
* HttpsOnly: pulumi.Bool(false),
* PublicNetworkAccessEnabled: pulumi.Bool(true),
* InstanceCount: pulumi.Int(2),
* ApiMetadata: &appplatform.SpringCloudGatewayApiMetadataArgs{
* Description: pulumi.String("example description"),
* DocumentationUrl: pulumi.String("https://www.example.com/docs"),
* ServerUrl: pulumi.String("https://wwww.example.com"),
* Title: pulumi.String("example title"),
* Version: pulumi.String("1.0"),
* },
* Cors: &appplatform.SpringCloudGatewayCorsArgs{
* CredentialsAllowed: pulumi.Bool(false),
* AllowedHeaders: pulumi.StringArray{
* pulumi.String("*"),
* },
* AllowedMethods: pulumi.StringArray{
* pulumi.String("PUT"),
* },
* AllowedOrigins: pulumi.StringArray{
* pulumi.String("example.com"),
* },
* ExposedHeaders: pulumi.StringArray{
* pulumi.String("x-example-header"),
* },
* MaxAgeSeconds: pulumi.Int(86400),
* },
* Quota: &appplatform.SpringCloudGatewayQuotaArgs{
* Cpu: pulumi.String("1"),
* Memory: pulumi.String("2Gi"),
* },
* Sso: &appplatform.SpringCloudGatewaySsoArgs{
* ClientId: pulumi.String("example id"),
* ClientSecret: pulumi.String("example secret"),
* IssuerUri: pulumi.String("https://www.test.com/issueToken"),
* Scopes: pulumi.StringArray{
* pulumi.String("read"),
* },
* },
* LocalResponseCachePerInstance: &appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs{
* Size: pulumi.String("100MB"),
* TimeToLive: pulumi.String("30s"),
* },
* })
* 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.appplatform.SpringCloudService;
* import com.pulumi.azure.appplatform.SpringCloudServiceArgs;
* import com.pulumi.azure.appplatform.SpringCloudGateway;
* import com.pulumi.azure.appplatform.SpringCloudGatewayArgs;
* import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayApiMetadataArgs;
* import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayCorsArgs;
* import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayQuotaArgs;
* import com.pulumi.azure.appplatform.inputs.SpringCloudGatewaySsoArgs;
* import com.pulumi.azure.appplatform.inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs;
* 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")
* .location("West Europe")
* .build());
* var exampleSpringCloudService = new SpringCloudService("exampleSpringCloudService", SpringCloudServiceArgs.builder()
* .name("example")
* .location(example.location())
* .resourceGroupName(example.name())
* .skuName("E0")
* .build());
* var exampleSpringCloudGateway = new SpringCloudGateway("exampleSpringCloudGateway", SpringCloudGatewayArgs.builder()
* .name("default")
* .springCloudServiceId(exampleSpringCloudService.id())
* .httpsOnly(false)
* .publicNetworkAccessEnabled(true)
* .instanceCount(2)
* .apiMetadata(SpringCloudGatewayApiMetadataArgs.builder()
* .description("example description")
* .documentationUrl("https://www.example.com/docs")
* .serverUrl("https://wwww.example.com")
* .title("example title")
* .version("1.0")
* .build())
* .cors(SpringCloudGatewayCorsArgs.builder()
* .credentialsAllowed(false)
* .allowedHeaders("*")
* .allowedMethods("PUT")
* .allowedOrigins("example.com")
* .exposedHeaders("x-example-header")
* .maxAgeSeconds(86400)
* .build())
* .quota(SpringCloudGatewayQuotaArgs.builder()
* .cpu("1")
* .memory("2Gi")
* .build())
* .sso(SpringCloudGatewaySsoArgs.builder()
* .clientId("example id")
* .clientSecret("example secret")
* .issuerUri("https://www.test.com/issueToken")
* .scopes("read")
* .build())
* .localResponseCachePerInstance(SpringCloudGatewayLocalResponseCachePerInstanceArgs.builder()
* .size("100MB")
* .timeToLive("30s")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example
* location: West Europe
* exampleSpringCloudService:
* type: azure:appplatform:SpringCloudService
* name: example
* properties:
* name: example
* location: ${example.location}
* resourceGroupName: ${example.name}
* skuName: E0
* exampleSpringCloudGateway:
* type: azure:appplatform:SpringCloudGateway
* name: example
* properties:
* name: default
* springCloudServiceId: ${exampleSpringCloudService.id}
* httpsOnly: false
* publicNetworkAccessEnabled: true
* instanceCount: 2
* apiMetadata:
* description: example description
* documentationUrl: https://www.example.com/docs
* serverUrl: https://wwww.example.com
* title: example title
* version: '1.0'
* cors:
* credentialsAllowed: false
* allowedHeaders:
* - '*'
* allowedMethods:
* - PUT
* allowedOrigins:
* - example.com
* exposedHeaders:
* - x-example-header
* maxAgeSeconds: 86400
* quota:
* cpu: '1'
* memory: 2Gi
* sso:
* clientId: example id
* clientSecret: example secret
* issuerUri: https://www.test.com/issueToken
* scopes:
* - read
* localResponseCachePerInstance:
* size: 100MB
* timeToLive: 30s
* ```
*
* ## Import
* Spring Cloud Gateways can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:appplatform/springCloudGateway:SpringCloudGateway example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/gateways/gateway1
* ```
*/
public class SpringCloudGateway internal constructor(
override val javaResource: com.pulumi.azure.appplatform.SpringCloudGateway,
) : KotlinCustomResource(javaResource, SpringCloudGatewayMapper) {
/**
* A `api_metadata` block as defined below.
*/
public val apiMetadata: Output?
get() = javaResource.apiMetadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
springCloudGatewayApiMetadataToKotlin(args0)
})
}).orElse(null)
})
/**
* Specifies a list of Spring Cloud Application Performance Monitoring IDs.
*/
public val applicationPerformanceMonitoringIds: Output>?
get() = javaResource.applicationPerformanceMonitoringIds().applyValue({ args0 ->
args0.map({ args0 -> args0.map({ args0 -> args0 }) }).orElse(null)
})
/**
* Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are `AppDynamics`, `ApplicationInsights`, `Dynatrace`, `ElasticAPM` and `NewRelic`.
*/
public val applicationPerformanceMonitoringTypes: Output>?
get() = javaResource.applicationPerformanceMonitoringTypes().applyValue({ args0 ->
args0.map({ args0 -> args0.map({ args0 -> args0 }) }).orElse(null)
})
/**
* A `client_authorization` block as defined below.
*/
public val clientAuthorization: Output?
get() = javaResource.clientAuthorization().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> springCloudGatewayClientAuthorizationToKotlin(args0) })
}).orElse(null)
})
/**
* A `cors` block as defined below.
*/
public val cors: Output?
get() = javaResource.cors().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
springCloudGatewayCorsToKotlin(args0)
})
}).orElse(null)
})
/**
* Specifies the environment variables of the Spring Cloud Gateway as a map of key-value pairs. Changing this forces a new resource to be created.
*/
public val environmentVariables: Output>?
get() = javaResource.environmentVariables().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* is only https is allowed?
*/
public val httpsOnly: Output?
get() = javaResource.httpsOnly().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between `1` and `500`. Defaults to `1` if not specified.
*/
public val instanceCount: Output?
get() = javaResource.instanceCount().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `local_response_cache_per_instance` block as defined below. Only one of `local_response_cache_per_instance` or `local_response_cache_per_route` can be specified.
*/
public val localResponseCachePerInstance: Output?
get() = javaResource.localResponseCachePerInstance().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
springCloudGatewayLocalResponseCachePerInstanceToKotlin(args0)
})
}).orElse(null)
})
/**
* A `local_response_cache_per_route` block as defined below. Only one of `local_response_cache_per_instance` or `local_response_cache_per_route` can be specified.
*/
public val localResponseCachePerRoute: Output?
get() = javaResource.localResponseCachePerRoute().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
springCloudGatewayLocalResponseCachePerRouteToKotlin(args0)
})
}).orElse(null)
})
/**
* The name which should be used for this Spring Cloud Gateway. Changing this forces a new Spring Cloud Gateway to be created. The only possible value is `default`.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Indicates whether the Spring Cloud Gateway exposes endpoint.
*/
public val publicNetworkAccessEnabled: Output?
get() = javaResource.publicNetworkAccessEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A `quota` block as defined below.
*/
public val quota: Output
get() = javaResource.quota().applyValue({ args0 ->
args0.let({ args0 ->
springCloudGatewayQuotaToKotlin(args0)
})
})
/**
* Specifies the sensitive environment variables of the Spring Cloud Gateway as a map of key-value pairs. Changing this forces a new resource to be created.
*/
public val sensitiveEnvironmentVariables: Output>?
get() = javaResource.sensitiveEnvironmentVariables().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.key.to(args0.value) }).toMap()
}).orElse(null)
})
/**
* The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
*/
public val springCloudServiceId: Output
get() = javaResource.springCloudServiceId().applyValue({ args0 -> args0 })
/**
* A `sso` block as defined below.
*/
public val sso: Output?
get() = javaResource.sso().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
springCloudGatewaySsoToKotlin(args0)
})
}).orElse(null)
})
/**
* URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
*/
public val url: Output
get() = javaResource.url().applyValue({ args0 -> args0 })
}
public object SpringCloudGatewayMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.appplatform.SpringCloudGateway::class == javaResource::class
override fun map(javaResource: Resource): SpringCloudGateway = SpringCloudGateway(
javaResource as
com.pulumi.azure.appplatform.SpringCloudGateway,
)
}
/**
* @see [SpringCloudGateway].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [SpringCloudGateway].
*/
public suspend fun springCloudGateway(
name: String,
block: suspend SpringCloudGatewayResourceBuilder.() -> Unit,
): SpringCloudGateway {
val builder = SpringCloudGatewayResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [SpringCloudGateway].
* @param name The _unique_ name of the resulting resource.
*/
public fun springCloudGateway(name: String): SpringCloudGateway {
val builder = SpringCloudGatewayResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy