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

com.pulumi.azure.mariadb.kotlin.FirewallRule.kt Maven / Gradle / Ivy

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

package com.pulumi.azure.mariadb.kotlin

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

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

    public var args: FirewallRuleArgs = FirewallRuleArgs()

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

/**
 * Manages a Firewall Rule for a MariaDB Server
 * ## Example Usage
 * ### Single IP Address)
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.mariadb.FirewallRule("example", {
 *     name: "test-rule",
 *     resourceGroupName: "test-rg",
 *     serverName: "test-server",
 *     startIpAddress: "40.112.8.12",
 *     endIpAddress: "40.112.8.12",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.mariadb.FirewallRule("example",
 *     name="test-rule",
 *     resource_group_name="test-rg",
 *     server_name="test-server",
 *     start_ip_address="40.112.8.12",
 *     end_ip_address="40.112.8.12")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.MariaDB.FirewallRule("example", new()
 *     {
 *         Name = "test-rule",
 *         ResourceGroupName = "test-rg",
 *         ServerName = "test-server",
 *         StartIpAddress = "40.112.8.12",
 *         EndIpAddress = "40.112.8.12",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mariadb"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := mariadb.NewFirewallRule(ctx, "example", &mariadb.FirewallRuleArgs{
 * 			Name:              pulumi.String("test-rule"),
 * 			ResourceGroupName: pulumi.String("test-rg"),
 * 			ServerName:        pulumi.String("test-server"),
 * 			StartIpAddress:    pulumi.String("40.112.8.12"),
 * 			EndIpAddress:      pulumi.String("40.112.8.12"),
 * 		})
 * 		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.mariadb.FirewallRule;
 * import com.pulumi.azure.mariadb.FirewallRuleArgs;
 * 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 FirewallRule("example", FirewallRuleArgs.builder()
 *             .name("test-rule")
 *             .resourceGroupName("test-rg")
 *             .serverName("test-server")
 *             .startIpAddress("40.112.8.12")
 *             .endIpAddress("40.112.8.12")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:mariadb:FirewallRule
 *     properties:
 *       name: test-rule
 *       resourceGroupName: test-rg
 *       serverName: test-server
 *       startIpAddress: 40.112.8.12
 *       endIpAddress: 40.112.8.12
 * ```
 * 
 * ### IP Range)
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.mariadb.FirewallRule("example", {
 *     name: "test-rule",
 *     resourceGroupName: "test-rg",
 *     serverName: "test-server",
 *     startIpAddress: "40.112.0.0",
 *     endIpAddress: "40.112.255.255",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.mariadb.FirewallRule("example",
 *     name="test-rule",
 *     resource_group_name="test-rg",
 *     server_name="test-server",
 *     start_ip_address="40.112.0.0",
 *     end_ip_address="40.112.255.255")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.MariaDB.FirewallRule("example", new()
 *     {
 *         Name = "test-rule",
 *         ResourceGroupName = "test-rg",
 *         ServerName = "test-server",
 *         StartIpAddress = "40.112.0.0",
 *         EndIpAddress = "40.112.255.255",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mariadb"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := mariadb.NewFirewallRule(ctx, "example", &mariadb.FirewallRuleArgs{
 * 			Name:              pulumi.String("test-rule"),
 * 			ResourceGroupName: pulumi.String("test-rg"),
 * 			ServerName:        pulumi.String("test-server"),
 * 			StartIpAddress:    pulumi.String("40.112.0.0"),
 * 			EndIpAddress:      pulumi.String("40.112.255.255"),
 * 		})
 * 		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.mariadb.FirewallRule;
 * import com.pulumi.azure.mariadb.FirewallRuleArgs;
 * 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 FirewallRule("example", FirewallRuleArgs.builder()
 *             .name("test-rule")
 *             .resourceGroupName("test-rg")
 *             .serverName("test-server")
 *             .startIpAddress("40.112.0.0")
 *             .endIpAddress("40.112.255.255")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:mariadb:FirewallRule
 *     properties:
 *       name: test-rule
 *       resourceGroupName: test-rg
 *       serverName: test-server
 *       startIpAddress: 40.112.0.0
 *       endIpAddress: 40.112.255.255
 * ```
 * 
 * ## Import
 * MariaDB Firewall rules can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:mariadb/firewallRule:FirewallRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforMariaDB/servers/server1/firewallRules/rule1
 * ```
 */
public class FirewallRule internal constructor(
    override val javaResource: com.pulumi.azure.mariadb.FirewallRule,
) : KotlinCustomResource(javaResource, FirewallRuleMapper) {
    /**
     * Specifies the End IP Address associated with this Firewall Rule.
     * > **NOTE:** The Azure feature `Allow access to Azure services` can be enabled by setting `start_ip_address` and `end_ip_address` to `0.0.0.0` which ([is documented in the Azure API Docs](https://docs.microsoft.com/rest/api/sql/firewallrules/createorupdate)).
     */
    public val endIpAddress: Output
        get() = javaResource.endIpAddress().applyValue({ args0 -> args0 })

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

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

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

    /**
     * Specifies the Start IP Address associated with this Firewall Rule.
     */
    public val startIpAddress: Output
        get() = javaResource.startIpAddress().applyValue({ args0 -> args0 })
}

public object FirewallRuleMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.mariadb.FirewallRule::class == javaResource::class

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

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

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




© 2015 - 2025 Weber Informatics LLC | Privacy Policy