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

com.pulumi.azure.network.kotlin.TrafficManagerExternalEndpoint.kt Maven / Gradle / Ivy

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

package com.pulumi.azure.network.kotlin

import com.pulumi.azure.network.kotlin.outputs.TrafficManagerExternalEndpointCustomHeader
import com.pulumi.azure.network.kotlin.outputs.TrafficManagerExternalEndpointSubnet
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.azure.network.kotlin.outputs.TrafficManagerExternalEndpointCustomHeader.Companion.toKotlin as trafficManagerExternalEndpointCustomHeaderToKotlin
import com.pulumi.azure.network.kotlin.outputs.TrafficManagerExternalEndpointSubnet.Companion.toKotlin as trafficManagerExternalEndpointSubnetToKotlin

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

    public var args: TrafficManagerExternalEndpointArgs = TrafficManagerExternalEndpointArgs()

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

/**
 * Manages an External Endpoint within a Traffic Manager Profile.
 * ## 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 exampleTrafficManagerProfile = new azure.network.TrafficManagerProfile("example", {
 *     name: "example-profile",
 *     resourceGroupName: example.name,
 *     trafficRoutingMethod: "Weighted",
 *     dnsConfig: {
 *         relativeName: "example-profile",
 *         ttl: 100,
 *     },
 *     monitorConfig: {
 *         protocol: "HTTP",
 *         port: 80,
 *         path: "/",
 *         intervalInSeconds: 30,
 *         timeoutInSeconds: 9,
 *         toleratedNumberOfFailures: 3,
 *     },
 *     tags: {
 *         environment: "Production",
 *     },
 * });
 * const exampleTrafficManagerExternalEndpoint = new azure.network.TrafficManagerExternalEndpoint("example", {
 *     name: "example-endpoint",
 *     profileId: exampleTrafficManagerProfile.id,
 *     alwaysServeEnabled: true,
 *     weight: 100,
 *     target: "www.example.com",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_traffic_manager_profile = azure.network.TrafficManagerProfile("example",
 *     name="example-profile",
 *     resource_group_name=example.name,
 *     traffic_routing_method="Weighted",
 *     dns_config={
 *         "relative_name": "example-profile",
 *         "ttl": 100,
 *     },
 *     monitor_config={
 *         "protocol": "HTTP",
 *         "port": 80,
 *         "path": "/",
 *         "interval_in_seconds": 30,
 *         "timeout_in_seconds": 9,
 *         "tolerated_number_of_failures": 3,
 *     },
 *     tags={
 *         "environment": "Production",
 *     })
 * example_traffic_manager_external_endpoint = azure.network.TrafficManagerExternalEndpoint("example",
 *     name="example-endpoint",
 *     profile_id=example_traffic_manager_profile.id,
 *     always_serve_enabled=True,
 *     weight=100,
 *     target="www.example.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 exampleTrafficManagerProfile = new Azure.Network.TrafficManagerProfile("example", new()
 *     {
 *         Name = "example-profile",
 *         ResourceGroupName = example.Name,
 *         TrafficRoutingMethod = "Weighted",
 *         DnsConfig = new Azure.Network.Inputs.TrafficManagerProfileDnsConfigArgs
 *         {
 *             RelativeName = "example-profile",
 *             Ttl = 100,
 *         },
 *         MonitorConfig = new Azure.Network.Inputs.TrafficManagerProfileMonitorConfigArgs
 *         {
 *             Protocol = "HTTP",
 *             Port = 80,
 *             Path = "/",
 *             IntervalInSeconds = 30,
 *             TimeoutInSeconds = 9,
 *             ToleratedNumberOfFailures = 3,
 *         },
 *         Tags =
 *         {
 *             { "environment", "Production" },
 *         },
 *     });
 *     var exampleTrafficManagerExternalEndpoint = new Azure.Network.TrafficManagerExternalEndpoint("example", new()
 *     {
 *         Name = "example-endpoint",
 *         ProfileId = exampleTrafficManagerProfile.Id,
 *         AlwaysServeEnabled = true,
 *         Weight = 100,
 *         Target = "www.example.com",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/network"
 * 	"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
 * 		}
 * 		exampleTrafficManagerProfile, err := network.NewTrafficManagerProfile(ctx, "example", &network.TrafficManagerProfileArgs{
 * 			Name:                 pulumi.String("example-profile"),
 * 			ResourceGroupName:    example.Name,
 * 			TrafficRoutingMethod: pulumi.String("Weighted"),
 * 			DnsConfig: &network.TrafficManagerProfileDnsConfigArgs{
 * 				RelativeName: pulumi.String("example-profile"),
 * 				Ttl:          pulumi.Int(100),
 * 			},
 * 			MonitorConfig: &network.TrafficManagerProfileMonitorConfigArgs{
 * 				Protocol:                  pulumi.String("HTTP"),
 * 				Port:                      pulumi.Int(80),
 * 				Path:                      pulumi.String("/"),
 * 				IntervalInSeconds:         pulumi.Int(30),
 * 				TimeoutInSeconds:          pulumi.Int(9),
 * 				ToleratedNumberOfFailures: pulumi.Int(3),
 * 			},
 * 			Tags: pulumi.StringMap{
 * 				"environment": pulumi.String("Production"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = network.NewTrafficManagerExternalEndpoint(ctx, "example", &network.TrafficManagerExternalEndpointArgs{
 * 			Name:               pulumi.String("example-endpoint"),
 * 			ProfileId:          exampleTrafficManagerProfile.ID(),
 * 			AlwaysServeEnabled: pulumi.Bool(true),
 * 			Weight:             pulumi.Int(100),
 * 			Target:             pulumi.String("www.example.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.network.TrafficManagerProfile;
 * import com.pulumi.azure.network.TrafficManagerProfileArgs;
 * import com.pulumi.azure.network.inputs.TrafficManagerProfileDnsConfigArgs;
 * import com.pulumi.azure.network.inputs.TrafficManagerProfileMonitorConfigArgs;
 * import com.pulumi.azure.network.TrafficManagerExternalEndpoint;
 * import com.pulumi.azure.network.TrafficManagerExternalEndpointArgs;
 * 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 exampleTrafficManagerProfile = new TrafficManagerProfile("exampleTrafficManagerProfile", TrafficManagerProfileArgs.builder()
 *             .name("example-profile")
 *             .resourceGroupName(example.name())
 *             .trafficRoutingMethod("Weighted")
 *             .dnsConfig(TrafficManagerProfileDnsConfigArgs.builder()
 *                 .relativeName("example-profile")
 *                 .ttl(100)
 *                 .build())
 *             .monitorConfig(TrafficManagerProfileMonitorConfigArgs.builder()
 *                 .protocol("HTTP")
 *                 .port(80)
 *                 .path("/")
 *                 .intervalInSeconds(30)
 *                 .timeoutInSeconds(9)
 *                 .toleratedNumberOfFailures(3)
 *                 .build())
 *             .tags(Map.of("environment", "Production"))
 *             .build());
 *         var exampleTrafficManagerExternalEndpoint = new TrafficManagerExternalEndpoint("exampleTrafficManagerExternalEndpoint", TrafficManagerExternalEndpointArgs.builder()
 *             .name("example-endpoint")
 *             .profileId(exampleTrafficManagerProfile.id())
 *             .alwaysServeEnabled(true)
 *             .weight(100)
 *             .target("www.example.com")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleTrafficManagerProfile:
 *     type: azure:network:TrafficManagerProfile
 *     name: example
 *     properties:
 *       name: example-profile
 *       resourceGroupName: ${example.name}
 *       trafficRoutingMethod: Weighted
 *       dnsConfig:
 *         relativeName: example-profile
 *         ttl: 100
 *       monitorConfig:
 *         protocol: HTTP
 *         port: 80
 *         path: /
 *         intervalInSeconds: 30
 *         timeoutInSeconds: 9
 *         toleratedNumberOfFailures: 3
 *       tags:
 *         environment: Production
 *   exampleTrafficManagerExternalEndpoint:
 *     type: azure:network:TrafficManagerExternalEndpoint
 *     name: example
 *     properties:
 *       name: example-endpoint
 *       profileId: ${exampleTrafficManagerProfile.id}
 *       alwaysServeEnabled: true
 *       weight: 100
 *       target: www.example.com
 * ```
 * 
 * ## Import
 * External Endpoints can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:network/trafficManagerExternalEndpoint:TrafficManagerExternalEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-group/providers/Microsoft.Network/trafficManagerProfiles/example-profile/ExternalEndpoints/example-endpoint
 * ```
 */
