Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. ContactFlow

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.ContactFlow

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::ContactFlow

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var flow = new AwsNative.Connect.ContactFlow("flow", new()
    {
        Name = "ExampleFlow",
        Description = "flow created using cfn",
        InstanceArn = "arn:aws:connect:region-name:aws-account-id:instance/instance-arn",
        Type = AwsNative.Connect.ContactFlowType.ContactFlow,
        Content = "ExampleFlow content(JSON) using Amazon Connect Flow Language.",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "testkey",
                Value = "testValue",
            },
        },
    });

});

    package main

import (
	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewContactFlow(ctx, "flow", &connect.ContactFlowArgs{
			Name:        pulumi.String("ExampleFlow"),
			Description: pulumi.String("flow created using cfn"),
			InstanceArn: pulumi.String("arn:aws:connect:region-name:aws-account-id:instance/instance-arn"),
			Type:        connect.ContactFlowTypeContactFlow,
			Content:     pulumi.String("ExampleFlow content(JSON) using Amazon Connect Flow Language."),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("testkey"),
					Value: pulumi.String("testValue"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

flow = aws_native.connect.ContactFlow("flow",
    name="ExampleFlow",
    description="flow created using cfn",
    instance_arn="arn:aws:connect:region-name:aws-account-id:instance/instance-arn",
    type=aws_native.connect.ContactFlowType.CONTACT_FLOW,
    content="ExampleFlow content(JSON) using Amazon Connect Flow Language.",
    tags=[{
        "key": "testkey",
        "value": "testValue",
    }])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const flow = new aws_native.connect.ContactFlow("flow", {
    name: "ExampleFlow",
    description: "flow created using cfn",
    instanceArn: "arn:aws:connect:region-name:aws-account-id:instance/instance-arn",
    type: aws_native.connect.ContactFlowType.ContactFlow,
    content: "ExampleFlow content(JSON) using Amazon Connect Flow Language.",
    tags: [{
        key: "testkey",
        value: "testValue",
    }],
});

    Coming soon!

    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,
                content: Optional[str] = None,
                instance_arn: Optional[str] = None,
                type: Optional[ContactFlowType] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                state: Optional[ContactFlowState] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ContactFlow resource accepts the following input properties:

    Content string
    The content of the contact flow in JSON format.
    InstanceArn string
    The identifier of the Amazon Connect instance (ARN).
    Type Pulumi.AwsNative.Connect.ContactFlowType
    The type of the contact flow.
    Description string
    The description of the contact flow.
    Name string
    The name of the contact flow.
    State Pulumi.AwsNative.Connect.ContactFlowState
    The state of the contact flow.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags.
    Content string
    The content of the contact flow in JSON format.
    InstanceArn string
    The identifier of the Amazon Connect instance (ARN).
    Type ContactFlowType
    The type of the contact flow.
    Description string
    The description of the contact flow.
    Name string
    The name of the contact flow.
    State ContactFlowStateEnum
    The state of the contact flow.
    Tags TagArgs
    One or more tags.
    content String
    The content of the contact flow in JSON format.
    instanceArn String
    The identifier of the Amazon Connect instance (ARN).
    type ContactFlowType
    The type of the contact flow.
    description String
    The description of the contact flow.
    name String
    The name of the contact flow.
    state ContactFlowState
    The state of the contact flow.
    tags List<Tag>
    One or more tags.
    content string
    The content of the contact flow in JSON format.
    instanceArn string
    The identifier of the Amazon Connect instance (ARN).
    type ContactFlowType
    The type of the contact flow.
    description string
    The description of the contact flow.
    name string
    The name of the contact flow.
    state ContactFlowState
    The state of the contact flow.
    tags Tag[]
    One or more tags.
    content str
    The content of the contact flow in JSON format.
    instance_arn str
    The identifier of the Amazon Connect instance (ARN).
    type ContactFlowType
    The type of the contact flow.
    description str
    The description of the contact flow.
    name str
    The name of the contact flow.
    state ContactFlowState
    The state of the contact flow.
    tags Sequence[TagArgs]
    One or more tags.
    content String
    The content of the contact flow in JSON format.
    instanceArn String
    The identifier of the Amazon Connect instance (ARN).
    type "CONTACT_FLOW" | "CUSTOMER_QUEUE" | "CUSTOMER_HOLD" | "CUSTOMER_WHISPER" | "AGENT_HOLD" | "AGENT_WHISPER" | "OUTBOUND_WHISPER" | "AGENT_TRANSFER" | "QUEUE_TRANSFER" | "CAMPAIGN"
    The type of the contact flow.
    description String
    The description of the contact flow.
    name String
    The name of the contact flow.
    state "ACTIVE" | "ARCHIVED"
    The state of the contact flow.
    tags List<Property Map>
    One or more tags.

    Outputs

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

    ContactFlowArn string
    The identifier of the contact flow (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    ContactFlowArn string
    The identifier of the contact flow (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    contactFlowArn String
    The identifier of the contact flow (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    contactFlowArn string
    The identifier of the contact flow (ARN).
    id string
    The provider-assigned unique ID for this managed resource.
    contact_flow_arn str
    The identifier of the contact flow (ARN).
    id str
    The provider-assigned unique ID for this managed resource.
    contactFlowArn String
    The identifier of the contact flow (ARN).
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ContactFlowState, ContactFlowStateArgs

    Active
    ACTIVE
    Archived
    ARCHIVED
    ContactFlowStateActive
    ACTIVE
    ContactFlowStateArchived
    ARCHIVED
    Active
    ACTIVE
    Archived
    ARCHIVED
    Active
    ACTIVE
    Archived
    ARCHIVED
    ACTIVE
    ACTIVE
    ARCHIVED
    ARCHIVED
    "ACTIVE"
    ACTIVE
    "ARCHIVED"
    ARCHIVED

    ContactFlowType, ContactFlowTypeArgs

    ContactFlow
    CONTACT_FLOW
    CustomerQueue
    CUSTOMER_QUEUE
    CustomerHold
    CUSTOMER_HOLD
    CustomerWhisper
    CUSTOMER_WHISPER
    AgentHold
    AGENT_HOLD
    AgentWhisper
    AGENT_WHISPER
    OutboundWhisper
    OUTBOUND_WHISPER
    AgentTransfer
    AGENT_TRANSFER
    QueueTransfer
    QUEUE_TRANSFER
    Campaign
    CAMPAIGN
    ContactFlowTypeContactFlow
    CONTACT_FLOW
    ContactFlowTypeCustomerQueue
    CUSTOMER_QUEUE
    ContactFlowTypeCustomerHold
    CUSTOMER_HOLD
    ContactFlowTypeCustomerWhisper
    CUSTOMER_WHISPER
    ContactFlowTypeAgentHold
    AGENT_HOLD
    ContactFlowTypeAgentWhisper
    AGENT_WHISPER
    ContactFlowTypeOutboundWhisper
    OUTBOUND_WHISPER
    ContactFlowTypeAgentTransfer
    AGENT_TRANSFER
    ContactFlowTypeQueueTransfer
    QUEUE_TRANSFER
    ContactFlowTypeCampaign
    CAMPAIGN
    ContactFlow
    CONTACT_FLOW
    CustomerQueue
    CUSTOMER_QUEUE
    CustomerHold
    CUSTOMER_HOLD
    CustomerWhisper
    CUSTOMER_WHISPER
    AgentHold
    AGENT_HOLD
    AgentWhisper
    AGENT_WHISPER
    OutboundWhisper
    OUTBOUND_WHISPER
    AgentTransfer
    AGENT_TRANSFER
    QueueTransfer
    QUEUE_TRANSFER
    Campaign
    CAMPAIGN
    ContactFlow
    CONTACT_FLOW
    CustomerQueue
    CUSTOMER_QUEUE
    CustomerHold
    CUSTOMER_HOLD
    CustomerWhisper
    CUSTOMER_WHISPER
    AgentHold
    AGENT_HOLD
    AgentWhisper
    AGENT_WHISPER
    OutboundWhisper
    OUTBOUND_WHISPER
    AgentTransfer
    AGENT_TRANSFER
    QueueTransfer
    QUEUE_TRANSFER
    Campaign
    CAMPAIGN
    CONTACT_FLOW
    CONTACT_FLOW
    CUSTOMER_QUEUE
    CUSTOMER_QUEUE
    CUSTOMER_HOLD
    CUSTOMER_HOLD
    CUSTOMER_WHISPER
    CUSTOMER_WHISPER
    AGENT_HOLD
    AGENT_HOLD
    AGENT_WHISPER
    AGENT_WHISPER
    OUTBOUND_WHISPER
    OUTBOUND_WHISPER
    AGENT_TRANSFER
    AGENT_TRANSFER
    QUEUE_TRANSFER
    QUEUE_TRANSFER
    CAMPAIGN
    CAMPAIGN
    "CONTACT_FLOW"
    CONTACT_FLOW
    "CUSTOMER_QUEUE"
    CUSTOMER_QUEUE
    "CUSTOMER_HOLD"
    CUSTOMER_HOLD
    "CUSTOMER_WHISPER"
    CUSTOMER_WHISPER
    "AGENT_HOLD"
    AGENT_HOLD
    "AGENT_WHISPER"
    AGENT_WHISPER
    "OUTBOUND_WHISPER"
    OUTBOUND_WHISPER
    "AGENT_TRANSFER"
    AGENT_TRANSFER
    "QUEUE_TRANSFER"
    QUEUE_TRANSFER
    "CAMPAIGN"
    CAMPAIGN

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native