com.pulumi.azure.mssql.kotlin.FailoverGroupArgs.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.mssql.kotlin
import com.pulumi.azure.mssql.FailoverGroupArgs.builder
import com.pulumi.azure.mssql.kotlin.inputs.FailoverGroupPartnerServerArgs
import com.pulumi.azure.mssql.kotlin.inputs.FailoverGroupPartnerServerArgsBuilder
import com.pulumi.azure.mssql.kotlin.inputs.FailoverGroupReadWriteEndpointFailoverPolicyArgs
import com.pulumi.azure.mssql.kotlin.inputs.FailoverGroupReadWriteEndpointFailoverPolicyArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a Microsoft Azure SQL Failover Group.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const example = new azure.core.ResourceGroup("example", {
* name: "database-rg",
* location: "West Europe",
* });
* const primary = new azure.mssql.Server("primary", {
* name: "mssqlserver-primary",
* resourceGroupName: example.name,
* location: example.location,
* version: "12.0",
* administratorLogin: "missadministrator",
* administratorLoginPassword: "thisIsKat11",
* });
* const secondary = new azure.mssql.Server("secondary", {
* name: "mssqlserver-secondary",
* resourceGroupName: example.name,
* location: "North Europe",
* version: "12.0",
* administratorLogin: "missadministrator",
* administratorLoginPassword: "thisIsKat12",
* });
* const exampleDatabase = new azure.mssql.Database("example", {
* name: "exampledb",
* serverId: primary.id,
* skuName: "S1",
* collation: "SQL_Latin1_General_CP1_CI_AS",
* maxSizeGb: 200,
* });
* const exampleFailoverGroup = new azure.mssql.FailoverGroup("example", {
* name: "example",
* serverId: primary.id,
* databases: [exampleDatabase.id],
* partnerServers: [{
* id: secondary.id,
* }],
* readWriteEndpointFailoverPolicy: {
* mode: "Automatic",
* graceMinutes: 80,
* },
* tags: {
* environment: "prod",
* database: "example",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="database-rg",
* location="West Europe")
* primary = azure.mssql.Server("primary",
* name="mssqlserver-primary",
* resource_group_name=example.name,
* location=example.location,
* version="12.0",
* administrator_login="missadministrator",
* administrator_login_password="thisIsKat11")
* secondary = azure.mssql.Server("secondary",
* name="mssqlserver-secondary",
* resource_group_name=example.name,
* location="North Europe",
* version="12.0",
* administrator_login="missadministrator",
* administrator_login_password="thisIsKat12")
* example_database = azure.mssql.Database("example",
* name="exampledb",
* server_id=primary.id,
* sku_name="S1",
* collation="SQL_Latin1_General_CP1_CI_AS",
* max_size_gb=200)
* example_failover_group = azure.mssql.FailoverGroup("example",
* name="example",
* server_id=primary.id,
* databases=[example_database.id],
* partner_servers=[{
* "id": secondary.id,
* }],
* read_write_endpoint_failover_policy={
* "mode": "Automatic",
* "grace_minutes": 80,
* },
* tags={
* "environment": "prod",
* "database": "example",
* })
* ```
* ```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 = "database-rg",
* Location = "West Europe",
* });
* var primary = new Azure.MSSql.Server("primary", new()
* {
* Name = "mssqlserver-primary",
* ResourceGroupName = example.Name,
* Location = example.Location,
* Version = "12.0",
* AdministratorLogin = "missadministrator",
* AdministratorLoginPassword = "thisIsKat11",
* });
* var secondary = new Azure.MSSql.Server("secondary", new()
* {
* Name = "mssqlserver-secondary",
* ResourceGroupName = example.Name,
* Location = "North Europe",
* Version = "12.0",
* AdministratorLogin = "missadministrator",
* AdministratorLoginPassword = "thisIsKat12",
* });
* var exampleDatabase = new Azure.MSSql.Database("example", new()
* {
* Name = "exampledb",
* ServerId = primary.Id,
* SkuName = "S1",
* Collation = "SQL_Latin1_General_CP1_CI_AS",
* MaxSizeGb = 200,
* });
* var exampleFailoverGroup = new Azure.MSSql.FailoverGroup("example", new()
* {
* Name = "example",
* ServerId = primary.Id,
* Databases = new[]
* {
* exampleDatabase.Id,
* },
* PartnerServers = new[]
* {
* new Azure.MSSql.Inputs.FailoverGroupPartnerServerArgs
* {
* Id = secondary.Id,
* },
* },
* ReadWriteEndpointFailoverPolicy = new Azure.MSSql.Inputs.FailoverGroupReadWriteEndpointFailoverPolicyArgs
* {
* Mode = "Automatic",
* GraceMinutes = 80,
* },
* Tags =
* {
* { "environment", "prod" },
* { "database", "example" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mssql"
* "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("database-rg"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* primary, err := mssql.NewServer(ctx, "primary", &mssql.ServerArgs{
* Name: pulumi.String("mssqlserver-primary"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* Version: pulumi.String("12.0"),
* AdministratorLogin: pulumi.String("missadministrator"),
* AdministratorLoginPassword: pulumi.String("thisIsKat11"),
* })
* if err != nil {
* return err
* }
* secondary, err := mssql.NewServer(ctx, "secondary", &mssql.ServerArgs{
* Name: pulumi.String("mssqlserver-secondary"),
* ResourceGroupName: example.Name,
* Location: pulumi.String("North Europe"),
* Version: pulumi.String("12.0"),
* AdministratorLogin: pulumi.String("missadministrator"),
* AdministratorLoginPassword: pulumi.String("thisIsKat12"),
* })
* if err != nil {
* return err
* }
* exampleDatabase, err := mssql.NewDatabase(ctx, "example", &mssql.DatabaseArgs{
* Name: pulumi.String("exampledb"),
* ServerId: primary.ID(),
* SkuName: pulumi.String("S1"),
* Collation: pulumi.String("SQL_Latin1_General_CP1_CI_AS"),
* MaxSizeGb: pulumi.Int(200),
* })
* if err != nil {
* return err
* }
* _, err = mssql.NewFailoverGroup(ctx, "example", &mssql.FailoverGroupArgs{
* Name: pulumi.String("example"),
* ServerId: primary.ID(),
* Databases: pulumi.StringArray{
* exampleDatabase.ID(),
* },
* PartnerServers: mssql.FailoverGroupPartnerServerArray{
* &mssql.FailoverGroupPartnerServerArgs{
* Id: secondary.ID(),
* },
* },
* ReadWriteEndpointFailoverPolicy: &mssql.FailoverGroupReadWriteEndpointFailoverPolicyArgs{
* Mode: pulumi.String("Automatic"),
* GraceMinutes: pulumi.Int(80),
* },
* Tags: pulumi.StringMap{
* "environment": pulumi.String("prod"),
* "database": pulumi.String("example"),
* },
* })
* 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.mssql.Server;
* import com.pulumi.azure.mssql.ServerArgs;
* import com.pulumi.azure.mssql.Database;
* import com.pulumi.azure.mssql.DatabaseArgs;
* import com.pulumi.azure.mssql.FailoverGroup;
* import com.pulumi.azure.mssql.FailoverGroupArgs;
* import com.pulumi.azure.mssql.inputs.FailoverGroupPartnerServerArgs;
* import com.pulumi.azure.mssql.inputs.FailoverGroupReadWriteEndpointFailoverPolicyArgs;
* 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("database-rg")
* .location("West Europe")
* .build());
* var primary = new Server("primary", ServerArgs.builder()
* .name("mssqlserver-primary")
* .resourceGroupName(example.name())
* .location(example.location())
* .version("12.0")
* .administratorLogin("missadministrator")
* .administratorLoginPassword("thisIsKat11")
* .build());
* var secondary = new Server("secondary", ServerArgs.builder()
* .name("mssqlserver-secondary")
* .resourceGroupName(example.name())
* .location("North Europe")
* .version("12.0")
* .administratorLogin("missadministrator")
* .administratorLoginPassword("thisIsKat12")
* .build());
* var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
* .name("exampledb")
* .serverId(primary.id())
* .skuName("S1")
* .collation("SQL_Latin1_General_CP1_CI_AS")
* .maxSizeGb("200")
* .build());
* var exampleFailoverGroup = new FailoverGroup("exampleFailoverGroup", FailoverGroupArgs.builder()
* .name("example")
* .serverId(primary.id())
* .databases(exampleDatabase.id())
* .partnerServers(FailoverGroupPartnerServerArgs.builder()
* .id(secondary.id())
* .build())
* .readWriteEndpointFailoverPolicy(FailoverGroupReadWriteEndpointFailoverPolicyArgs.builder()
* .mode("Automatic")
* .graceMinutes(80)
* .build())
* .tags(Map.ofEntries(
* Map.entry("environment", "prod"),
* Map.entry("database", "example")
* ))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: database-rg
* location: West Europe
* primary:
* type: azure:mssql:Server
* properties:
* name: mssqlserver-primary
* resourceGroupName: ${example.name}
* location: ${example.location}
* version: '12.0'
* administratorLogin: missadministrator
* administratorLoginPassword: thisIsKat11
* secondary:
* type: azure:mssql:Server
* properties:
* name: mssqlserver-secondary
* resourceGroupName: ${example.name}
* location: North Europe
* version: '12.0'
* administratorLogin: missadministrator
* administratorLoginPassword: thisIsKat12
* exampleDatabase:
* type: azure:mssql:Database
* name: example
* properties:
* name: exampledb
* serverId: ${primary.id}
* skuName: S1
* collation: SQL_Latin1_General_CP1_CI_AS
* maxSizeGb: '200'
* exampleFailoverGroup:
* type: azure:mssql:FailoverGroup
* name: example
* properties:
* name: example
* serverId: ${primary.id}
* databases:
* - ${exampleDatabase.id}
* partnerServers:
* - id: ${secondary.id}
* readWriteEndpointFailoverPolicy:
* mode: Automatic
* graceMinutes: 80
* tags:
* environment: prod
* database: example
* ```
*
* ## Import
* Failover Groups can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:mssql/failoverGroup:FailoverGroup example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Sql/servers/server1/failoverGroups/failoverGroup1
* ```
* @property databases A set of database names to include in the failover group.
* @property name The name of the Failover Group. Changing this forces a new resource to be created.
* @property partnerServers A `partner_server` block as defined below.
* @property readWriteEndpointFailoverPolicy A `read_write_endpoint_failover_policy` block as defined below.
* @property readonlyEndpointFailoverPolicyEnabled Whether failover is enabled for the readonly endpoint. Defaults to `false`.
* @property serverId The ID of the primary SQL Server on which to create the failover group. Changing this forces a new resource to be created.
* @property tags A mapping of tags to assign to the resource.
*/
public data class FailoverGroupArgs(
public val databases: Output>? = null,
public val name: Output? = null,
public val partnerServers: Output>? = null,
public val readWriteEndpointFailoverPolicy: Output? = null,
public val readonlyEndpointFailoverPolicyEnabled: Output? = null,
public val serverId: Output? = null,
public val tags: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.mssql.FailoverGroupArgs =
com.pulumi.azure.mssql.FailoverGroupArgs.builder()
.databases(databases?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.name(name?.applyValue({ args0 -> args0 }))
.partnerServers(
partnerServers?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.readWriteEndpointFailoverPolicy(
readWriteEndpointFailoverPolicy?.applyValue({ args0 ->
args0.let({ args0 -> args0.toJava() })
}),
)
.readonlyEndpointFailoverPolicyEnabled(
readonlyEndpointFailoverPolicyEnabled?.applyValue({ args0 ->
args0
}),
)
.serverId(serverId?.applyValue({ args0 -> args0 }))
.tags(
tags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
).build()
}
/**
* Builder for [FailoverGroupArgs].
*/
@PulumiTagMarker
public class FailoverGroupArgsBuilder internal constructor() {
private var databases: Output>? = null
private var name: Output? = null
private var partnerServers: Output>? = null
private var readWriteEndpointFailoverPolicy:
Output? = null
private var readonlyEndpointFailoverPolicyEnabled: Output? = null
private var serverId: Output? = null
private var tags: Output>? = null
/**
* @param value A set of database names to include in the failover group.
*/
@JvmName("dcgdgkunlmjatcdv")
public suspend fun databases(`value`: Output>) {
this.databases = value
}
@JvmName("qwjejgbfggblskgv")
public suspend fun databases(vararg values: Output) {
this.databases = Output.all(values.asList())
}
/**
* @param values A set of database names to include in the failover group.
*/
@JvmName("sxhuvvvacrfirodw")
public suspend fun databases(values: List>) {
this.databases = Output.all(values)
}
/**
* @param value The name of the Failover Group. Changing this forces a new resource to be created.
*/
@JvmName("ekexjtavfrxshhks")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A `partner_server` block as defined below.
*/
@JvmName("xhyiaynviaioonnq")
public suspend fun partnerServers(`value`: Output>) {
this.partnerServers = value
}
@JvmName("atddtivyqxutdqnx")
public suspend fun partnerServers(vararg values: Output) {
this.partnerServers = Output.all(values.asList())
}
/**
* @param values A `partner_server` block as defined below.
*/
@JvmName("xrggpwhhkwsacvfi")
public suspend fun partnerServers(values: List>) {
this.partnerServers = Output.all(values)
}
/**
* @param value A `read_write_endpoint_failover_policy` block as defined below.
*/
@JvmName("orpgfjmwistaacqp")
public suspend fun readWriteEndpointFailoverPolicy(`value`: Output) {
this.readWriteEndpointFailoverPolicy = value
}
/**
* @param value Whether failover is enabled for the readonly endpoint. Defaults to `false`.
*/
@JvmName("kjxdekculfmhjvdm")
public suspend fun readonlyEndpointFailoverPolicyEnabled(`value`: Output) {
this.readonlyEndpointFailoverPolicyEnabled = value
}
/**
* @param value The ID of the primary SQL Server on which to create the failover group. Changing this forces a new resource to be created.
*/
@JvmName("serkexkwriwvqvgd")
public suspend fun serverId(`value`: Output) {
this.serverId = value
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("ouquqjtajwuwwvxx")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value A set of database names to include in the failover group.
*/
@JvmName("poydgeqdbmmypfjt")
public suspend fun databases(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.databases = mapped
}
/**
* @param values A set of database names to include in the failover group.
*/
@JvmName("qsvyumsrmddmshxo")
public suspend fun databases(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.databases = mapped
}
/**
* @param value The name of the Failover Group. Changing this forces a new resource to be created.
*/
@JvmName("vbdycctdcosrpwpr")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A `partner_server` block as defined below.
*/
@JvmName("vkmalsnbpxndexhx")
public suspend fun partnerServers(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.partnerServers = mapped
}
/**
* @param argument A `partner_server` block as defined below.
*/
@JvmName("idohetksdonpovuw")
public suspend fun partnerServers(argument: List Unit>) {
val toBeMapped = argument.toList().map {
FailoverGroupPartnerServerArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.partnerServers = mapped
}
/**
* @param argument A `partner_server` block as defined below.
*/
@JvmName("jlykkyykwetxbjtj")
public suspend fun partnerServers(vararg argument: suspend FailoverGroupPartnerServerArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
FailoverGroupPartnerServerArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.partnerServers = mapped
}
/**
* @param argument A `partner_server` block as defined below.
*/
@JvmName("wwcnaoqojmworylt")
public suspend fun partnerServers(argument: suspend FailoverGroupPartnerServerArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
FailoverGroupPartnerServerArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.partnerServers = mapped
}
/**
* @param values A `partner_server` block as defined below.
*/
@JvmName("nuernqlcrnwwmqhe")
public suspend fun partnerServers(vararg values: FailoverGroupPartnerServerArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.partnerServers = mapped
}
/**
* @param value A `read_write_endpoint_failover_policy` block as defined below.
*/
@JvmName("ucraicsowotxulkv")
public suspend fun readWriteEndpointFailoverPolicy(`value`: FailoverGroupReadWriteEndpointFailoverPolicyArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.readWriteEndpointFailoverPolicy = mapped
}
/**
* @param argument A `read_write_endpoint_failover_policy` block as defined below.
*/
@JvmName("tqcueahuyxitynlv")
public suspend fun readWriteEndpointFailoverPolicy(argument: suspend FailoverGroupReadWriteEndpointFailoverPolicyArgsBuilder.() -> Unit) {
val toBeMapped = FailoverGroupReadWriteEndpointFailoverPolicyArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.readWriteEndpointFailoverPolicy = mapped
}
/**
* @param value Whether failover is enabled for the readonly endpoint. Defaults to `false`.
*/
@JvmName("yqjyclmbupgtixms")
public suspend fun readonlyEndpointFailoverPolicyEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.readonlyEndpointFailoverPolicyEnabled = mapped
}
/**
* @param value The ID of the primary SQL Server on which to create the failover group. Changing this forces a new resource to be created.
*/
@JvmName("fmjmpshnrnlsomte")
public suspend fun serverId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serverId = mapped
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("kuxrdydwsigpjtxj")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values A mapping of tags to assign to the resource.
*/
@JvmName("ynukomopsjrquhdr")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): FailoverGroupArgs = FailoverGroupArgs(
databases = databases,
name = name,
partnerServers = partnerServers,
readWriteEndpointFailoverPolicy = readWriteEndpointFailoverPolicy,
readonlyEndpointFailoverPolicyEnabled = readonlyEndpointFailoverPolicyEnabled,
serverId = serverId,
tags = tags,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy