pulumi-azure-kotlin/com.pulumi.azure.cdn.kotlin/FrontdoorRouteArgs

FrontdoorRouteArgs

data class FrontdoorRouteArgs(val cache: Output<FrontdoorRouteCacheArgs>? = null, val cdnFrontdoorCustomDomainIds: Output<List<String>>? = null, val cdnFrontdoorEndpointId: Output<String>? = null, val cdnFrontdoorOriginGroupId: Output<String>? = null, val cdnFrontdoorOriginIds: Output<List<String>>? = null, val cdnFrontdoorOriginPath: Output<String>? = null, val cdnFrontdoorRuleSetIds: Output<List<String>>? = null, val enabled: Output<Boolean>? = null, val forwardingProtocol: Output<String>? = null, val httpsRedirectEnabled: Output<Boolean>? = null, val linkToDefaultDomain: Output<Boolean>? = null, val name: Output<String>? = null, val patternsToMatches: Output<List<String>>? = null, val supportedProtocols: Output<List<String>>? = null) : ConvertibleToJava<FrontdoorRouteArgs>

Manages a Front Door (standard/premium) Route.

Example Usage

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.dns.Zone;
import com.pulumi.azure.dns.ZoneArgs;
import com.pulumi.azure.cdn.FrontdoorProfile;
import com.pulumi.azure.cdn.FrontdoorProfileArgs;
import com.pulumi.azure.cdn.FrontdoorOriginGroup;
import com.pulumi.azure.cdn.FrontdoorOriginGroupArgs;
import com.pulumi.azure.cdn.inputs.FrontdoorOriginGroupLoadBalancingArgs;
import com.pulumi.azure.cdn.FrontdoorOrigin;
import com.pulumi.azure.cdn.FrontdoorOriginArgs;
import com.pulumi.azure.cdn.FrontdoorEndpoint;
import com.pulumi.azure.cdn.FrontdoorEndpointArgs;
import com.pulumi.azure.cdn.FrontdoorRuleSet;
import com.pulumi.azure.cdn.FrontdoorRuleSetArgs;
import com.pulumi.azure.cdn.FrontdoorCustomDomain;
import com.pulumi.azure.cdn.FrontdoorCustomDomainArgs;
import com.pulumi.azure.cdn.inputs.FrontdoorCustomDomainTlsArgs;
import com.pulumi.azure.cdn.FrontdoorRoute;
import com.pulumi.azure.cdn.FrontdoorRouteArgs;
import com.pulumi.azure.cdn.inputs.FrontdoorRouteCacheArgs;
import com.pulumi.azure.cdn.FrontdoorCustomDomainAssociation;
import com.pulumi.azure.cdn.FrontdoorCustomDomainAssociationArgs;
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-cdn-frontdoor")
            .location("West Europe")
            .build());
        var exampleZone = new Zone("exampleZone", ZoneArgs.builder()
            .name("example.com")
            .resourceGroupName(example.name())
            .build());
        var exampleFrontdoorProfile = new FrontdoorProfile("exampleFrontdoorProfile", FrontdoorProfileArgs.builder()
            .name("example-profile")
            .resourceGroupName(example.name())
            .skuName("Standard_AzureFrontDoor")
            .build());
        var exampleFrontdoorOriginGroup = new FrontdoorOriginGroup("exampleFrontdoorOriginGroup", FrontdoorOriginGroupArgs.builder()
            .name("example-originGroup")
            .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
            .loadBalancing(FrontdoorOriginGroupLoadBalancingArgs.builder()
                .additionalLatencyInMilliseconds(0)
                .sampleSize(16)
                .successfulSamplesRequired(3)
                .build())
            .build());
        var exampleFrontdoorOrigin = new FrontdoorOrigin("exampleFrontdoorOrigin", FrontdoorOriginArgs.builder()
            .name("example-origin")
            .cdnFrontdoorOriginGroupId(exampleFrontdoorOriginGroup.id())
            .enabled(true)
            .certificateNameCheckEnabled(false)
            .hostName("contoso.com")
            .httpPort(80)
            .httpsPort(443)
            .originHostHeader("www.contoso.com")
            .priority(1)
            .weight(1)
            .build());
        var exampleFrontdoorEndpoint = new FrontdoorEndpoint("exampleFrontdoorEndpoint", FrontdoorEndpointArgs.builder()
            .name("example-endpoint")
            .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
            .build());
        var exampleFrontdoorRuleSet = new FrontdoorRuleSet("exampleFrontdoorRuleSet", FrontdoorRuleSetArgs.builder()
            .name("ExampleRuleSet")
            .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
            .build());
        var contoso = new FrontdoorCustomDomain("contoso", FrontdoorCustomDomainArgs.builder()
            .name("contoso-custom-domain")
            .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
            .dnsZoneId(exampleZone.id())
            .hostName(StdFunctions.join().applyValue(invoke -> invoke.result()))
            .tls(FrontdoorCustomDomainTlsArgs.builder()
                .certificateType("ManagedCertificate")
                .minimumTlsVersion("TLS12")
                .build())
            .build());
        var fabrikam = new FrontdoorCustomDomain("fabrikam", FrontdoorCustomDomainArgs.builder()
            .name("fabrikam-custom-domain")
            .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
            .dnsZoneId(exampleZone.id())
            .hostName(StdFunctions.join().applyValue(invoke -> invoke.result()))
            .tls(FrontdoorCustomDomainTlsArgs.builder()
                .certificateType("ManagedCertificate")
                .minimumTlsVersion("TLS12")
                .build())
            .build());
        var exampleFrontdoorRoute = new FrontdoorRoute("exampleFrontdoorRoute", FrontdoorRouteArgs.builder()
            .name("example-route")
            .cdnFrontdoorEndpointId(exampleFrontdoorEndpoint.id())
            .cdnFrontdoorOriginGroupId(exampleFrontdoorOriginGroup.id())
            .cdnFrontdoorOriginIds(exampleFrontdoorOrigin.id())
            .cdnFrontdoorRuleSetIds(exampleFrontdoorRuleSet.id())
            .enabled(true)
            .forwardingProtocol("HttpsOnly")
            .httpsRedirectEnabled(true)
            .patternsToMatches("/*")
            .supportedProtocols(
                "Http",
                "Https")
            .cdnFrontdoorCustomDomainIds(
                contoso.id(),
                fabrikam.id())
            .linkToDefaultDomain(false)
            .cache(FrontdoorRouteCacheArgs.builder()
                .queryStringCachingBehavior("IgnoreSpecifiedQueryStrings")
                .queryStrings(
                    "account",
                    "settings")
                .compressionEnabled(true)
                .contentTypesToCompresses(
                    "text/html",
                    "text/javascript",
                    "text/xml")
                .build())
            .build());
        var contosoFrontdoorCustomDomainAssociation = new FrontdoorCustomDomainAssociation("contosoFrontdoorCustomDomainAssociation", FrontdoorCustomDomainAssociationArgs.builder()
            .cdnFrontdoorCustomDomainId(contoso.id())
            .cdnFrontdoorRouteIds(exampleFrontdoorRoute.id())
            .build());
        var fabrikamFrontdoorCustomDomainAssociation = new FrontdoorCustomDomainAssociation("fabrikamFrontdoorCustomDomainAssociation", FrontdoorCustomDomainAssociationArgs.builder()
            .cdnFrontdoorCustomDomainId(fabrikam.id())
            .cdnFrontdoorRouteIds(exampleFrontdoorRoute.id())
            .build());
    }
}