public class TrafficManagerExternalEndpoint internal constructor(
    override val javaResource: com.pulumi.azure.network.TrafficManagerExternalEndpoint,
) : KotlinCustomResource(javaResource, TrafficManagerExternalEndpointMapper) {
    /**
     * If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. Defaults to `false`.
     */
    public val alwaysServeEnabled: Output?
        get() = javaResource.alwaysServeEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * One or more `custom_header` blocks as defined below.
     */
    public val customHeaders: Output>?
        get() = javaResource.customHeaders().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 ->
                        trafficManagerExternalEndpointCustomHeaderToKotlin(args0)
                    })
                })
            }).orElse(null)
        })

    /**
     * Is the endpoint enabled? Defaults to `true`.
     */
    public val enabled: Output?
        get() = javaResource.enabled().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Specifies the Azure location of the Endpoint, this must be specified for Profiles using the `Performance` routing method.
     */
    public val endpointLocation: Output
        get() = javaResource.endpointLocation().applyValue({ args0 -> args0 })

    /**
     * A list of Geographic Regions used to distribute traffic, such as `WORLD`, `UK` or `DE`. The same location can't be specified in two endpoints. [See the Geographic Hierarchies documentation for more information](https://docs.microsoft.com/rest/api/trafficmanager/geographichierarchies/getdefault).
     */
    public val geoMappings: Output>?
        get() = javaResource.geoMappings().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

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

    /**
     * Specifies the priority of this Endpoint, this must be specified for Profiles using the `Priority` traffic routing method. Supports values between 1 and 1000, with no Endpoints sharing the same value. If omitted the value will be computed in order of creation.
     */
    public val priority: Output
        get() = javaResource.priority().applyValue({ args0 -> args0 })

    /**
     * The ID of the Traffic Manager Profile that this External Endpoint should be created within. Changing this forces a new resource to be created.
     */
    public val profileId: Output
        get() = javaResource.profileId().applyValue({ args0 -> args0 })

    /**
     * One or more `subnet` blocks as defined below. Changing this forces a new resource to be created.
     */
    public val subnets: Output>?
        get() = javaResource.subnets().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> trafficManagerExternalEndpointSubnetToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * The FQDN DNS name of the target.
     */
    public val target: Output
        get() = javaResource.target().applyValue({ args0 -> args0 })

    /**
     * Specifies how much traffic should be distributed to this endpoint, this must be specified for Profiles using the Weighted traffic routing method. Valid values are between `1` and `1000`.
     */
    public val weight: Output
        get() = javaResource.weight().applyValue({ args0 -> args0 })
}

public object TrafficManagerExternalEndpointMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.network.TrafficManagerExternalEndpoint::class == javaResource::class

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy