com.pulumi.aws.connect.kotlin.ContactFlowModuleArgs.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.connect.kotlin
import com.pulumi.aws.connect.ContactFlowModuleArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Provides an Amazon Connect Contact Flow Module resource. For more information see
* [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html)
* This resource embeds or references Contact Flows Modules specified in Amazon Connect Contact Flow Language. For more information see
* [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html)
* !> **WARN:** Contact Flow Modules exported from the Console [See Contact Flow import/export which is the same for Contact Flow Modules](https://docs.aws.amazon.com/connect/latest/adminguide/contact-flow-import-export.html) are not in the Amazon Connect Contact Flow Language and can not be used with this resource. Instead, the recommendation is to use the AWS CLI [`describe-contact-flow-module`](https://docs.aws.amazon.com/cli/latest/reference/connect/describe-contact-flow-module.html).
* See example below which uses `jq` to extract the `Content` attribute and saves it to a local file.
* ## Example Usage
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.connect.ContactFlowModule("example", {
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* description: "Example Contact Flow Module Description",
* content: JSON.stringify({
* Version: "2019-10-30",
* StartAction: "12345678-1234-1234-1234-123456789012",
* Actions: [
* {
* Identifier: "12345678-1234-1234-1234-123456789012",
* Parameters: {
* Text: "Hello contact flow module",
* },
* Transitions: {
* NextAction: "abcdef-abcd-abcd-abcd-abcdefghijkl",
* Errors: [],
* Conditions: [],
* },
* Type: "MessageParticipant",
* },
* {
* Identifier: "abcdef-abcd-abcd-abcd-abcdefghijkl",
* Type: "DisconnectParticipant",
* Parameters: {},
* Transitions: {},
* },
* ],
* Settings: {
* InputParameters: [],
* OutputParameters: [],
* Transitions: [
* {
* DisplayName: "Success",
* ReferenceName: "Success",
* Description: "",
* },
* {
* DisplayName: "Error",
* ReferenceName: "Error",
* Description: "",
* },
* ],
* },
* }),
* tags: {
* Name: "Example Contact Flow Module",
* Application: "Example",
* Method: "Create",
* },
* });
* ```
* ```python
* import pulumi
* import json
* import pulumi_aws as aws
* example = aws.connect.ContactFlowModule("example",
* instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name="Example",
* description="Example Contact Flow Module Description",
* content=json.dumps({
* "Version": "2019-10-30",
* "StartAction": "12345678-1234-1234-1234-123456789012",
* "Actions": [
* {
* "Identifier": "12345678-1234-1234-1234-123456789012",
* "Parameters": {
* "Text": "Hello contact flow module",
* },
* "Transitions": {
* "NextAction": "abcdef-abcd-abcd-abcd-abcdefghijkl",
* "Errors": [],
* "Conditions": [],
* },
* "Type": "MessageParticipant",
* },
* {
* "Identifier": "abcdef-abcd-abcd-abcd-abcdefghijkl",
* "Type": "DisconnectParticipant",
* "Parameters": {},
* "Transitions": {},
* },
* ],
* "Settings": {
* "InputParameters": [],
* "OutputParameters": [],
* "Transitions": [
* {
* "DisplayName": "Success",
* "ReferenceName": "Success",
* "Description": "",
* },
* {
* "DisplayName": "Error",
* "ReferenceName": "Error",
* "Description": "",
* },
* ],
* },
* }),
* tags={
* "Name": "Example Contact Flow Module",
* "Application": "Example",
* "Method": "Create",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using System.Text.Json;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Connect.ContactFlowModule("example", new()
* {
* InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* Name = "Example",
* Description = "Example Contact Flow Module Description",
* Content = JsonSerializer.Serialize(new Dictionary
* {
* ["Version"] = "2019-10-30",
* ["StartAction"] = "12345678-1234-1234-1234-123456789012",
* ["Actions"] = new[]
* {
* new Dictionary
* {
* ["Identifier"] = "12345678-1234-1234-1234-123456789012",
* ["Parameters"] = new Dictionary
* {
* ["Text"] = "Hello contact flow module",
* },
* ["Transitions"] = new Dictionary
* {
* ["NextAction"] = "abcdef-abcd-abcd-abcd-abcdefghijkl",
* ["Errors"] = new[]
* {
* },
* ["Conditions"] = new[]
* {
* },
* },
* ["Type"] = "MessageParticipant",
* },
* new Dictionary
* {
* ["Identifier"] = "abcdef-abcd-abcd-abcd-abcdefghijkl",
* ["Type"] = "DisconnectParticipant",
* ["Parameters"] = new Dictionary
* {
* },
* ["Transitions"] = new Dictionary
* {
* },
* },
* },
* ["Settings"] = new Dictionary
* {
* ["InputParameters"] = new[]
* {
* },
* ["OutputParameters"] = new[]
* {
* },
* ["Transitions"] = new[]
* {
* new Dictionary
* {
* ["DisplayName"] = "Success",
* ["ReferenceName"] = "Success",
* ["Description"] = "",
* },
* new Dictionary
* {
* ["DisplayName"] = "Error",
* ["ReferenceName"] = "Error",
* ["Description"] = "",
* },
* },
* },
* }),
* Tags =
* {
* { "Name", "Example Contact Flow Module" },
* { "Application", "Example" },
* { "Method", "Create" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "encoding/json"
* "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 {
* tmpJSON0, err := json.Marshal(map[string]interface{}{
* "Version": "2019-10-30",
* "StartAction": "12345678-1234-1234-1234-123456789012",
* "Actions": []interface{}{
* map[string]interface{}{
* "Identifier": "12345678-1234-1234-1234-123456789012",
* "Parameters": map[string]interface{}{
* "Text": "Hello contact flow module",
* },
* "Transitions": map[string]interface{}{
* "NextAction": "abcdef-abcd-abcd-abcd-abcdefghijkl",
* "Errors": []interface{}{},
* "Conditions": []interface{}{},
* },
* "Type": "MessageParticipant",
* },
* map[string]interface{}{
* "Identifier": "abcdef-abcd-abcd-abcd-abcdefghijkl",
* "Type": "DisconnectParticipant",
* "Parameters": map[string]interface{}{},
* "Transitions": map[string]interface{}{},
* },
* },
* "Settings": map[string]interface{}{
* "InputParameters": []interface{}{},
* "OutputParameters": []interface{}{},
* "Transitions": []map[string]interface{}{
* map[string]interface{}{
* "DisplayName": "Success",
* "ReferenceName": "Success",
* "Description": "",
* },
* map[string]interface{}{
* "DisplayName": "Error",
* "ReferenceName": "Error",
* "Description": "",
* },
* },
* },
* })
* if err != nil {
* return err
* }
* json0 := string(tmpJSON0)
* _, err = connect.NewContactFlowModule(ctx, "example", &connect.ContactFlowModuleArgs{
* InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
* Name: pulumi.String("Example"),
* Description: pulumi.String("Example Contact Flow Module Description"),
* Content: pulumi.String(json0),
* Tags: pulumi.StringMap{
* "Name": pulumi.String("Example Contact Flow Module"),
* "Application": pulumi.String("Example"),
* "Method": pulumi.String("Create"),
* },
* })
* 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.ContactFlowModule;
* import com.pulumi.aws.connect.ContactFlowModuleArgs;
* import static com.pulumi.codegen.internal.Serialization.*;
* 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 ContactFlowModule("example", ContactFlowModuleArgs.builder()
* .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
* .name("Example")
* .description("Example Contact Flow Module Description")
* .content(serializeJson(
* jsonObject(
* jsonProperty("Version", "2019-10-30"),
* jsonProperty("StartAction", "12345678-1234-1234-1234-123456789012"),
* jsonProperty("Actions", jsonArray(
* jsonObject(
* jsonProperty("Identifier", "12345678-1234-1234-1234-123456789012"),
* jsonProperty("Parameters", jsonObject(
* jsonProperty("Text", "Hello contact flow module")
* )),
* jsonProperty("Transitions", jsonObject(
* jsonProperty("NextAction", "abcdef-abcd-abcd-abcd-abcdefghijkl"),
* jsonProperty("Errors", jsonArray(
* )),
* jsonProperty("Conditions", jsonArray(
* ))
* )),
* jsonProperty("Type", "MessageParticipant")
* ),
* jsonObject(
* jsonProperty("Identifier", "abcdef-abcd-abcd-abcd-abcdefghijkl"),
* jsonProperty("Type", "DisconnectParticipant"),
* jsonProperty("Parameters", jsonObject(
* )),
* jsonProperty("Transitions", jsonObject(
* ))
* )
* )),
* jsonProperty("Settings", jsonObject(
* jsonProperty("InputParameters", jsonArray(
* )),
* jsonProperty("OutputParameters", jsonArray(
* )),
* jsonProperty("Transitions", jsonArray(
* jsonObject(
* jsonProperty("DisplayName", "Success"),
* jsonProperty("ReferenceName", "Success"),
* jsonProperty("Description", "")
* ),
* jsonObject(
* jsonProperty("DisplayName", "Error"),
* jsonProperty("ReferenceName", "Error"),
* jsonProperty("Description", "")
* )
* ))
* ))
* )))
* .tags(Map.ofEntries(
* Map.entry("Name", "Example Contact Flow Module"),
* Map.entry("Application", "Example"),
* Map.entry("Method", "Create")
* ))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:connect:ContactFlowModule
* properties:
* instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
* name: Example
* description: Example Contact Flow Module Description
* content:
* fn::toJSON:
* Version: 2019-10-30
* StartAction: 12345678-1234-1234-1234-123456789012
* Actions:
* - Identifier: 12345678-1234-1234-1234-123456789012
* Parameters:
* Text: Hello contact flow module
* Transitions:
* NextAction: abcdef-abcd-abcd-abcd-abcdefghijkl
* Errors: []
* Conditions: []
* Type: MessageParticipant
* - Identifier: abcdef-abcd-abcd-abcd-abcdefghijkl
* Type: DisconnectParticipant
* Parameters: {}
* Transitions: {}
* Settings:
* InputParameters: []
* OutputParameters: []
* Transitions:
* - DisplayName: Success
* ReferenceName: Success
* Description:
* - DisplayName: Error
* ReferenceName: Error
* Description:
* tags:
* Name: Example Contact Flow Module
* Application: Example
* Method: Create
* ```
*
* ### With External Content
* Use the AWS CLI to extract Contact Flow Content:
* ```console
* % aws connect describe-contact-flow-module --instance-id 1b3c5d8-1b3c-1b3c-1b3c-1b3c5d81b3c5 --contact-flow-module-id c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 --region us-west-2 | jq '.ContactFlowModule.Content | fromjson' > contact_flow_module.json
* ```
* Use the generated file as input:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as std from "@pulumi/std";
* const example = new aws.connect.ContactFlowModule("example", {
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* description: "Example Contact Flow Module Description",
* filename: "contact_flow_module.json",
* contentHash: std.filebase64sha256({
* input: "contact_flow_module.json",
* }).then(invoke => invoke.result),
* tags: {
* Name: "Example Contact Flow Module",
* Application: "Example",
* Method: "Create",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* import pulumi_std as std
* example = aws.connect.ContactFlowModule("example",
* instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name="Example",
* description="Example Contact Flow Module Description",
* filename="contact_flow_module.json",
* content_hash=std.filebase64sha256(input="contact_flow_module.json").result,
* tags={
* "Name": "Example Contact Flow Module",
* "Application": "Example",
* "Method": "Create",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* using Std = Pulumi.Std;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Connect.ContactFlowModule("example", new()
* {
* InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* Name = "Example",
* Description = "Example Contact Flow Module Description",
* Filename = "contact_flow_module.json",
* ContentHash = Std.Filebase64sha256.Invoke(new()
* {
* Input = "contact_flow_module.json",
* }).Apply(invoke => invoke.Result),
* Tags =
* {
* { "Name", "Example Contact Flow Module" },
* { "Application", "Example" },
* { "Method", "Create" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
* "github.com/pulumi/pulumi-std/sdk/go/std"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* invokeFilebase64sha256, err := std.Filebase64sha256(ctx, &std.Filebase64sha256Args{
* Input: "contact_flow_module.json",
* }, nil)
* if err != nil {
* return err
* }
* _, err = connect.NewContactFlowModule(ctx, "example", &connect.ContactFlowModuleArgs{
* InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
* Name: pulumi.String("Example"),
* Description: pulumi.String("Example Contact Flow Module Description"),
* Filename: pulumi.String("contact_flow_module.json"),
* ContentHash: pulumi.String(invokeFilebase64sha256.Result),
* Tags: pulumi.StringMap{
* "Name": pulumi.String("Example Contact Flow Module"),
* "Application": pulumi.String("Example"),
* "Method": pulumi.String("Create"),
* },
* })
* 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.ContactFlowModule;
* import com.pulumi.aws.connect.ContactFlowModuleArgs;
* 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 ContactFlowModule("example", ContactFlowModuleArgs.builder()
* .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
* .name("Example")
* .description("Example Contact Flow Module Description")
* .filename("contact_flow_module.json")
* .contentHash(StdFunctions.filebase64sha256(Filebase64sha256Args.builder()
* .input("contact_flow_module.json")
* .build()).result())
* .tags(Map.ofEntries(
* Map.entry("Name", "Example Contact Flow Module"),
* Map.entry("Application", "Example"),
* Map.entry("Method", "Create")
* ))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:connect:ContactFlowModule
* properties:
* instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
* name: Example
* description: Example Contact Flow Module Description
* filename: contact_flow_module.json
* contentHash:
* fn::invoke:
* Function: std:filebase64sha256
* Arguments:
* input: contact_flow_module.json
* Return: result
* tags:
* Name: Example Contact Flow Module
* Application: Example
* Method: Create
* ```
*
* ## Import
* Using `pulumi import`, import Amazon Connect Contact Flow Modules using the `instance_id` and `contact_flow_module_id` separated by a colon (`:`). For example:
* ```sh
* $ pulumi import aws:connect/contactFlowModule:ContactFlowModule example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
* ```
* @property content Specifies the content of the Contact Flow Module, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the `filename` argument cannot be used.
* @property contentHash Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow Module source specified with `filename`.
* @property description Specifies the description of the Contact Flow Module.
* @property filename The path to the Contact Flow Module source within the local filesystem. Conflicts with `content`.
* @property instanceId Specifies the identifier of the hosting Amazon Connect Instance.
* @property name Specifies the name of the Contact Flow Module.
* @property tags Tags to apply to the Contact Flow Module. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public data class ContactFlowModuleArgs(
public val content: Output? = null,
public val contentHash: Output? = null,
public val description: Output? = null,
public val filename: Output? = null,
public val instanceId: Output? = null,
public val name: Output? = null,
public val tags: Output
© 2015 - 2024 Weber Informatics LLC | Privacy Policy