com.pulumi.aws.connect.kotlin.Instance.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-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.
There is a newer version: 6.66.3.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.connect.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.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map

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

    public var args: InstanceArgs = InstanceArgs()

    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 InstanceArgsBuilder.() -> Unit) {
        val builder = InstanceArgsBuilder()
        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(): Instance {
        val builtJavaResource = com.pulumi.aws.connect.Instance(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Instance(builtJavaResource)
    }
}

/**
 * Provides an Amazon Connect instance resource. For more information see
 * [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html)
 * !> **WARN:** Amazon Connect enforces a limit of [100 combined instance creation and deletions every 30 days](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits). For example, if you create 80 instances and delete 20 of them, you must wait 30 days to create or delete another instance. Use care when creating or deleting instances.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const test = new aws.connect.Instance("test", {
 *     identityManagementType: "CONNECT_MANAGED",
 *     inboundCallsEnabled: true,
 *     instanceAlias: "friendly-name-connect",
 *     outboundCallsEnabled: true,
 *     tags: {
 *         hello: "world",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * test = aws.connect.Instance("test",
 *     identity_management_type="CONNECT_MANAGED",
 *     inbound_calls_enabled=True,
 *     instance_alias="friendly-name-connect",
 *     outbound_calls_enabled=True,
 *     tags={
 *         "hello": "world",
 *     })
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var test = new Aws.Connect.Instance("test", new()
 *     {
 *         IdentityManagementType = "CONNECT_MANAGED",
 *         InboundCallsEnabled = true,
 *         InstanceAlias = "friendly-name-connect",
 *         OutboundCallsEnabled = true,
 *         Tags =
 *         {
 *             { "hello", "world" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := connect.NewInstance(ctx, "test", &connect.InstanceArgs{
 * 			IdentityManagementType: pulumi.String("CONNECT_MANAGED"),
 * 			InboundCallsEnabled:    pulumi.Bool(true),
 * 			InstanceAlias:          pulumi.String("friendly-name-connect"),
 * 			OutboundCallsEnabled:   pulumi.Bool(true),
 * 			Tags: pulumi.StringMap{
 * 				"hello": pulumi.String("world"),
 * 			},
 * 		})
 * 		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.aws.connect.Instance;
 * import com.pulumi.aws.connect.InstanceArgs;
 * 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 test = new Instance("test", InstanceArgs.builder()
 *             .identityManagementType("CONNECT_MANAGED")
 *             .inboundCallsEnabled(true)
 *             .instanceAlias("friendly-name-connect")
 *             .outboundCallsEnabled(true)
 *             .tags(Map.of("hello", "world"))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   test:
 *     type: aws:connect:Instance
 *     properties:
 *       identityManagementType: CONNECT_MANAGED
 *       inboundCallsEnabled: true
 *       instanceAlias: friendly-name-connect
 *       outboundCallsEnabled: true
 *       tags:
 *         hello: world
 * ```
 * 
 * ### With Existing Active Directory
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const test = new aws.connect.Instance("test", {
 *     directoryId: testAwsDirectoryServiceDirectory.id,
 *     identityManagementType: "EXISTING_DIRECTORY",
 *     inboundCallsEnabled: true,
 *     instanceAlias: "friendly-name-connect",
 *     outboundCallsEnabled: true,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * test = aws.connect.Instance("test",
 *     directory_id=test_aws_directory_service_directory["id"],
 *     identity_management_type="EXISTING_DIRECTORY",
 *     inbound_calls_enabled=True,
 *     instance_alias="friendly-name-connect",
 *     outbound_calls_enabled=True)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var test = new Aws.Connect.Instance("test", new()
 *     {
 *         DirectoryId = testAwsDirectoryServiceDirectory.Id,
 *         IdentityManagementType = "EXISTING_DIRECTORY",
 *         InboundCallsEnabled = true,
 *         InstanceAlias = "friendly-name-connect",
 *         OutboundCallsEnabled = true,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := connect.NewInstance(ctx, "test", &connect.InstanceArgs{
 * 			DirectoryId:            pulumi.Any(testAwsDirectoryServiceDirectory.Id),
 * 			IdentityManagementType: pulumi.String("EXISTING_DIRECTORY"),
 * 			InboundCallsEnabled:    pulumi.Bool(true),
 * 			InstanceAlias:          pulumi.String("friendly-name-connect"),
 * 			OutboundCallsEnabled:   pulumi.Bool(true),
 * 		})
 * 		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.aws.connect.Instance;
 * import com.pulumi.aws.connect.InstanceArgs;
 * 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 test = new Instance("test", InstanceArgs.builder()
 *             .directoryId(testAwsDirectoryServiceDirectory.id())
 *             .identityManagementType("EXISTING_DIRECTORY")
 *             .inboundCallsEnabled(true)
 *             .instanceAlias("friendly-name-connect")
 *             .outboundCallsEnabled(true)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   test:
 *     type: aws:connect:Instance
 *     properties:
 *       directoryId: ${testAwsDirectoryServiceDirectory.id}
 *       identityManagementType: EXISTING_DIRECTORY
 *       inboundCallsEnabled: true
 *       instanceAlias: friendly-name-connect
 *       outboundCallsEnabled: true
 * ```
 * 
 * ### With SAML
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const test = new aws.connect.Instance("test", {
 *     identityManagementType: "SAML",
 *     inboundCallsEnabled: true,
 *     instanceAlias: "friendly-name-connect",
 *     outboundCallsEnabled: true,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * test = aws.connect.Instance("test",
 *     identity_management_type="SAML",
 *     inbound_calls_enabled=True,
 *     instance_alias="friendly-name-connect",
 *     outbound_calls_enabled=True)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var test = new Aws.Connect.Instance("test", new()
 *     {
 *         IdentityManagementType = "SAML",
 *         InboundCallsEnabled = true,
 *         InstanceAlias = "friendly-name-connect",
 *         OutboundCallsEnabled = true,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := connect.NewInstance(ctx, "test", &connect.InstanceArgs{
 * 			IdentityManagementType: pulumi.String("SAML"),
 * 			InboundCallsEnabled:    pulumi.Bool(true),
 * 			InstanceAlias:          pulumi.String("friendly-name-connect"),
 * 			OutboundCallsEnabled:   pulumi.Bool(true),
 * 		})
 * 		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.aws.connect.Instance;
 * import com.pulumi.aws.connect.InstanceArgs;
 * 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 test = new Instance("test", InstanceArgs.builder()
 *             .identityManagementType("SAML")
 *             .inboundCallsEnabled(true)
 *             .instanceAlias("friendly-name-connect")
 *             .outboundCallsEnabled(true)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   test:
 *     type: aws:connect:Instance
 *     properties:
 *       identityManagementType: SAML
 *       inboundCallsEnabled: true
 *       instanceAlias: friendly-name-connect
 *       outboundCallsEnabled: true
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import Connect instances using the `id`. For example:
 * ```sh
 * $ pulumi import aws:connect/instance:Instance example f1288a1f-6193-445a-b47e-af739b2
 * ```
 */
public class Instance internal constructor(
    override val javaResource: com.pulumi.aws.connect.Instance,
) : KotlinCustomResource(javaResource, InstanceMapper) {
    /**
     * Amazon Resource Name (ARN) of the instance.
     */
    public val arn: Output
        get() = javaResource.arn().applyValue({ args0 -> args0 })

    /**
     * Specifies whether auto resolve best voices is enabled. Defaults to `true`.
     */
    public val autoResolveBestVoicesEnabled: Output?
        get() = javaResource.autoResolveBestVoicesEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies whether contact flow logs are enabled. Defaults to `false`.
     */
    public val contactFlowLogsEnabled: Output?
        get() = javaResource.contactFlowLogsEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies whether contact lens is enabled. Defaults to `true`.
     */
    public val contactLensEnabled: Output?
        get() = javaResource.contactLensEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * When the instance was created.
     */
    public val createdTime: Output
        get() = javaResource.createdTime().applyValue({ args0 -> args0 })

    /**
     * The identifier for the directory if identity_management_type is `EXISTING_DIRECTORY`.
     */
    public val directoryId: Output?
        get() = javaResource.directoryId().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
     */
    public val earlyMediaEnabled: Output?
        get() = javaResource.earlyMediaEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
     */
    public val identityManagementType: Output
        get() = javaResource.identityManagementType().applyValue({ args0 -> args0 })

    /**
     * Specifies whether inbound calls are enabled.
     */
    public val inboundCallsEnabled: Output
        get() = javaResource.inboundCallsEnabled().applyValue({ args0 -> args0 })

    /**
     * Specifies the name of the instance. Required if `directory_id` not specified.
     */
    public val instanceAlias: Output?
        get() = javaResource.instanceAlias().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies whether multi-party calls/conference is enabled. Defaults to `false`.
     */
    public val multiPartyConferenceEnabled: Output?
        get() = javaResource.multiPartyConferenceEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Specifies whether outbound calls are enabled.
     */
    public val outboundCallsEnabled: Output
        get() = javaResource.outboundCallsEnabled().applyValue({ args0 -> args0 })

    /**
     * The service role of the instance.
     */
    public val serviceRole: Output
        get() = javaResource.serviceRole().applyValue({ args0 -> args0 })

    /**
     * The state of the instance.
     */
    public val status: Output
        get() = javaResource.status().applyValue({ args0 -> args0 })

    /**
     * Tags to apply to the Instance. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
     */
    @Deprecated(
        message = """
  Please use `tags` instead.
  """,
    )
    public val tagsAll: Output>
        get() = javaResource.tagsAll().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })
}

public object InstanceMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.aws.connect.Instance::class == javaResource::class

    override fun map(javaResource: Resource): Instance = Instance(
        javaResource as
            com.pulumi.aws.connect.Instance,
    )
}

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

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