Import

Front Door Routes can be imported using the resource id, e.g.

$ pulumi import azure:cdn/frontdoorRoute:FrontdoorRoute example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1

Constructors

FrontdoorRouteArgs

fun FrontdoorRouteArgs(cache: Output<FrontdoorRouteCacheArgs>? = null, cdnFrontdoorCustomDomainIds: Output<List<String>>? = null, cdnFrontdoorEndpointId: Output<String>? = null, cdnFrontdoorOriginGroupId: Output<String>? = null, cdnFrontdoorOriginIds: Output<List<String>>? = null, cdnFrontdoorOriginPath: Output<String>? = null, cdnFrontdoorRuleSetIds: Output<List<String>>? = null, enabled: Output<Boolean>? = null, forwardingProtocol: Output<String>? = null, httpsRedirectEnabled: Output<Boolean>? = null, linkToDefaultDomain: Output<Boolean>? = null, name: Output<String>? = null, patternsToMatches: Output<List<String>>? = null, supportedProtocols: Output<List<String>>? = null)

Functions

toJava

open override fun toJava(): FrontdoorRouteArgs

Properties

cache

val cache: Output<FrontdoorRouteCacheArgs>? = null

A cache block as defined below.

cdnFrontdoorCustomDomainIds

val cdnFrontdoorCustomDomainIds: Output<List<String>>? = null

The IDs of the Front Door Custom Domains which are associated with this Front Door Route.

cdnFrontdoorEndpointId

val cdnFrontdoorEndpointId: Output<String>? = null

The resource ID of the Front Door Endpoint where this Front Door Route should exist. Changing this forces a new Front Door Route to be created.

cdnFrontdoorOriginGroupId

val cdnFrontdoorOriginGroupId: Output<String>? = null

The resource ID of the Front Door Origin Group where this Front Door Route should be created.

cdnFrontdoorOriginIds

val cdnFrontdoorOriginIds: Output<List<String>>? = null

One or more Front Door Origin resource IDs that this Front Door Route will link to.

cdnFrontdoorOriginPath

val cdnFrontdoorOriginPath: Output<String>? = null

A directory path on the Front Door Origin that can be used to retrieve content (e.g. contoso.cloudapp.net/originpath).

cdnFrontdoorRuleSetIds

val cdnFrontdoorRuleSetIds: Output<List<String>>? = null

A list of the Front Door Rule Set IDs which should be assigned to this Front Door Route.

enabled

val enabled: Output<Boolean>? = null

Is this Front Door Route enabled? Possible values are true or false. Defaults to true.

forwardingProtocol

val forwardingProtocol: Output<String>? = null

The Protocol that will be use when forwarding traffic to backends. Possible values are HttpOnly, HttpsOnly or MatchRequest. Defaults to MatchRequest.

httpsRedirectEnabled

val httpsRedirectEnabled: Output<Boolean>? = null

Automatically redirect HTTP traffic to HTTPS traffic? Possible values are true or false. Defaults to true.

linkToDefaultDomain

val linkToDefaultDomain: Output<Boolean>? = null

Should this Front Door Route be linked to the default endpoint? Possible values include true or false. Defaults to true.

name

val name: Output<String>? = null

The name which should be used for this Front Door Route. Valid values must begin with a letter or number, end with a letter or number and may only contain letters, numbers and hyphens with a maximum length of 90 characters. Changing this forces a new Front Door Route to be created.

patternsToMatches

val patternsToMatches: Output<List<String>>? = null

The route patterns of the rule.

supportedProtocols

val supportedProtocols: Output<List<String>>? = null

One or more Protocols supported by this Front Door Route. Possible values are Http or Https.