1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. ContactFlow

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.connect.ContactFlow

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an Amazon Connect Contact Flow resource. For more information see Amazon Connect: Getting Started

    This resource embeds or references Contact Flows specified in Amazon Connect Contact Flow Language. For more information see Amazon Connect Flow language

    !> WARN: Contact Flows exported from the Console Contact Flow import/export 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. See example below which uses jq to extract the Content attribute and saves it to a local file.

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.connect.ContactFlow("test", {
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name: "Test",
        description: "Test Contact Flow Description",
        type: "CONTACT_FLOW",
        content: JSON.stringify({
            Version: "2019-10-30",
            StartAction: "12345678-1234-1234-1234-123456789012",
            Actions: [
                {
                    Identifier: "12345678-1234-1234-1234-123456789012",
                    Type: "MessageParticipant",
                    Transitions: {
                        NextAction: "abcdef-abcd-abcd-abcd-abcdefghijkl",
                        Errors: [],
                        Conditions: [],
                    },
                    Parameters: {
                        Text: "Thanks for calling the sample flow!",
                    },
                },
                {
                    Identifier: "abcdef-abcd-abcd-abcd-abcdefghijkl",
                    Type: "DisconnectParticipant",
                    Transitions: {},
                    Parameters: {},
                },
            ],
        }),
        tags: {
            Name: "Test Contact Flow",
            Application: "Example",
            Method: "Create",
        },
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    test = aws.connect.ContactFlow("test",
        instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name="Test",
        description="Test Contact Flow Description",
        type="CONTACT_FLOW",
        content=json.dumps({
            "Version": "2019-10-30",
            "StartAction": "12345678-1234-1234-1234-123456789012",
            "Actions": [
                {
                    "Identifier": "12345678-1234-1234-1234-123456789012",
                    "Type": "MessageParticipant",
                    "Transitions": {
                        "NextAction": "abcdef-abcd-abcd-abcd-abcdefghijkl",
                        "Errors": [],
                        "Conditions": [],
                    },
                    "Parameters": {
                        "Text": "Thanks for calling the sample flow!",
                    },
                },
                {
                    "Identifier": "abcdef-abcd-abcd-abcd-abcdefghijkl",
                    "Type": "DisconnectParticipant",
                    "Transitions": {},
                    "Parameters": {},
                },
            ],
        }),
        tags={
            "Name": "Test Contact Flow",
            "Application": "Example",
            "Method": "Create",
        })
    
    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",
    					"Type":       "MessageParticipant",
    					"Transitions": map[string]interface{}{
    						"NextAction": "abcdef-abcd-abcd-abcd-abcdefghijkl",
    						"Errors":     []interface{}{},
    						"Conditions": []interface{}{},
    					},
    					"Parameters": map[string]interface{}{
    						"Text": "Thanks for calling the sample flow!",
    					},
    				},
    				map[string]interface{}{
    					"Identifier":  "abcdef-abcd-abcd-abcd-abcdefghijkl",
    					"Type":        "DisconnectParticipant",
    					"Transitions": nil,
    					"Parameters":  nil,
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = connect.NewContactFlow(ctx, "test", &connect.ContactFlowArgs{
    			InstanceId:  pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
    			Name:        pulumi.String("Test"),
    			Description: pulumi.String("Test Contact Flow Description"),
    			Type:        pulumi.String("CONTACT_FLOW"),
    			Content:     pulumi.String(json0),
    			Tags: pulumi.StringMap{
    				"Name":        pulumi.String("Test Contact Flow"),
    				"Application": pulumi.String("Example"),
    				"Method":      pulumi.String("Create"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.Connect.ContactFlow("test", new()
        {
            InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
            Name = "Test",
            Description = "Test Contact Flow Description",
            Type = "CONTACT_FLOW",
            Content = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2019-10-30",
                ["StartAction"] = "12345678-1234-1234-1234-123456789012",
                ["Actions"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Identifier"] = "12345678-1234-1234-1234-123456789012",
                        ["Type"] = "MessageParticipant",
                        ["Transitions"] = new Dictionary<string, object?>
                        {
                            ["NextAction"] = "abcdef-abcd-abcd-abcd-abcdefghijkl",
                            ["Errors"] = new[]
                            {
                            },
                            ["Conditions"] = new[]
                            {
                            },
                        },
                        ["Parameters"] = new Dictionary<string, object?>
                        {
                            ["Text"] = "Thanks for calling the sample flow!",
                        },
                    },
                    new Dictionary<string, object?>
                    {
                        ["Identifier"] = "abcdef-abcd-abcd-abcd-abcdefghijkl",
                        ["Type"] = "DisconnectParticipant",
                        ["Transitions"] = new Dictionary<string, object?>
                        {
                        },
                        ["Parameters"] = new Dictionary<string, object?>
                        {
                        },
                    },
                },
            }),
            Tags = 
            {
                { "Name", "Test Contact Flow" },
                { "Application", "Example" },
                { "Method", "Create" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.connect.ContactFlow;
    import com.pulumi.aws.connect.ContactFlowArgs;
    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 test = new ContactFlow("test", ContactFlowArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .name("Test")
                .description("Test Contact Flow Description")
                .type("CONTACT_FLOW")
                .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("Type", "MessageParticipant"),
                                jsonProperty("Transitions", jsonObject(
                                    jsonProperty("NextAction", "abcdef-abcd-abcd-abcd-abcdefghijkl"),
                                    jsonProperty("Errors", jsonArray(
                                    )),
                                    jsonProperty("Conditions", jsonArray(
                                    ))
                                )),
                                jsonProperty("Parameters", jsonObject(
                                    jsonProperty("Text", "Thanks for calling the sample flow!")
                                ))
                            ), 
                            jsonObject(
                                jsonProperty("Identifier", "abcdef-abcd-abcd-abcd-abcdefghijkl"),
                                jsonProperty("Type", "DisconnectParticipant"),
                                jsonProperty("Transitions", jsonObject(
    
                                )),
                                jsonProperty("Parameters", jsonObject(
    
                                ))
                            )
                        ))
                    )))
                .tags(Map.ofEntries(
                    Map.entry("Name", "Test Contact Flow"),
                    Map.entry("Application", "Example"),
                    Map.entry("Method", "Create")
                ))
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:connect:ContactFlow
        properties:
          instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
          name: Test
          description: Test Contact Flow Description
          type: CONTACT_FLOW
          content:
            fn::toJSON:
              Version: 2019-10-30
              StartAction: 12345678-1234-1234-1234-123456789012
              Actions:
                - Identifier: 12345678-1234-1234-1234-123456789012
                  Type: MessageParticipant
                  Transitions:
                    NextAction: abcdef-abcd-abcd-abcd-abcdefghijkl
                    Errors: []
                    Conditions: []
                  Parameters:
                    Text: Thanks for calling the sample flow!
                - Identifier: abcdef-abcd-abcd-abcd-abcdefghijkl
                  Type: DisconnectParticipant
                  Transitions: {}
                  Parameters: {}
          tags:
            Name: Test Contact Flow
            Application: Example
            Method: Create
    

    With External Content

    Use the AWS CLI to extract Contact Flow Content:

    % aws connect describe-contact-flow --instance-id 1b3c5d8-1b3c-1b3c-1b3c-1b3c5d81b3c5 --contact-flow-id c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 --region us-west-2 | jq '.ContactFlow.Content | fromjson' > contact_flow.json
    

    Use the generated file as input:

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const test = new aws.connect.ContactFlow("test", {
        instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name: "Test",
        description: "Test Contact Flow Description",
        type: "CONTACT_FLOW",
        filename: "contact_flow.json",
        contentHash: std.filebase64sha256({
            input: "contact_flow.json",
        }).then(invoke => invoke.result),
        tags: {
            Name: "Test Contact Flow",
            Application: "Example",
            Method: "Create",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    test = aws.connect.ContactFlow("test",
        instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
        name="Test",
        description="Test Contact Flow Description",
        type="CONTACT_FLOW",
        filename="contact_flow.json",
        content_hash=std.filebase64sha256(input="contact_flow.json").result,
        tags={
            "Name": "Test Contact Flow",
            "Application": "Example",
            "Method": "Create",
        })
    
    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.json",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = connect.NewContactFlow(ctx, "test", &connect.ContactFlowArgs{
    			InstanceId:  pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
    			Name:        pulumi.String("Test"),
    			Description: pulumi.String("Test Contact Flow Description"),
    			Type:        pulumi.String("CONTACT_FLOW"),
    			Filename:    pulumi.String("contact_flow.json"),
    			ContentHash: invokeFilebase64sha256.Result,
    			Tags: pulumi.StringMap{
    				"Name":        pulumi.String("Test Contact Flow"),
    				"Application": pulumi.String("Example"),
    				"Method":      pulumi.String("Create"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.Connect.ContactFlow("test", new()
        {
            InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
            Name = "Test",
            Description = "Test Contact Flow Description",
            Type = "CONTACT_FLOW",
            Filename = "contact_flow.json",
            ContentHash = Std.Filebase64sha256.Invoke(new()
            {
                Input = "contact_flow.json",
            }).Apply(invoke => invoke.Result),
            Tags = 
            {
                { "Name", "Test Contact Flow" },
                { "Application", "Example" },
                { "Method", "Create" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.connect.ContactFlow;
    import com.pulumi.aws.connect.ContactFlowArgs;
    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 ContactFlow("test", ContactFlowArgs.builder()
                .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
                .name("Test")
                .description("Test Contact Flow Description")
                .type("CONTACT_FLOW")
                .filename("contact_flow.json")
                .contentHash(StdFunctions.filebase64sha256(Filebase64sha256Args.builder()
                    .input("contact_flow.json")
                    .build()).result())
                .tags(Map.ofEntries(
                    Map.entry("Name", "Test Contact Flow"),
                    Map.entry("Application", "Example"),
                    Map.entry("Method", "Create")
                ))
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:connect:ContactFlow
        properties:
          instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
          name: Test
          description: Test Contact Flow Description
          type: CONTACT_FLOW
          filename: contact_flow.json
          contentHash:
            fn::invoke:
              Function: std:filebase64sha256
              Arguments:
                input: contact_flow.json
              Return: result
          tags:
            Name: Test Contact Flow
            Application: Example
            Method: Create
    

    Create ContactFlow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ContactFlow(name: string, args: ContactFlowArgs, opts?: CustomResourceOptions);
    @overload
    def ContactFlow(resource_name: str,
                    args: ContactFlowArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def ContactFlow(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    instance_id: Optional[str] = None,
                    content: Optional[str] = None,
                    content_hash: Optional[str] = None,
                    description: Optional[str] = None,
                    filename: Optional[str] = None,
                    name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    type: Optional[str] = None)
    func NewContactFlow(ctx *Context, name string, args ContactFlowArgs, opts ...ResourceOption) (*ContactFlow, error)
    public ContactFlow(string name, ContactFlowArgs args, CustomResourceOptions? opts = null)
    public ContactFlow(String name, ContactFlowArgs args)
    public ContactFlow(String name, ContactFlowArgs args, CustomResourceOptions options)
    
    type: aws:connect:ContactFlow
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ContactFlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ContactFlowArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ContactFlowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContactFlowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContactFlowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var contactFlowResource = new Aws.Connect.ContactFlow("contactFlowResource", new()
    {
        InstanceId = "string",
        Content = "string",
        ContentHash = "string",
        Description = "string",
        Filename = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Type = "string",
    });
    
    example, err := connect.NewContactFlow(ctx, "contactFlowResource", &connect.ContactFlowArgs{
    	InstanceId:  pulumi.String("string"),
    	Content:     pulumi.String("string"),
    	ContentHash: pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Filename:    pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var contactFlowResource = new ContactFlow("contactFlowResource", ContactFlowArgs.builder()
        .instanceId("string")
        .content("string")
        .contentHash("string")
        .description("string")
        .filename("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .type("string")
        .build());
    
    contact_flow_resource = aws.connect.ContactFlow("contactFlowResource",
        instance_id="string",
        content="string",
        content_hash="string",
        description="string",
        filename="string",
        name="string",
        tags={
            "string": "string",
        },
        type="string")
    
    const contactFlowResource = new aws.connect.ContactFlow("contactFlowResource", {
        instanceId: "string",
        content: "string",
        contentHash: "string",
        description: "string",
        filename: "string",
        name: "string",
        tags: {
            string: "string",
        },
        type: "string",
    });
    
    type: aws:connect:ContactFlow
    properties:
        content: string
        contentHash: string
        description: string
        filename: string
        instanceId: string
        name: string
        tags:
            string: string
        type: string
    

    ContactFlow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ContactFlow resource accepts the following input properties:

    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    ContentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    Description string
    Specifies the description of the Contact Flow.
    Filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    Name string
    Specifies the name of the Contact Flow.
    Tags Dictionary<string, string>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    ContentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    Description string
    Specifies the description of the Contact Flow.
    Filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    Name string
    Specifies the name of the Contact Flow.
    Tags map[string]string
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    content String
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash String
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description String
    Specifies the description of the Contact Flow.
    filename String
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    name String
    Specifies the name of the Contact Flow.
    tags Map<String,String>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description string
    Specifies the description of the Contact Flow.
    filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    name string
    Specifies the name of the Contact Flow.
    tags {[key: string]: string}
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    content str
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    content_hash str
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description str
    Specifies the description of the Contact Flow.
    filename str
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    name str
    Specifies the name of the Contact Flow.
    tags Mapping[str, str]
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type str
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    content String
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash String
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description String
    Specifies the description of the Contact Flow.
    filename String
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    name String
    Specifies the name of the Contact Flow.
    tags Map<String>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ContactFlow resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    ContactFlowId string
    The identifier of the Contact Flow.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    ContactFlowId string
    The identifier of the Contact Flow.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId String
    The identifier of the Contact Flow.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId string
    The identifier of the Contact Flow.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) of the Contact Flow.
    contact_flow_id str
    The identifier of the Contact Flow.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId String
    The identifier of the Contact Flow.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ContactFlow Resource

    Get an existing ContactFlow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ContactFlowState, opts?: CustomResourceOptions): ContactFlow
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            contact_flow_id: Optional[str] = None,
            content: Optional[str] = None,
            content_hash: Optional[str] = None,
            description: Optional[str] = None,
            filename: Optional[str] = None,
            instance_id: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None) -> ContactFlow
    func GetContactFlow(ctx *Context, name string, id IDInput, state *ContactFlowState, opts ...ResourceOption) (*ContactFlow, error)
    public static ContactFlow Get(string name, Input<string> id, ContactFlowState? state, CustomResourceOptions? opts = null)
    public static ContactFlow get(String name, Output<String> id, ContactFlowState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    ContactFlowId string
    The identifier of the Contact Flow.
    Content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    ContentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    Description string
    Specifies the description of the Contact Flow.
    Filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    Specifies the name of the Contact Flow.
    Tags Dictionary<string, string>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    Arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    ContactFlowId string
    The identifier of the Contact Flow.
    Content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    ContentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    Description string
    Specifies the description of the Contact Flow.
    Filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    InstanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    Name string
    Specifies the name of the Contact Flow.
    Tags map[string]string
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    arn String
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId String
    The identifier of the Contact Flow.
    content String
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash String
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description String
    Specifies the description of the Contact Flow.
    filename String
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    Specifies the name of the Contact Flow.
    tags Map<String,String>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    arn string
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId string
    The identifier of the Contact Flow.
    content string
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash string
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description string
    Specifies the description of the Contact Flow.
    filename string
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    instanceId string
    Specifies the identifier of the hosting Amazon Connect Instance.
    name string
    Specifies the name of the Contact Flow.
    tags {[key: string]: string}
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    arn str
    The Amazon Resource Name (ARN) of the Contact Flow.
    contact_flow_id str
    The identifier of the Contact Flow.
    content str
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    content_hash str
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description str
    Specifies the description of the Contact Flow.
    filename str
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    instance_id str
    Specifies the identifier of the hosting Amazon Connect Instance.
    name str
    Specifies the name of the Contact Flow.
    tags Mapping[str, str]
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.
    arn String
    The Amazon Resource Name (ARN) of the Contact Flow.
    contactFlowId String
    The identifier of the Contact Flow.
    content String
    Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the filename argument cannot be used.
    contentHash String
    Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with filename.
    description String
    Specifies the description of the Contact Flow.
    filename String
    The path to the Contact Flow source within the local filesystem. Conflicts with content.
    instanceId String
    Specifies the identifier of the hosting Amazon Connect Instance.
    name String
    Specifies the name of the Contact Flow.
    tags Map<String>
    Tags to apply to the Contact Flow. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Specifies the type of the Contact Flow. Defaults to CONTACT_FLOW. Allowed Values are: CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER.

    Import

    Using pulumi import, import Amazon Connect Contact Flows using the instance_id and contact_flow_id separated by a colon (:). For example:

    $ pulumi import aws:connect/contactFlow:ContactFlow example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi