com.pulumi.azure.lb.kotlin.OutboundRule.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.lb.kotlin
import com.pulumi.azure.lb.kotlin.outputs.OutboundRuleFrontendIpConfiguration
import com.pulumi.azure.lb.kotlin.outputs.OutboundRuleFrontendIpConfiguration.Companion.toKotlin
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
/**
* Builder for [OutboundRule].
*/
@PulumiTagMarker
public class OutboundRuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: OutboundRuleArgs = OutboundRuleArgs()
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 OutboundRuleArgsBuilder.() -> Unit) {
val builder = OutboundRuleArgsBuilder()
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(): OutboundRule {
val builtJavaResource = com.pulumi.azure.lb.OutboundRule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return OutboundRule(builtJavaResource)
}
}
/**
* Manages a Load Balancer Outbound Rule.
* > **NOTE** When using this resource, the Load Balancer needs to have a FrontEnd IP Configuration and a Backend Address Pool Attached.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "LoadBalancerRG",
* location: "West Europe",
* });
* const examplePublicIp = new azure.network.PublicIp("example", {
* name: "PublicIPForLB",
* location: example.location,
* resourceGroupName: example.name,
* allocationMethod: "Static",
* });
* const exampleLoadBalancer = new azure.lb.LoadBalancer("example", {
* name: "TestLoadBalancer",
* location: example.location,
* resourceGroupName: example.name,
* frontendIpConfigurations: [{
* name: "PublicIPAddress",
* publicIpAddressId: examplePublicIp.id,
* }],
* });
* const exampleBackendAddressPool = new azure.lb.BackendAddressPool("example", {
* name: "example",
* loadbalancerId: exampleLoadBalancer.id,
* });
* const exampleOutboundRule = new azure.lb.OutboundRule("example", {
* name: "OutboundRule",
* loadbalancerId: exampleLoadBalancer.id,
* protocol: "Tcp",
* backendAddressPoolId: exampleBackendAddressPool.id,
* frontendIpConfigurations: [{
* name: "PublicIPAddress",
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="LoadBalancerRG",
* location="West Europe")
* example_public_ip = azure.network.PublicIp("example",
* name="PublicIPForLB",
* location=example.location,
* resource_group_name=example.name,
* allocation_method="Static")
* example_load_balancer = azure.lb.LoadBalancer("example",
* name="TestLoadBalancer",
* location=example.location,
* resource_group_name=example.name,
* frontend_ip_configurations=[{
* "name": "PublicIPAddress",
* "public_ip_address_id": example_public_ip.id,
* }])
* example_backend_address_pool = azure.lb.BackendAddressPool("example",
* name="example",
* loadbalancer_id=example_load_balancer.id)
* example_outbound_rule = azure.lb.OutboundRule("example",
* name="OutboundRule",
* loadbalancer_id=example_load_balancer.id,
* protocol="Tcp",
* backend_address_pool_id=example_backend_address_pool.id,
* frontend_ip_configurations=[{
* "name": "PublicIPAddress",
* }])
* ```
* ```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 = "LoadBalancerRG",
* Location = "West Europe",
* });
* var examplePublicIp = new Azure.Network.PublicIp("example", new()
* {
* Name = "PublicIPForLB",
* Location = example.Location,
* ResourceGroupName = example.Name,
* AllocationMethod = "Static",
* });
* var exampleLoadBalancer = new Azure.Lb.LoadBalancer("example", new()
* {
* Name = "TestLoadBalancer",
* Location = example.Location,
* ResourceGroupName = example.Name,
* FrontendIpConfigurations = new[]
* {
* new Azure.Lb.Inputs.LoadBalancerFrontendIpConfigurationArgs
* {
* Name = "PublicIPAddress",
* PublicIpAddressId = examplePublicIp.Id,
* },
* },
* });
* var exampleBackendAddressPool = new Azure.Lb.BackendAddressPool("example", new()
* {
* Name = "example",
* LoadbalancerId = exampleLoadBalancer.Id,
* });
* var exampleOutboundRule = new Azure.Lb.OutboundRule("example", new()
* {
* Name = "OutboundRule",
* LoadbalancerId = exampleLoadBalancer.Id,
* Protocol = "Tcp",
* BackendAddressPoolId = exampleBackendAddressPool.Id,
* FrontendIpConfigurations = new[]
* {
* new Azure.Lb.Inputs.OutboundRuleFrontendIpConfigurationArgs
* {
* Name = "PublicIPAddress",
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lb"
* "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("LoadBalancerRG"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
* Name: pulumi.String("PublicIPForLB"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* AllocationMethod: pulumi.String("Static"),
* })
* if err != nil {
* return err
* }
* exampleLoadBalancer, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
* Name: pulumi.String("TestLoadBalancer"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* FrontendIpConfigurations: lb.LoadBalancerFrontendIpConfigurationArray{
* &lb.LoadBalancerFrontendIpConfigurationArgs{
* Name: pulumi.String("PublicIPAddress"),
* PublicIpAddressId: examplePublicIp.ID(),
* },
* },
* })
* if err != nil {
* return err
* }
* exampleBackendAddressPool, err := lb.NewBackendAddressPool(ctx, "example", &lb.BackendAddressPoolArgs{
* Name: pulumi.String("example"),
* LoadbalancerId: exampleLoadBalancer.ID(),
* })
* if err != nil {
* return err
* }
* _, err = lb.NewOutboundRule(ctx, "example", &lb.OutboundRuleArgs{
* Name: pulumi.String("OutboundRule"),
* LoadbalancerId: exampleLoadBalancer.ID(),
* Protocol: pulumi.String("Tcp"),
* BackendAddressPoolId: exampleBackendAddressPool.ID(),
* FrontendIpConfigurations: lb.OutboundRuleFrontendIpConfigurationArray{
* &lb.OutboundRuleFrontendIpConfigurationArgs{
* Name: pulumi.String("PublicIPAddress"),
* },
* },
* })
* 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.PublicIp;
* import com.pulumi.azure.network.PublicIpArgs;
* import com.pulumi.azure.lb.LoadBalancer;
* import com.pulumi.azure.lb.LoadBalancerArgs;
* import com.pulumi.azure.lb.inputs.LoadBalancerFrontendIpConfigurationArgs;
* import com.pulumi.azure.lb.BackendAddressPool;
* import com.pulumi.azure.lb.BackendAddressPoolArgs;
* import com.pulumi.azure.lb.OutboundRule;
* import com.pulumi.azure.lb.OutboundRuleArgs;
* import com.pulumi.azure.lb.inputs.OutboundRuleFrontendIpConfigurationArgs;
* 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("LoadBalancerRG")
* .location("West Europe")
* .build());
* var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
* .name("PublicIPForLB")
* .location(example.location())
* .resourceGroupName(example.name())
* .allocationMethod("Static")
* .build());
* var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
* .name("TestLoadBalancer")
* .location(example.location())
* .resourceGroupName(example.name())
* .frontendIpConfigurations(LoadBalancerFrontendIpConfigurationArgs.builder()
* .name("PublicIPAddress")
* .publicIpAddressId(examplePublicIp.id())
* .build())
* .build());
* var exampleBackendAddressPool = new BackendAddressPool("exampleBackendAddressPool", BackendAddressPoolArgs.builder()
* .name("example")
* .loadbalancerId(exampleLoadBalancer.id())
* .build());
* var exampleOutboundRule = new OutboundRule("exampleOutboundRule", OutboundRuleArgs.builder()
* .name("OutboundRule")
* .loadbalancerId(exampleLoadBalancer.id())
* .protocol("Tcp")
* .backendAddressPoolId(exampleBackendAddressPool.id())
* .frontendIpConfigurations(OutboundRuleFrontendIpConfigurationArgs.builder()
* .name("PublicIPAddress")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: LoadBalancerRG
* location: West Europe
* examplePublicIp:
* type: azure:network:PublicIp
* name: example
* properties:
* name: PublicIPForLB
* location: ${example.location}
* resourceGroupName: ${example.name}
* allocationMethod: Static
* exampleLoadBalancer:
* type: azure:lb:LoadBalancer
* name: example
* properties:
* name: TestLoadBalancer
* location: ${example.location}
* resourceGroupName: ${example.name}
* frontendIpConfigurations:
* - name: PublicIPAddress
* publicIpAddressId: ${examplePublicIp.id}
* exampleBackendAddressPool:
* type: azure:lb:BackendAddressPool
* name: example
* properties:
* name: example
* loadbalancerId: ${exampleLoadBalancer.id}
* exampleOutboundRule:
* type: azure:lb:OutboundRule
* name: example
* properties:
* name: OutboundRule
* loadbalancerId: ${exampleLoadBalancer.id}
* protocol: Tcp
* backendAddressPoolId: ${exampleBackendAddressPool.id}
* frontendIpConfigurations:
* - name: PublicIPAddress
* ```
*
* ## Import
* Load Balancer Outbound Rules can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:lb/outboundRule:OutboundRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1
* ```
*/
public class OutboundRule internal constructor(
override val javaResource: com.pulumi.azure.lb.OutboundRule,
) : KotlinCustomResource(javaResource, OutboundRuleMapper) {
/**
* The number of outbound ports to be used for NAT. Defaults to `1024`.
*/
public val allocatedOutboundPorts: Output?
get() = javaResource.allocatedOutboundPorts().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
*/
public val backendAddressPoolId: Output
get() = javaResource.backendAddressPoolId().applyValue({ args0 -> args0 })
/**
* Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
*/
public val enableTcpReset: Output?
get() = javaResource.enableTcpReset().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* One or more `frontend_ip_configuration` blocks as defined below.
*/
public val frontendIpConfigurations: Output>?
get() = javaResource.frontendIpConfigurations().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}).orElse(null)
})
/**
* The timeout for the TCP idle connection Defaults to `4`.
*/
public val idleTimeoutInMinutes: Output?
get() = javaResource.idleTimeoutInMinutes().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the Load Balancer in which to create the Outbound Rule. Changing this forces a new resource to be created.
*/
public val loadbalancerId: Output
get() = javaResource.loadbalancerId().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Outbound Rule. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The transport protocol for the external endpoint. Possible values are `Udp`, `Tcp` or `All`.
*/
public val protocol: Output
get() = javaResource.protocol().applyValue({ args0 -> args0 })
}
public object OutboundRuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.lb.OutboundRule::class == javaResource::class
override fun map(javaResource: Resource): OutboundRule = OutboundRule(
javaResource as
com.pulumi.azure.lb.OutboundRule,
)
}
/**
* @see [OutboundRule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [OutboundRule].
*/
public suspend fun outboundRule(
name: String,
block: suspend OutboundRuleResourceBuilder.() -> Unit,
): OutboundRule {
val builder = OutboundRuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [OutboundRule].
* @param name The _unique_ name of the resulting resource.
*/
public fun outboundRule(name: String): OutboundRule {
val builder = OutboundRuleResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy