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

com.pulumi.azure.cdn.kotlin.Endpoint.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.cdn.kotlin

import com.pulumi.azure.cdn.kotlin.outputs.EndpointDeliveryRule
import com.pulumi.azure.cdn.kotlin.outputs.EndpointGeoFilter
import com.pulumi.azure.cdn.kotlin.outputs.EndpointGlobalDeliveryRule
import com.pulumi.azure.cdn.kotlin.outputs.EndpointOrigin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.azure.cdn.kotlin.outputs.EndpointDeliveryRule.Companion.toKotlin as endpointDeliveryRuleToKotlin
import com.pulumi.azure.cdn.kotlin.outputs.EndpointGeoFilter.Companion.toKotlin as endpointGeoFilterToKotlin
import com.pulumi.azure.cdn.kotlin.outputs.EndpointGlobalDeliveryRule.Companion.toKotlin as endpointGlobalDeliveryRuleToKotlin
import com.pulumi.azure.cdn.kotlin.outputs.EndpointOrigin.Companion.toKotlin as endpointOriginToKotlin

/**
 * Builder for [Endpoint].
 */
@PulumiTagMarker
public class EndpointResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: EndpointArgs = EndpointArgs()

    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 EndpointArgsBuilder.() -> Unit) {
        val builder = EndpointArgsBuilder()
        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(): Endpoint {
        val builtJavaResource = com.pulumi.azure.cdn.Endpoint(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Endpoint(builtJavaResource)
    }
}

/**
 * A CDN Endpoint is the entity within a CDN Profile containing configuration information regarding caching behaviours and origins. The CDN Endpoint is exposed using the URL format `.azureedge.net`.
 * !> **Be Aware:** Azure is rolling out a breaking change on Friday 9th April 2021 which may cause issues with the CDN/FrontDoor resources. More information is available in this GitHub issue as the necessary changes are identified.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleProfile = new azure.cdn.Profile("example", {
 *     name: "example-cdn",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     sku: "Standard_Verizon",
 * });
 * const exampleEndpoint = new azure.cdn.Endpoint("example", {
 *     name: "example",
 *     profileName: exampleProfile.name,
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     origins: [{
 *         name: "example",
 *         hostName: "www.contoso.com",
 *     }],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_profile = azure.cdn.Profile("example",
 *     name="example-cdn",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     sku="Standard_Verizon")
 * example_endpoint = azure.cdn.Endpoint("example",
 *     name="example",
 *     profile_name=example_profile.name,
 *     location=example.location,
 *     resource_group_name=example.name,
 *     origins=[{
 *         "name": "example",
 *         "host_name": "www.contoso.com",
 *     }])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleProfile = new Azure.Cdn.Profile("example", new()
 *     {
 *         Name = "example-cdn",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         Sku = "Standard_Verizon",
 *     });
 *     var exampleEndpoint = new Azure.Cdn.Endpoint("example", new()
 *     {
 *         Name = "example",
 *         ProfileName = exampleProfile.Name,
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         Origins = new[]
 *         {
 *             new Azure.Cdn.Inputs.EndpointOriginArgs
 *             {
 *                 Name = "example",
 *                 HostName = "www.contoso.com",
 *             },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cdn"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleProfile, err := cdn.NewProfile(ctx, "example", &cdn.ProfileArgs{
 * 			Name:              pulumi.String("example-cdn"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			Sku:               pulumi.String("Standard_Verizon"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = cdn.NewEndpoint(ctx, "example", &cdn.EndpointArgs{
 * 			Name:              pulumi.String("example"),
 * 			ProfileName:       exampleProfile.Name,
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			Origins: cdn.EndpointOriginArray{
 * 				&cdn.EndpointOriginArgs{
 * 					Name:     pulumi.String("example"),
 * 					HostName: pulumi.String("www.contoso.com"),
 * 				},
 * 			},
 * 		})
 * 		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.cdn.Profile;
 * import com.pulumi.azure.cdn.ProfileArgs;
 * import com.pulumi.azure.cdn.Endpoint;
 * import com.pulumi.azure.cdn.EndpointArgs;
 * import com.pulumi.azure.cdn.inputs.EndpointOriginArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleProfile = new Profile("exampleProfile", ProfileArgs.builder()
 *             .name("example-cdn")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .sku("Standard_Verizon")
 *             .build());
 *         var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()
 *             .name("example")
 *             .profileName(exampleProfile.name())
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .origins(EndpointOriginArgs.builder()
 *                 .name("example")
 *                 .hostName("www.contoso.com")
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleProfile:
 *     type: azure:cdn:Profile
 *     name: example
 *     properties:
 *       name: example-cdn
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       sku: Standard_Verizon
 *   exampleEndpoint:
 *     type: azure:cdn:Endpoint
 *     name: example
 *     properties:
 *       name: example
 *       profileName: ${exampleProfile.name}
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       origins:
 *         - name: example
 *           hostName: www.contoso.com
 * ```
 * 
 * ## Import
 * CDN Endpoints can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:cdn/endpoint:Endpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Cdn/profiles/myprofile1/endpoints/myendpoint1
 * ```
 */
public class Endpoint internal constructor(
    override val javaResource: com.pulumi.azure.cdn.Endpoint,
) : KotlinCustomResource(javaResource, EndpointMapper) {
    /**
     * An array of strings that indicates a content types on which compression will be applied. The value for the elements should be MIME types.
     */
    public val contentTypesToCompresses: Output>
        get() = javaResource.contentTypesToCompresses().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            })
        })

    /**
     * Rules for the rules engine. An endpoint can contain up until 4 of those rules that consist of conditions and actions. A `delivery_rule` blocks as defined below.
     */
    public val deliveryRules: Output>?
        get() = javaResource.deliveryRules().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 ->
                        endpointDeliveryRuleToKotlin(args0)
                    })
                })
            }).orElse(null)
        })

    /**
     * The Fully Qualified Domain Name of the CDN Endpoint.
     */
    public val fqdn: Output
        get() = javaResource.fqdn().applyValue({ args0 -> args0 })

    /**
     * A set of Geo Filters for this CDN Endpoint. Each `geo_filter` block supports fields documented below.
     */
    public val geoFilters: Output>?
        get() = javaResource.geoFilters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> endpointGeoFilterToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * Actions that are valid for all resources regardless of any conditions. A `global_delivery_rule` block as defined below.
     */
    public val globalDeliveryRule: Output?
        get() = javaResource.globalDeliveryRule().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> endpointGlobalDeliveryRuleToKotlin(args0) })
            }).orElse(null)
        })

    /**
     * Indicates whether compression is to be enabled.
     */
    public val isCompressionEnabled: Output?
        get() = javaResource.isCompressionEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies if http allowed. Defaults to `true`.
     */
    public val isHttpAllowed: Output?
        get() = javaResource.isHttpAllowed().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies if https allowed. Defaults to `true`.
     */
    public val isHttpsAllowed: Output?
        get() = javaResource.isHttpsAllowed().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * Specifies the name of the CDN Endpoint. Changing this forces a new resource to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * What types of optimization should this CDN Endpoint optimize for? Possible values include `DynamicSiteAcceleration`, `GeneralMediaStreaming`, `GeneralWebDelivery`, `LargeFileDownload` and `VideoOnDemandMediaStreaming`.
     */
    public val optimizationType: Output?
        get() = javaResource.optimizationType().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The host header CDN provider will send along with content requests to origins.
     */
    public val originHostHeader: Output?
        get() = javaResource.originHostHeader().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The path used at for origin requests.
     */
    public val originPath: Output
        get() = javaResource.originPath().applyValue({ args0 -> args0 })

    /**
     * The set of origins of the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. Each `origin` block supports fields documented below. Changing this forces a new resource to be created.
     */
    public val origins: Output>
        get() = javaResource.origins().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    endpointOriginToKotlin(args0)
                })
            })
        })

    /**
     * the path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the `origin_path`.
     * > **NOTE:** `global_delivery_rule` and `delivery_rule` are currently only available for `Microsoft_Standard` CDN profiles.
     */
    public val probePath: Output
        get() = javaResource.probePath().applyValue({ args0 -> args0 })

    /**
     * The CDN Profile to which to attach the CDN Endpoint. Changing this forces a new resource to be created.
     */
    public val profileName: Output
        get() = javaResource.profileName().applyValue({ args0 -> args0 })

    /**
     * Sets query string caching behavior. Allowed values are `IgnoreQueryString`, `BypassCaching` and `UseQueryString`. `NotSet` value can be used for `Premium Verizon` CDN profile. Defaults to `IgnoreQueryString`.
     */
    public val querystringCachingBehaviour: Output?
        get() = javaResource.querystringCachingBehaviour().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The name of the resource group in which to create the CDN Endpoint. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * A mapping of tags to assign to the resource.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })
}

public object EndpointMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.cdn.Endpoint::class == javaResource::class

    override fun map(javaResource: Resource): Endpoint = Endpoint(
        javaResource as
            com.pulumi.azure.cdn.Endpoint,
    )
}

/**
 * @see [Endpoint].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Endpoint].
 */
public suspend fun endpoint(name: String, block: suspend EndpointResourceBuilder.() -> Unit): Endpoint {
    val builder = EndpointResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Endpoint].
 * @param name The _unique_ name of the resulting resource.
 */
public fun endpoint(name: String): Endpoint {
    val builder = EndpointResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy