We recommend using Azure Native.
azure.appplatform.SpringCloudGateway
Explore with Pulumi AI
NOTE: This resource is applicable only for Spring Cloud Service with enterprise tier.
Manages a Spring Cloud Gateway.
Example Usage
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",
},
});
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",
))
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
})
}
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",
},
});
});
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());
}
}
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
Create SpringCloudGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SpringCloudGateway(name: string, args: SpringCloudGatewayArgs, opts?: CustomResourceOptions);
@overload
def SpringCloudGateway(resource_name: str,
args: SpringCloudGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SpringCloudGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
spring_cloud_service_id: Optional[str] = None,
local_response_cache_per_instance: Optional[SpringCloudGatewayLocalResponseCachePerInstanceArgs] = None,
local_response_cache_per_route: Optional[SpringCloudGatewayLocalResponseCachePerRouteArgs] = None,
client_authorization: Optional[SpringCloudGatewayClientAuthorizationArgs] = None,
cors: Optional[SpringCloudGatewayCorsArgs] = None,
environment_variables: Optional[Mapping[str, str]] = None,
https_only: Optional[bool] = None,
application_performance_monitoring_types: Optional[Sequence[str]] = None,
api_metadata: Optional[SpringCloudGatewayApiMetadataArgs] = None,
instance_count: Optional[int] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
quota: Optional[SpringCloudGatewayQuotaArgs] = None,
sensitive_environment_variables: Optional[Mapping[str, str]] = None,
application_performance_monitoring_ids: Optional[Sequence[str]] = None,
sso: Optional[SpringCloudGatewaySsoArgs] = None)
func NewSpringCloudGateway(ctx *Context, name string, args SpringCloudGatewayArgs, opts ...ResourceOption) (*SpringCloudGateway, error)
public SpringCloudGateway(string name, SpringCloudGatewayArgs args, CustomResourceOptions? opts = null)
public SpringCloudGateway(String name, SpringCloudGatewayArgs args)
public SpringCloudGateway(String name, SpringCloudGatewayArgs args, CustomResourceOptions options)
type: azure:appplatform:SpringCloudGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SpringCloudGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SpringCloudGatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SpringCloudGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SpringCloudGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SpringCloudGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var springCloudGatewayResource = new Azure.AppPlatform.SpringCloudGateway("springCloudGatewayResource", new()
{
SpringCloudServiceId = "string",
LocalResponseCachePerInstance = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerInstanceArgs
{
Size = "string",
TimeToLive = "string",
},
LocalResponseCachePerRoute = new Azure.AppPlatform.Inputs.SpringCloudGatewayLocalResponseCachePerRouteArgs
{
Size = "string",
TimeToLive = "string",
},
ClientAuthorization = new Azure.AppPlatform.Inputs.SpringCloudGatewayClientAuthorizationArgs
{
CertificateIds = new[]
{
"string",
},
VerificationEnabled = false,
},
Cors = new Azure.AppPlatform.Inputs.SpringCloudGatewayCorsArgs
{
AllowedHeaders = new[]
{
"string",
},
AllowedMethods = new[]
{
"string",
},
AllowedOriginPatterns = new[]
{
"string",
},
AllowedOrigins = new[]
{
"string",
},
CredentialsAllowed = false,
ExposedHeaders = new[]
{
"string",
},
MaxAgeSeconds = 0,
},
EnvironmentVariables =
{
{ "string", "string" },
},
HttpsOnly = false,
ApplicationPerformanceMonitoringTypes = new[]
{
"string",
},
ApiMetadata = new Azure.AppPlatform.Inputs.SpringCloudGatewayApiMetadataArgs
{
Description = "string",
DocumentationUrl = "string",
ServerUrl = "string",
Title = "string",
Version = "string",
},
InstanceCount = 0,
Name = "string",
PublicNetworkAccessEnabled = false,
Quota = new Azure.AppPlatform.Inputs.SpringCloudGatewayQuotaArgs
{
Cpu = "string",
Memory = "string",
},
SensitiveEnvironmentVariables =
{
{ "string", "string" },
},
ApplicationPerformanceMonitoringIds = new[]
{
"string",
},
Sso = new Azure.AppPlatform.Inputs.SpringCloudGatewaySsoArgs
{
ClientId = "string",
ClientSecret = "string",
IssuerUri = "string",
Scopes = new[]
{
"string",
},
},
});
example, err := appplatform.NewSpringCloudGateway(ctx, "springCloudGatewayResource", &appplatform.SpringCloudGatewayArgs{
SpringCloudServiceId: pulumi.String("string"),
LocalResponseCachePerInstance: &appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs{
Size: pulumi.String("string"),
TimeToLive: pulumi.String("string"),
},
LocalResponseCachePerRoute: &appplatform.SpringCloudGatewayLocalResponseCachePerRouteArgs{
Size: pulumi.String("string"),
TimeToLive: pulumi.String("string"),
},
ClientAuthorization: &appplatform.SpringCloudGatewayClientAuthorizationArgs{
CertificateIds: pulumi.StringArray{
pulumi.String("string"),
},
VerificationEnabled: pulumi.Bool(false),
},
Cors: &appplatform.SpringCloudGatewayCorsArgs{
AllowedHeaders: pulumi.StringArray{
pulumi.String("string"),
},
AllowedMethods: pulumi.StringArray{
pulumi.String("string"),
},
AllowedOriginPatterns: pulumi.StringArray{
pulumi.String("string"),
},
AllowedOrigins: pulumi.StringArray{
pulumi.String("string"),
},
CredentialsAllowed: pulumi.Bool(false),
ExposedHeaders: pulumi.StringArray{
pulumi.String("string"),
},
MaxAgeSeconds: pulumi.Int(0),
},
EnvironmentVariables: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpsOnly: pulumi.Bool(false),
ApplicationPerformanceMonitoringTypes: pulumi.StringArray{
pulumi.String("string"),
},
ApiMetadata: &appplatform.SpringCloudGatewayApiMetadataArgs{
Description: pulumi.String("string"),
DocumentationUrl: pulumi.String("string"),
ServerUrl: pulumi.String("string"),
Title: pulumi.String("string"),
Version: pulumi.String("string"),
},
InstanceCount: pulumi.Int(0),
Name: pulumi.String("string"),
PublicNetworkAccessEnabled: pulumi.Bool(false),
Quota: &appplatform.SpringCloudGatewayQuotaArgs{
Cpu: pulumi.String("string"),
Memory: pulumi.String("string"),
},
SensitiveEnvironmentVariables: pulumi.StringMap{
"string": pulumi.String("string"),
},
ApplicationPerformanceMonitoringIds: pulumi.StringArray{
pulumi.String("string"),
},
Sso: &appplatform.SpringCloudGatewaySsoArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
IssuerUri: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
},
})
var springCloudGatewayResource = new SpringCloudGateway("springCloudGatewayResource", SpringCloudGatewayArgs.builder()
.springCloudServiceId("string")
.localResponseCachePerInstance(SpringCloudGatewayLocalResponseCachePerInstanceArgs.builder()
.size("string")
.timeToLive("string")
.build())
.localResponseCachePerRoute(SpringCloudGatewayLocalResponseCachePerRouteArgs.builder()
.size("string")
.timeToLive("string")
.build())
.clientAuthorization(SpringCloudGatewayClientAuthorizationArgs.builder()
.certificateIds("string")
.verificationEnabled(false)
.build())
.cors(SpringCloudGatewayCorsArgs.builder()
.allowedHeaders("string")
.allowedMethods("string")
.allowedOriginPatterns("string")
.allowedOrigins("string")
.credentialsAllowed(false)
.exposedHeaders("string")
.maxAgeSeconds(0)
.build())
.environmentVariables(Map.of("string", "string"))
.httpsOnly(false)
.applicationPerformanceMonitoringTypes("string")
.apiMetadata(SpringCloudGatewayApiMetadataArgs.builder()
.description("string")
.documentationUrl("string")
.serverUrl("string")
.title("string")
.version("string")
.build())
.instanceCount(0)
.name("string")
.publicNetworkAccessEnabled(false)
.quota(SpringCloudGatewayQuotaArgs.builder()
.cpu("string")
.memory("string")
.build())
.sensitiveEnvironmentVariables(Map.of("string", "string"))
.applicationPerformanceMonitoringIds("string")
.sso(SpringCloudGatewaySsoArgs.builder()
.clientId("string")
.clientSecret("string")
.issuerUri("string")
.scopes("string")
.build())
.build());
spring_cloud_gateway_resource = azure.appplatform.SpringCloudGateway("springCloudGatewayResource",
spring_cloud_service_id="string",
local_response_cache_per_instance=azure.appplatform.SpringCloudGatewayLocalResponseCachePerInstanceArgs(
size="string",
time_to_live="string",
),
local_response_cache_per_route=azure.appplatform.SpringCloudGatewayLocalResponseCachePerRouteArgs(
size="string",
time_to_live="string",
),
client_authorization=azure.appplatform.SpringCloudGatewayClientAuthorizationArgs(
certificate_ids=["string"],
verification_enabled=False,
),
cors=azure.appplatform.SpringCloudGatewayCorsArgs(
allowed_headers=["string"],
allowed_methods=["string"],
allowed_origin_patterns=["string"],
allowed_origins=["string"],
credentials_allowed=False,
exposed_headers=["string"],
max_age_seconds=0,
),
environment_variables={
"string": "string",
},
https_only=False,
application_performance_monitoring_types=["string"],
api_metadata=azure.appplatform.SpringCloudGatewayApiMetadataArgs(
description="string",
documentation_url="string",
server_url="string",
title="string",
version="string",
),
instance_count=0,
name="string",
public_network_access_enabled=False,
quota=azure.appplatform.SpringCloudGatewayQuotaArgs(
cpu="string",
memory="string",
),
sensitive_environment_variables={
"string": "string",
},
application_performance_monitoring_ids=["string"],
sso=azure.appplatform.SpringCloudGatewaySsoArgs(
client_id="string",
client_secret="string",
issuer_uri="string",
scopes=["string"],
))
const springCloudGatewayResource = new azure.appplatform.SpringCloudGateway("springCloudGatewayResource", {
springCloudServiceId: "string",
localResponseCachePerInstance: {
size: "string",
timeToLive: "string",
},
localResponseCachePerRoute: {
size: "string",
timeToLive: "string",
},
clientAuthorization: {
certificateIds: ["string"],
verificationEnabled: false,
},
cors: {
allowedHeaders: ["string"],
allowedMethods: ["string"],
allowedOriginPatterns: ["string"],
allowedOrigins: ["string"],
credentialsAllowed: false,
exposedHeaders: ["string"],
maxAgeSeconds: 0,
},
environmentVariables: {
string: "string",
},
httpsOnly: false,
applicationPerformanceMonitoringTypes: ["string"],
apiMetadata: {
description: "string",
documentationUrl: "string",
serverUrl: "string",
title: "string",
version: "string",
},
instanceCount: 0,
name: "string",
publicNetworkAccessEnabled: false,
quota: {
cpu: "string",
memory: "string",
},
sensitiveEnvironmentVariables: {
string: "string",
},
applicationPerformanceMonitoringIds: ["string"],
sso: {
clientId: "string",
clientSecret: "string",
issuerUri: "string",
scopes: ["string"],
},
});
type: azure:appplatform:SpringCloudGateway
properties:
apiMetadata:
description: string
documentationUrl: string
serverUrl: string
title: string
version: string
applicationPerformanceMonitoringIds:
- string
applicationPerformanceMonitoringTypes:
- string
clientAuthorization:
certificateIds:
- string
verificationEnabled: false
cors:
allowedHeaders:
- string
allowedMethods:
- string
allowedOriginPatterns:
- string
allowedOrigins:
- string
credentialsAllowed: false
exposedHeaders:
- string
maxAgeSeconds: 0
environmentVariables:
string: string
httpsOnly: false
instanceCount: 0
localResponseCachePerInstance:
size: string
timeToLive: string
localResponseCachePerRoute:
size: string
timeToLive: string
name: string
publicNetworkAccessEnabled: false
quota:
cpu: string
memory: string
sensitiveEnvironmentVariables:
string: string
springCloudServiceId: string
sso:
clientId: string
clientSecret: string
issuerUri: string
scopes:
- string
SpringCloudGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SpringCloudGateway resource accepts the following input properties:
- Spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- Api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - Application
Performance List<string>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- Application
Performance List<string>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - Cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - Environment
Variables Dictionary<string, string> - 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.
- Https
Only bool - is only https is allowed?
- Instance
Count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - Local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Name string
- 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
Network boolAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- Quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - Sensitive
Environment Dictionary<string, string>Variables - 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.
- Sso
Spring
Cloud Gateway Sso - A
sso
block as defined below.
- Spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- Api
Metadata SpringCloud Gateway Api Metadata Args - A
api_metadata
block as defined below. - Application
Performance []stringMonitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- Application
Performance []stringMonitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization Args - A
client_authorization
block as defined below. - Cors
Spring
Cloud Gateway Cors Args - A
cors
block as defined below. - Environment
Variables map[string]string - 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.
- Https
Only bool - is only https is allowed?
- Instance
Count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - Local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance Args - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route Args - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Name string
- 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
Network boolAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- Quota
Spring
Cloud Gateway Quota Args - A
quota
block as defined below. - Sensitive
Environment map[string]stringVariables - 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.
- Sso
Spring
Cloud Gateway Sso Args - A
sso
block as defined below.
- spring
Cloud StringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - application
Performance List<String>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance List<String>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - environment
Variables Map<String,String> - 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.
- https
Only Boolean - is only https is allowed?
- instance
Count Integer - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name String
- 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
Network BooleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - sensitive
Environment Map<String,String>Variables - 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.
- sso
Spring
Cloud Gateway Sso - A
sso
block as defined below.
- spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - application
Performance string[]Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance string[]Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - environment
Variables {[key: string]: string} - 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.
- https
Only boolean - is only https is allowed?
- instance
Count number - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name string
- 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
Network booleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - sensitive
Environment {[key: string]: string}Variables - 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.
- sso
Spring
Cloud Gateway Sso - A
sso
block as defined below.
- spring_
cloud_ strservice_ id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- api_
metadata SpringCloud Gateway Api Metadata Args - A
api_metadata
block as defined below. - application_
performance_ Sequence[str]monitoring_ ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application_
performance_ Sequence[str]monitoring_ types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization Args - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors Args - A
cors
block as defined below. - environment_
variables Mapping[str, str] - 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.
- https_
only bool - is only https is allowed?
- instance_
count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local_
response_ Springcache_ per_ instance Cloud Gateway Local Response Cache Per Instance Args - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local_
response_ Springcache_ per_ route Cloud Gateway Local Response Cache Per Route Args - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name str
- 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_
network_ boolaccess_ enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota Args - A
quota
block as defined below. - sensitive_
environment_ Mapping[str, str]variables - 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.
- sso
Spring
Cloud Gateway Sso Args - A
sso
block as defined below.
- spring
Cloud StringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- api
Metadata Property Map - A
api_metadata
block as defined below. - application
Performance List<String>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance List<String>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Property Map
- A
client_authorization
block as defined below. - cors Property Map
- A
cors
block as defined below. - environment
Variables Map<String> - 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.
- https
Only Boolean - is only https is allowed?
- instance
Count Number - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response Property MapCache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response Property MapCache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name String
- 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
Network BooleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota Property Map
- A
quota
block as defined below. - sensitive
Environment Map<String>Variables - 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.
- sso Property Map
- A
sso
block as defined below.
Outputs
All input properties are implicitly available as output properties. Additionally, the SpringCloudGateway resource produces the following output properties:
Look up Existing SpringCloudGateway Resource
Get an existing SpringCloudGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SpringCloudGatewayState, opts?: CustomResourceOptions): SpringCloudGateway
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_metadata: Optional[SpringCloudGatewayApiMetadataArgs] = None,
application_performance_monitoring_ids: Optional[Sequence[str]] = None,
application_performance_monitoring_types: Optional[Sequence[str]] = None,
client_authorization: Optional[SpringCloudGatewayClientAuthorizationArgs] = None,
cors: Optional[SpringCloudGatewayCorsArgs] = None,
environment_variables: Optional[Mapping[str, str]] = None,
https_only: Optional[bool] = None,
instance_count: Optional[int] = None,
local_response_cache_per_instance: Optional[SpringCloudGatewayLocalResponseCachePerInstanceArgs] = None,
local_response_cache_per_route: Optional[SpringCloudGatewayLocalResponseCachePerRouteArgs] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
quota: Optional[SpringCloudGatewayQuotaArgs] = None,
sensitive_environment_variables: Optional[Mapping[str, str]] = None,
spring_cloud_service_id: Optional[str] = None,
sso: Optional[SpringCloudGatewaySsoArgs] = None,
url: Optional[str] = None) -> SpringCloudGateway
func GetSpringCloudGateway(ctx *Context, name string, id IDInput, state *SpringCloudGatewayState, opts ...ResourceOption) (*SpringCloudGateway, error)
public static SpringCloudGateway Get(string name, Input<string> id, SpringCloudGatewayState? state, CustomResourceOptions? opts = null)
public static SpringCloudGateway get(String name, Output<String> id, SpringCloudGatewayState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - Application
Performance List<string>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- Application
Performance List<string>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - Cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - Environment
Variables Dictionary<string, string> - 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.
- Https
Only bool - is only https is allowed?
- Instance
Count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - Local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Name string
- 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
Network boolAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- Quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - Sensitive
Environment Dictionary<string, string>Variables - 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.
- Spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- Sso
Spring
Cloud Gateway Sso - A
sso
block as defined below. - Url string
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
- Api
Metadata SpringCloud Gateway Api Metadata Args - A
api_metadata
block as defined below. - Application
Performance []stringMonitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- Application
Performance []stringMonitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization Args - A
client_authorization
block as defined below. - Cors
Spring
Cloud Gateway Cors Args - A
cors
block as defined below. - Environment
Variables map[string]string - 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.
- Https
Only bool - is only https is allowed?
- Instance
Count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - Local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance Args - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route Args - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - Name string
- 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
Network boolAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- Quota
Spring
Cloud Gateway Quota Args - A
quota
block as defined below. - Sensitive
Environment map[string]stringVariables - 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.
- Spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- Sso
Spring
Cloud Gateway Sso Args - A
sso
block as defined below. - Url string
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
- api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - application
Performance List<String>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance List<String>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - environment
Variables Map<String,String> - 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.
- https
Only Boolean - is only https is allowed?
- instance
Count Integer - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name String
- 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
Network BooleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - sensitive
Environment Map<String,String>Variables - 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.
- spring
Cloud StringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- sso
Spring
Cloud Gateway Sso - A
sso
block as defined below. - url String
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
- api
Metadata SpringCloud Gateway Api Metadata - A
api_metadata
block as defined below. - application
Performance string[]Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance string[]Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors - A
cors
block as defined below. - environment
Variables {[key: string]: string} - 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.
- https
Only boolean - is only https is allowed?
- instance
Count number - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response SpringCache Per Instance Cloud Gateway Local Response Cache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response SpringCache Per Route Cloud Gateway Local Response Cache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name string
- 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
Network booleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota - A
quota
block as defined below. - sensitive
Environment {[key: string]: string}Variables - 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.
- spring
Cloud stringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- sso
Spring
Cloud Gateway Sso - A
sso
block as defined below. - url string
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
- api_
metadata SpringCloud Gateway Api Metadata Args - A
api_metadata
block as defined below. - application_
performance_ Sequence[str]monitoring_ ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application_
performance_ Sequence[str]monitoring_ types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Spring
Cloud Gateway Client Authorization Args - A
client_authorization
block as defined below. - cors
Spring
Cloud Gateway Cors Args - A
cors
block as defined below. - environment_
variables Mapping[str, str] - 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.
- https_
only bool - is only https is allowed?
- instance_
count int - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local_
response_ Springcache_ per_ instance Cloud Gateway Local Response Cache Per Instance Args - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local_
response_ Springcache_ per_ route Cloud Gateway Local Response Cache Per Route Args - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name str
- 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_
network_ boolaccess_ enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota
Spring
Cloud Gateway Quota Args - A
quota
block as defined below. - sensitive_
environment_ Mapping[str, str]variables - 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.
- spring_
cloud_ strservice_ id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- sso
Spring
Cloud Gateway Sso Args - A
sso
block as defined below. - url str
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
- api
Metadata Property Map - A
api_metadata
block as defined below. - application
Performance List<String>Monitoring Ids - Specifies a list of Spring Cloud Application Performance Monitoring IDs.
- application
Performance List<String>Monitoring Types - Specifies a list of application performance monitoring types used in the Spring Cloud Gateway. The allowed values are
AppDynamics
,ApplicationInsights
,Dynatrace
,ElasticAPM
andNewRelic
. - Property Map
- A
client_authorization
block as defined below. - cors Property Map
- A
cors
block as defined below. - environment
Variables Map<String> - 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.
- https
Only Boolean - is only https is allowed?
- instance
Count Number - Specifies the required instance count of the Spring Cloud Gateway. Possible Values are between
1
and500
. Defaults to1
if not specified. - local
Response Property MapCache Per Instance - A
local_response_cache_per_instance
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - local
Response Property MapCache Per Route - A
local_response_cache_per_route
block as defined below. Only one oflocal_response_cache_per_instance
orlocal_response_cache_per_route
can be specified. - name String
- 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
Network BooleanAccess Enabled - Indicates whether the Spring Cloud Gateway exposes endpoint.
- quota Property Map
- A
quota
block as defined below. - sensitive
Environment Map<String>Variables - 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.
- spring
Cloud StringService Id - The ID of the Spring Cloud Service. Changing this forces a new Spring Cloud Gateway to be created.
- sso Property Map
- A
sso
block as defined below. - url String
- URL of the Spring Cloud Gateway, exposed when 'public_network_access_enabled' is true.
Supporting Types
SpringCloudGatewayApiMetadata, SpringCloudGatewayApiMetadataArgs
- Description string
- Detailed description of the APIs available on the Gateway instance.
- Documentation
Url string - Location of additional documentation for the APIs available on the Gateway instance.
- Server
Url string - Base URL that API consumers will use to access APIs on the Gateway instance.
- Title string
- Specifies the title describing the context of the APIs available on the Gateway instance.
- Version string
- Specifies the version of APIs available on this Gateway instance.
- Description string
- Detailed description of the APIs available on the Gateway instance.
- Documentation
Url string - Location of additional documentation for the APIs available on the Gateway instance.
- Server
Url string - Base URL that API consumers will use to access APIs on the Gateway instance.
- Title string
- Specifies the title describing the context of the APIs available on the Gateway instance.
- Version string
- Specifies the version of APIs available on this Gateway instance.
- description String
- Detailed description of the APIs available on the Gateway instance.
- documentation
Url String - Location of additional documentation for the APIs available on the Gateway instance.
- server
Url String - Base URL that API consumers will use to access APIs on the Gateway instance.
- title String
- Specifies the title describing the context of the APIs available on the Gateway instance.
- version String
- Specifies the version of APIs available on this Gateway instance.
- description string
- Detailed description of the APIs available on the Gateway instance.
- documentation
Url string - Location of additional documentation for the APIs available on the Gateway instance.
- server
Url string - Base URL that API consumers will use to access APIs on the Gateway instance.
- title string
- Specifies the title describing the context of the APIs available on the Gateway instance.
- version string
- Specifies the version of APIs available on this Gateway instance.
- description str
- Detailed description of the APIs available on the Gateway instance.
- documentation_
url str - Location of additional documentation for the APIs available on the Gateway instance.
- server_
url str - Base URL that API consumers will use to access APIs on the Gateway instance.
- title str
- Specifies the title describing the context of the APIs available on the Gateway instance.
- version str
- Specifies the version of APIs available on this Gateway instance.
- description String
- Detailed description of the APIs available on the Gateway instance.
- documentation
Url String - Location of additional documentation for the APIs available on the Gateway instance.
- server
Url String - Base URL that API consumers will use to access APIs on the Gateway instance.
- title String
- Specifies the title describing the context of the APIs available on the Gateway instance.
- version String
- Specifies the version of APIs available on this Gateway instance.
SpringCloudGatewayClientAuthorization, SpringCloudGatewayClientAuthorizationArgs
- Certificate
Ids List<string> - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- Verification
Enabled bool - Specifies whether the client certificate verification is enabled.
- Certificate
Ids []string - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- Verification
Enabled bool - Specifies whether the client certificate verification is enabled.
- certificate
Ids List<String> - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- verification
Enabled Boolean - Specifies whether the client certificate verification is enabled.
- certificate
Ids string[] - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- verification
Enabled boolean - Specifies whether the client certificate verification is enabled.
- certificate_
ids Sequence[str] - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- verification_
enabled bool - Specifies whether the client certificate verification is enabled.
- certificate
Ids List<String> - Specifies the Spring Cloud Certificate IDs of the Spring Cloud Gateway.
- verification
Enabled Boolean - Specifies whether the client certificate verification is enabled.
SpringCloudGatewayCors, SpringCloudGatewayCorsArgs
- Allowed
Headers List<string> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - Allowed
Methods List<string> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - Allowed
Origin List<string>Patterns - Allowed origin patterns to make cross-site requests.
- Allowed
Origins List<string> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - Credentials
Allowed bool - is user credentials are supported on cross-site requests?
- Exposed
Headers List<string> - HTTP response headers to expose for cross-site requests.
- Max
Age intSeconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
- Allowed
Headers []string - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - Allowed
Methods []string - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - Allowed
Origin []stringPatterns - Allowed origin patterns to make cross-site requests.
- Allowed
Origins []string - Allowed origins to make cross-site requests. The special value
*
allows all domains. - Credentials
Allowed bool - is user credentials are supported on cross-site requests?
- Exposed
Headers []string - HTTP response headers to expose for cross-site requests.
- Max
Age intSeconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
- allowed
Headers List<String> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods List<String> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - allowed
Origin List<String>Patterns - Allowed origin patterns to make cross-site requests.
- allowed
Origins List<String> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - credentials
Allowed Boolean - is user credentials are supported on cross-site requests?
- exposed
Headers List<String> - HTTP response headers to expose for cross-site requests.
- max
Age IntegerSeconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
- allowed
Headers string[] - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods string[] - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - allowed
Origin string[]Patterns - Allowed origin patterns to make cross-site requests.
- allowed
Origins string[] - Allowed origins to make cross-site requests. The special value
*
allows all domains. - credentials
Allowed boolean - is user credentials are supported on cross-site requests?
- exposed
Headers string[] - HTTP response headers to expose for cross-site requests.
- max
Age numberSeconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
- allowed_
headers Sequence[str] - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed_
methods Sequence[str] - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - allowed_
origin_ Sequence[str]patterns - Allowed origin patterns to make cross-site requests.
- allowed_
origins Sequence[str] - Allowed origins to make cross-site requests. The special value
*
allows all domains. - credentials_
allowed bool - is user credentials are supported on cross-site requests?
- exposed_
headers Sequence[str] - HTTP response headers to expose for cross-site requests.
- max_
age_ intseconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
- allowed
Headers List<String> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods List<String> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. Possible values areDELETE
,GET
,HEAD
,MERGE
,POST
,OPTIONS
andPUT
. - allowed
Origin List<String>Patterns - Allowed origin patterns to make cross-site requests.
- allowed
Origins List<String> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - credentials
Allowed Boolean - is user credentials are supported on cross-site requests?
- exposed
Headers List<String> - HTTP response headers to expose for cross-site requests.
- max
Age NumberSeconds - How long, in seconds, the response from a pre-flight request can be cached by clients.
SpringCloudGatewayLocalResponseCachePerInstance, SpringCloudGatewayLocalResponseCachePerInstanceArgs
- Size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- Time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- Size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- Time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size String
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To StringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size str
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time_
to_ strlive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size String
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To StringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
SpringCloudGatewayLocalResponseCachePerRoute, SpringCloudGatewayLocalResponseCachePerRouteArgs
- Size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- Time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- Size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- Time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size String
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To StringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size string
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To stringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size str
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time_
to_ strlive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
- size String
- Specifies the maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
- time
To StringLive - Specifies the time before a cached entry is expired (300s, 5m, 1h...).
SpringCloudGatewayQuota, SpringCloudGatewayQuotaArgs
- Cpu string
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- Memory string
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
- Cpu string
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- Memory string
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
- cpu String
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- memory String
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
- cpu string
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- memory string
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
- cpu str
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- memory str
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
- cpu String
Specifies the required cpu of the Spring Cloud Deployment. Possible Values are
500m
,1
,2
,3
and4
. Defaults to1
if not specified.Note:
cpu
supports500m
and1
for Basic tier,500m
,1
,2
,3
and4
for Standard tier.- memory String
Specifies the required memory size of the Spring Cloud Deployment. Possible Values are
512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
. Defaults to2Gi
if not specified.Note:
memory
supports512Mi
,1Gi
and2Gi
for Basic tier,512Mi
,1Gi
,2Gi
,3Gi
,4Gi
,5Gi
,6Gi
,7Gi
, and8Gi
for Standard tier.
SpringCloudGatewaySso, SpringCloudGatewaySsoArgs
- Client
Id string - The public identifier for the application.
- Client
Secret string - The secret known only to the application and the authorization server.
- Issuer
Uri string - The URI of Issuer Identifier.
- Scopes List<string>
- It defines the specific actions applications can be allowed to do on a user's behalf.
- Client
Id string - The public identifier for the application.
- Client
Secret string - The secret known only to the application and the authorization server.
- Issuer
Uri string - The URI of Issuer Identifier.
- Scopes []string
- It defines the specific actions applications can be allowed to do on a user's behalf.
- client
Id String - The public identifier for the application.
- client
Secret String - The secret known only to the application and the authorization server.
- issuer
Uri String - The URI of Issuer Identifier.
- scopes List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf.
- client
Id string - The public identifier for the application.
- client
Secret string - The secret known only to the application and the authorization server.
- issuer
Uri string - The URI of Issuer Identifier.
- scopes string[]
- It defines the specific actions applications can be allowed to do on a user's behalf.
- client_
id str - The public identifier for the application.
- client_
secret str - The secret known only to the application and the authorization server.
- issuer_
uri str - The URI of Issuer Identifier.
- scopes Sequence[str]
- It defines the specific actions applications can be allowed to do on a user's behalf.
- client
Id String - The public identifier for the application.
- client
Secret String - The secret known only to the application and the authorization server.
- issuer
Uri String - The URI of Issuer Identifier.
- scopes List<String>
- It defines the specific actions applications can be allowed to do on a user's behalf.
Import
Spring Cloud Gateways can be imported using the resource id
, e.g.
$ pulumi import azure:appplatform/springCloudGateway:SpringCloudGateway example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resourceGroup1/providers/Microsoft.AppPlatform/spring/service1/gateways/gateway1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.