connect

package
v4.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ContactFlow 

type ContactFlow struct {
	pulumi.CustomResourceState

	// The Amazon Resource Name (ARN) of the Contact Flow.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The identifier of the Contact Flow.
	ContactFlowId pulumi.StringOutput `pulumi:"contactFlowId"`
	// 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     pulumi.StringOutput    `pulumi:"content"`
	ContentHash pulumi.StringPtrOutput `pulumi:"contentHash"`
	// Specifies the description of the Contact Flow.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The path to the Contact Flow source within the local filesystem. Conflicts with `content`.
	Filename pulumi.StringPtrOutput `pulumi:"filename"`
	// Specifies the identifier of the hosting Amazon Connect Instance.
	InstanceId pulumi.StringOutput `pulumi:"instanceId"`
	// Specifies the name of the Contact Flow.
	Name pulumi.StringOutput `pulumi:"name"`
	// Tags to apply to the Contact Flow. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block).
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// 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`.
	Type pulumi.StringPtrOutput `pulumi:"type"`
}

Provides an Amazon Connect Contact Flow 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 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 Flows exported from the Console [Contact Flow import/export](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`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-contact-flow.html). See example below which uses `jq` to extract the `Content` attribute and saves it to a local file.

> **NOTE:** Due to The behaviour of Amazon Connect you cannot delete contact flows. The [recommendation](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#before-create-contact-flow) is to prefix the Contact Flow with `zzTrash_` to get obsolete contact flows out of the way.

## Example Usage ### Basic

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewContactFlow(ctx, "test", &connect.ContactFlowArgs{
			Content: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "	{\n", "		\"Version\": \"2019-10-30\",\n", "		\"StartAction\": \"12345678-1234-1234-1234-123456789012\",\n", "		\"Actions\": [\n", "			{\n", "				\"Identifier\": \"12345678-1234-1234-1234-123456789012\",\n", "				\"Type\": \"MessageParticipant\",\n", "				\"Transitions\": {\n", "					\"NextAction\": \"abcdef-abcd-abcd-abcd-abcdefghijkl\",\n", "					\"Errors\": [],\n", "					\"Conditions\": []\n", "				},\n", "				\"Parameters\": {\n", "					\"Text\": \"Thanks for calling the sample flow!\"\n", "				}\n", "			},\n", "			{\n", "				\"Identifier\": \"abcdef-abcd-abcd-abcd-abcdefghijkl\",\n", "				\"Type\": \"DisconnectParticipant\",\n", "				\"Transitions\": {},\n", "				\"Parameters\": {}\n", "			}\n", "		]\n", "	}\n", "	\n")),
			Description: pulumi.String("Test Contact Flow Description"),
			InstanceId:  pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Tags: pulumi.StringMap{
				"Application": pulumi.String("Terraform"),
				"Method":      pulumi.String("Create"),
				"Name":        pulumi.String("Test Contact Flow"),
			},
			Type: pulumi.String("CONTACT_FLOW"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Amazon Connect Contact Flows can be imported using the `instance_id` and `contact_flow_id` separated by a colon (`:`), e.g.

```sh 

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

```

func GetContactFlow 

func GetContactFlow(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ContactFlowState, opts ...pulumi.ResourceOption) (*ContactFlow, error)

GetContactFlow gets an existing ContactFlow resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewContactFlow 

func NewContactFlow(ctx *pulumi.Context,
	name string, args *ContactFlowArgs, opts ...pulumi.ResourceOption) (*ContactFlow, error)

NewContactFlow registers a new resource with the given unique name, arguments, and options.

func (*ContactFlow) ElementType 

func (*ContactFlow) ElementType() reflect.Type

func (*ContactFlow) ToContactFlowOutput 

func (i *ContactFlow) ToContactFlowOutput() ContactFlowOutput

func (*ContactFlow) ToContactFlowOutputWithContext 

func (i *ContactFlow) ToContactFlowOutputWithContext(ctx context.Context) ContactFlowOutput

func (*ContactFlow) ToContactFlowPtrOutput 

func (i *ContactFlow) ToContactFlowPtrOutput() ContactFlowPtrOutput

func (*ContactFlow) ToContactFlowPtrOutputWithContext 

func (i *ContactFlow) ToContactFlowPtrOutputWithContext(ctx context.Context) ContactFlowPtrOutput

type ContactFlowArgs 

type ContactFlowArgs struct {
	// 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     pulumi.StringPtrInput
	ContentHash pulumi.StringPtrInput
	// Specifies the description of the Contact Flow.
	Description pulumi.StringPtrInput
	// The path to the Contact Flow source within the local filesystem. Conflicts with `content`.
	Filename pulumi.StringPtrInput
	// Specifies the identifier of the hosting Amazon Connect Instance.
	InstanceId pulumi.StringInput
	// Specifies the name of the Contact Flow.
	Name pulumi.StringPtrInput
	// Tags to apply to the Contact Flow. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block).
	TagsAll pulumi.StringMapInput
	// 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`.
	Type pulumi.StringPtrInput
}

The set of arguments for constructing a ContactFlow resource.

func (ContactFlowArgs) ElementType 

func (ContactFlowArgs) ElementType() reflect.Type

type ContactFlowArray 

type ContactFlowArray []ContactFlowInput

func (ContactFlowArray) ElementType 

func (ContactFlowArray) ElementType() reflect.Type

func (ContactFlowArray) ToContactFlowArrayOutput 

func (i ContactFlowArray) ToContactFlowArrayOutput() ContactFlowArrayOutput

func (ContactFlowArray) ToContactFlowArrayOutputWithContext 

func (i ContactFlowArray) ToContactFlowArrayOutputWithContext(ctx context.Context) ContactFlowArrayOutput

type ContactFlowArrayInput 

type ContactFlowArrayInput interface {
	pulumi.Input

	ToContactFlowArrayOutput() ContactFlowArrayOutput
	ToContactFlowArrayOutputWithContext(context.Context) ContactFlowArrayOutput
}

ContactFlowArrayInput is an input type that accepts ContactFlowArray and ContactFlowArrayOutput values. You can construct a concrete instance of `ContactFlowArrayInput` via: 

ContactFlowArray{ ContactFlowArgs{...} }

type ContactFlowArrayOutput 

type ContactFlowArrayOutput struct{ *pulumi.OutputState }

func (ContactFlowArrayOutput) ElementType 

func (ContactFlowArrayOutput) ElementType() reflect.Type

func (ContactFlowArrayOutput) Index 

func (o ContactFlowArrayOutput) Index(i pulumi.IntInput) ContactFlowOutput

func (ContactFlowArrayOutput) ToContactFlowArrayOutput 

func (o ContactFlowArrayOutput) ToContactFlowArrayOutput() ContactFlowArrayOutput

func (ContactFlowArrayOutput) ToContactFlowArrayOutputWithContext 

func (o ContactFlowArrayOutput) ToContactFlowArrayOutputWithContext(ctx context.Context) ContactFlowArrayOutput

type ContactFlowInput 

type ContactFlowInput interface {
	pulumi.Input

	ToContactFlowOutput() ContactFlowOutput
	ToContactFlowOutputWithContext(ctx context.Context) ContactFlowOutput
}

type ContactFlowMap 

type ContactFlowMap map[string]ContactFlowInput

func (ContactFlowMap) ElementType 

func (ContactFlowMap) ElementType() reflect.Type

func (ContactFlowMap) ToContactFlowMapOutput 

func (i ContactFlowMap) ToContactFlowMapOutput() ContactFlowMapOutput

func (ContactFlowMap) ToContactFlowMapOutputWithContext 

func (i ContactFlowMap) ToContactFlowMapOutputWithContext(ctx context.Context) ContactFlowMapOutput

type ContactFlowMapInput 

type ContactFlowMapInput interface {
	pulumi.Input

	ToContactFlowMapOutput() ContactFlowMapOutput
	ToContactFlowMapOutputWithContext(context.Context) ContactFlowMapOutput
}

ContactFlowMapInput is an input type that accepts ContactFlowMap and ContactFlowMapOutput values. You can construct a concrete instance of `ContactFlowMapInput` via: 

ContactFlowMap{ "key": ContactFlowArgs{...} }

type ContactFlowMapOutput 

type ContactFlowMapOutput struct{ *pulumi.OutputState }

func (ContactFlowMapOutput) ElementType 

func (ContactFlowMapOutput) ElementType() reflect.Type

func (ContactFlowMapOutput) MapIndex 

func (o ContactFlowMapOutput) MapIndex(k pulumi.StringInput) ContactFlowOutput

func (ContactFlowMapOutput) ToContactFlowMapOutput 

func (o ContactFlowMapOutput) ToContactFlowMapOutput() ContactFlowMapOutput

func (ContactFlowMapOutput) ToContactFlowMapOutputWithContext 

func (o ContactFlowMapOutput) ToContactFlowMapOutputWithContext(ctx context.Context) ContactFlowMapOutput

type ContactFlowOutput 

type ContactFlowOutput struct{ *pulumi.OutputState }

func (ContactFlowOutput) ElementType 

func (ContactFlowOutput) ElementType() reflect.Type

func (ContactFlowOutput) ToContactFlowOutput 

func (o ContactFlowOutput) ToContactFlowOutput() ContactFlowOutput

func (ContactFlowOutput) ToContactFlowOutputWithContext 

func (o ContactFlowOutput) ToContactFlowOutputWithContext(ctx context.Context) ContactFlowOutput

func (ContactFlowOutput) ToContactFlowPtrOutput 

func (o ContactFlowOutput) ToContactFlowPtrOutput() ContactFlowPtrOutput

func (ContactFlowOutput) ToContactFlowPtrOutputWithContext 

func (o ContactFlowOutput) ToContactFlowPtrOutputWithContext(ctx context.Context) ContactFlowPtrOutput

type ContactFlowPtrInput 

type ContactFlowPtrInput interface {
	pulumi.Input

	ToContactFlowPtrOutput() ContactFlowPtrOutput
	ToContactFlowPtrOutputWithContext(ctx context.Context) ContactFlowPtrOutput
}

type ContactFlowPtrOutput 

type ContactFlowPtrOutput struct{ *pulumi.OutputState }

func (ContactFlowPtrOutput) Elem 

func (o ContactFlowPtrOutput) Elem() ContactFlowOutput

func (ContactFlowPtrOutput) ElementType 

func (ContactFlowPtrOutput) ElementType() reflect.Type

func (ContactFlowPtrOutput) ToContactFlowPtrOutput 

func (o ContactFlowPtrOutput) ToContactFlowPtrOutput() ContactFlowPtrOutput

func (ContactFlowPtrOutput) ToContactFlowPtrOutputWithContext 

func (o ContactFlowPtrOutput) ToContactFlowPtrOutputWithContext(ctx context.Context) ContactFlowPtrOutput

type ContactFlowState 

type ContactFlowState struct {
	// The Amazon Resource Name (ARN) of the Contact Flow.
	Arn pulumi.StringPtrInput
	// The identifier of the Contact Flow.
	ContactFlowId pulumi.StringPtrInput
	// 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     pulumi.StringPtrInput
	ContentHash pulumi.StringPtrInput
	// Specifies the description of the Contact Flow.
	Description pulumi.StringPtrInput
	// The path to the Contact Flow source within the local filesystem. Conflicts with `content`.
	Filename pulumi.StringPtrInput
	// Specifies the identifier of the hosting Amazon Connect Instance.
	InstanceId pulumi.StringPtrInput
	// Specifies the name of the Contact Flow.
	Name pulumi.StringPtrInput
	// Tags to apply to the Contact Flow. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block).
	TagsAll pulumi.StringMapInput
	// 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`.
	Type pulumi.StringPtrInput
}

func (ContactFlowState) ElementType 

func (ContactFlowState) ElementType() reflect.Type

type Instance 

type Instance struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the instance.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Specifies whether auto resolve best voices is enabled. Defaults to `true`.
	AutoResolveBestVoicesEnabled pulumi.BoolPtrOutput `pulumi:"autoResolveBestVoicesEnabled"`
	// Specifies whether contact flow logs are enabled. Defaults to `false`.
	ContactFlowLogsEnabled pulumi.BoolPtrOutput `pulumi:"contactFlowLogsEnabled"`
	// Specifies whether contact lens is enabled. Defaults to `true`.
	ContactLensEnabled pulumi.BoolPtrOutput `pulumi:"contactLensEnabled"`
	// Specifies when the instance was created.
	CreatedTime pulumi.StringOutput `pulumi:"createdTime"`
	// The identifier for the directory if identityManagementType is `EXISTING_DIRECTORY`.
	DirectoryId pulumi.StringPtrOutput `pulumi:"directoryId"`
	// Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
	EarlyMediaEnabled pulumi.BoolPtrOutput `pulumi:"earlyMediaEnabled"`
	// Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
	IdentityManagementType pulumi.StringOutput `pulumi:"identityManagementType"`
	// Specifies whether inbound calls are enabled.
	InboundCallsEnabled pulumi.BoolOutput `pulumi:"inboundCallsEnabled"`
	// Specifies the name of the instance. Required if `directoryId` not specified.
	InstanceAlias pulumi.StringPtrOutput `pulumi:"instanceAlias"`
	// Specifies whether outbound calls are enabled.
	// <!-- * `useCustomTtsVoices` - (Optional) Specifies Whether use custom tts voices is enabled. Defaults to `false` -->
	OutboundCallsEnabled pulumi.BoolOutput `pulumi:"outboundCallsEnabled"`
	// The service role of the instance.
	ServiceRole pulumi.StringOutput `pulumi:"serviceRole"`
	// The state of the instance.
	Status pulumi.StringOutput `pulumi:"status"`
}

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:** There are limits to the number of Connect Instances that can be created in a specific AWS account, and those limits span the life of the account, not just active Instances. Minimize the number of times you create/delete an instance.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/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),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### With Existing Active Directory

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/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(aws_directory_service_directory.Test.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
	})
}

``` ### With SAML

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/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
	})
}

```

## Import

Connect instances can be imported using the `id`, e.g.

```sh 

$ pulumi import aws:connect/instance:Instance example f1288a1f-6193-445a-b47e-af739b2

```

func GetInstance 

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstance 

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) ElementType 

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput 

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext 

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (*Instance) ToInstancePtrOutput 

func (i *Instance) ToInstancePtrOutput() InstancePtrOutput

func (*Instance) ToInstancePtrOutputWithContext 

func (i *Instance) ToInstancePtrOutputWithContext(ctx context.Context) InstancePtrOutput

type InstanceArgs 

type InstanceArgs struct {
	// Specifies whether auto resolve best voices is enabled. Defaults to `true`.
	AutoResolveBestVoicesEnabled pulumi.BoolPtrInput
	// Specifies whether contact flow logs are enabled. Defaults to `false`.
	ContactFlowLogsEnabled pulumi.BoolPtrInput
	// Specifies whether contact lens is enabled. Defaults to `true`.
	ContactLensEnabled pulumi.BoolPtrInput
	// The identifier for the directory if identityManagementType is `EXISTING_DIRECTORY`.
	DirectoryId pulumi.StringPtrInput
	// Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
	EarlyMediaEnabled pulumi.BoolPtrInput
	// Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
	IdentityManagementType pulumi.StringInput
	// Specifies whether inbound calls are enabled.
	InboundCallsEnabled pulumi.BoolInput
	// Specifies the name of the instance. Required if `directoryId` not specified.
	InstanceAlias pulumi.StringPtrInput
	// Specifies whether outbound calls are enabled.
	// <!-- * `useCustomTtsVoices` - (Optional) Specifies Whether use custom tts voices is enabled. Defaults to `false` -->
	OutboundCallsEnabled pulumi.BoolInput
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType 

func (InstanceArgs) ElementType() reflect.Type

type InstanceArray 

type InstanceArray []InstanceInput

func (InstanceArray) ElementType 

func (InstanceArray) ElementType() reflect.Type

func (InstanceArray) ToInstanceArrayOutput 

func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArray) ToInstanceArrayOutputWithContext 

func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceArrayInput 

type InstanceArrayInput interface {
	pulumi.Input

	ToInstanceArrayOutput() InstanceArrayOutput
	ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput
}

InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via: 

InstanceArray{ InstanceArgs{...} }

type InstanceArrayOutput 

type InstanceArrayOutput struct{ *pulumi.OutputState }

func (InstanceArrayOutput) ElementType 

func (InstanceArrayOutput) ElementType() reflect.Type

func (InstanceArrayOutput) Index 

func (o InstanceArrayOutput) Index(i pulumi.IntInput) InstanceOutput

func (InstanceArrayOutput) ToInstanceArrayOutput 

func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArrayOutput) ToInstanceArrayOutputWithContext 

func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceInput 

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceMap 

type InstanceMap map[string]InstanceInput

func (InstanceMap) ElementType 

func (InstanceMap) ElementType() reflect.Type

func (InstanceMap) ToInstanceMapOutput 

func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMap) ToInstanceMapOutputWithContext 

func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceMapInput 

type InstanceMapInput interface {
	pulumi.Input

	ToInstanceMapOutput() InstanceMapOutput
	ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput
}

InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via: 

InstanceMap{ "key": InstanceArgs{...} }

type InstanceMapOutput 

type InstanceMapOutput struct{ *pulumi.OutputState }

func (InstanceMapOutput) ElementType 

func (InstanceMapOutput) ElementType() reflect.Type

func (InstanceMapOutput) MapIndex 

func (o InstanceMapOutput) MapIndex(k pulumi.StringInput) InstanceOutput

func (InstanceMapOutput) ToInstanceMapOutput 

func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMapOutput) ToInstanceMapOutputWithContext 

func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceOutput 

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) ElementType 

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) ToInstanceOutput 

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext 

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) ToInstancePtrOutput 

func (o InstanceOutput) ToInstancePtrOutput() InstancePtrOutput

func (InstanceOutput) ToInstancePtrOutputWithContext 

func (o InstanceOutput) ToInstancePtrOutputWithContext(ctx context.Context) InstancePtrOutput

type InstancePtrInput 

type InstancePtrInput interface {
	pulumi.Input

	ToInstancePtrOutput() InstancePtrOutput
	ToInstancePtrOutputWithContext(ctx context.Context) InstancePtrOutput
}

type InstancePtrOutput 

type InstancePtrOutput struct{ *pulumi.OutputState }

func (InstancePtrOutput) Elem 

func (o InstancePtrOutput) Elem() InstanceOutput

func (InstancePtrOutput) ElementType 

func (InstancePtrOutput) ElementType() reflect.Type

func (InstancePtrOutput) ToInstancePtrOutput 

func (o InstancePtrOutput) ToInstancePtrOutput() InstancePtrOutput

func (InstancePtrOutput) ToInstancePtrOutputWithContext 

func (o InstancePtrOutput) ToInstancePtrOutputWithContext(ctx context.Context) InstancePtrOutput

type InstanceState 

type InstanceState struct {
	// Amazon Resource Name (ARN) of the instance.
	Arn pulumi.StringPtrInput
	// Specifies whether auto resolve best voices is enabled. Defaults to `true`.
	AutoResolveBestVoicesEnabled pulumi.BoolPtrInput
	// Specifies whether contact flow logs are enabled. Defaults to `false`.
	ContactFlowLogsEnabled pulumi.BoolPtrInput
	// Specifies whether contact lens is enabled. Defaults to `true`.
	ContactLensEnabled pulumi.BoolPtrInput
	// Specifies when the instance was created.
	CreatedTime pulumi.StringPtrInput
	// The identifier for the directory if identityManagementType is `EXISTING_DIRECTORY`.
	DirectoryId pulumi.StringPtrInput
	// Specifies whether early media for outbound calls is enabled . Defaults to `true` if outbound calls is enabled.
	EarlyMediaEnabled pulumi.BoolPtrInput
	// Specifies the identity management type attached to the instance. Allowed Values are: `SAML`, `CONNECT_MANAGED`, `EXISTING_DIRECTORY`.
	IdentityManagementType pulumi.StringPtrInput
	// Specifies whether inbound calls are enabled.
	InboundCallsEnabled pulumi.BoolPtrInput
	// Specifies the name of the instance. Required if `directoryId` not specified.
	InstanceAlias pulumi.StringPtrInput
	// Specifies whether outbound calls are enabled.
	// <!-- * `useCustomTtsVoices` - (Optional) Specifies Whether use custom tts voices is enabled. Defaults to `false` -->
	OutboundCallsEnabled pulumi.BoolPtrInput
	// The service role of the instance.
	ServiceRole pulumi.StringPtrInput
	// The state of the instance.
	Status pulumi.StringPtrInput
}

func (InstanceState) ElementType 

func (InstanceState) ElementType() reflect.Type

type LookupContactFlowArgs 

type LookupContactFlowArgs struct {
	// Returns information on a specific Contact Flow by contact flow id
	ContactFlowId *string `pulumi:"contactFlowId"`
	// Reference to the hosting Amazon Connect Instance
	InstanceId string `pulumi:"instanceId"`
	// Returns information on a specific Contact Flow by name
	Name *string `pulumi:"name"`
	// A the map of tags to assign to the Contact Flow.
	Tags map[string]string `pulumi:"tags"`
	// Specifies the type of Contact Flow.
	Type *string `pulumi:"type"`
}

A collection of arguments for invoking getContactFlow.

type LookupContactFlowOutputArgs 

type LookupContactFlowOutputArgs struct {
	// Returns information on a specific Contact Flow by contact flow id
	ContactFlowId pulumi.StringPtrInput `pulumi:"contactFlowId"`
	// Reference to the hosting Amazon Connect Instance
	InstanceId pulumi.StringInput `pulumi:"instanceId"`
	// Returns information on a specific Contact Flow by name
	Name pulumi.StringPtrInput `pulumi:"name"`
	// A the map of tags to assign to the Contact Flow.
	Tags pulumi.StringMapInput `pulumi:"tags"`
	// Specifies the type of Contact Flow.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

A collection of arguments for invoking getContactFlow.

func (LookupContactFlowOutputArgs) ElementType 

func (LookupContactFlowOutputArgs) ElementType() reflect.Type

type LookupContactFlowResult 

type LookupContactFlowResult struct {
	// The Amazon Resource Name (ARN) of the Contact Flow.
	Arn           string `pulumi:"arn"`
	ContactFlowId string `pulumi:"contactFlowId"`
	// Specifies the logic of the Contact Flow.
	Content string `pulumi:"content"`
	// Specifies the description of the Contact Flow.
	Description string `pulumi:"description"`
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	InstanceId string `pulumi:"instanceId"`
	Name       string `pulumi:"name"`
	// A the map of tags to assign to the Contact Flow.
	Tags map[string]string `pulumi:"tags"`
	// Specifies the type of Contact Flow.
	Type *string `pulumi:"type"`
}

A collection of values returned by getContactFlow.

func LookupContactFlow 

func LookupContactFlow(ctx *pulumi.Context, args *LookupContactFlowArgs, opts ...pulumi.InvokeOption) (*LookupContactFlowResult, error)

Provides details about a specific Amazon Connect Contact Flow.

## Example Usage

By name

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "Test"
		_, err := connect.LookupContactFlow(ctx, &connect.LookupContactFlowArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

By contactFlowId

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "cccccccc-bbbb-cccc-dddd-111111111111"
		_, err := connect.LookupContactFlow(ctx, &connect.LookupContactFlowArgs{
			ContactFlowId: &opt0,
			InstanceId:    "aaaaaaaa-bbbb-cccc-dddd-111111111111",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupContactFlowResultOutput 

type LookupContactFlowResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getContactFlow.

func LookupContactFlowOutput 

func LookupContactFlowOutput(ctx *pulumi.Context, args LookupContactFlowOutputArgs, opts ...pulumi.InvokeOption) LookupContactFlowResultOutput

func (LookupContactFlowResultOutput) Arn 

func (o LookupContactFlowResultOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the Contact Flow.

func (LookupContactFlowResultOutput) ContactFlowId 

func (o LookupContactFlowResultOutput) ContactFlowId() pulumi.StringOutput

func (LookupContactFlowResultOutput) Content 

func (o LookupContactFlowResultOutput) Content() pulumi.StringOutput

Specifies the logic of the Contact Flow.

func (LookupContactFlowResultOutput) Description 

func (o LookupContactFlowResultOutput) Description() pulumi.StringOutput

Specifies the description of the Contact Flow.

func (LookupContactFlowResultOutput) ElementType 

func (LookupContactFlowResultOutput) ElementType() reflect.Type

func (LookupContactFlowResultOutput) Id 

func (o LookupContactFlowResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupContactFlowResultOutput) InstanceId 

func (o LookupContactFlowResultOutput) InstanceId() pulumi.StringOutput

func (LookupContactFlowResultOutput) Name 

func (o LookupContactFlowResultOutput) Name() pulumi.StringOutput

func (LookupContactFlowResultOutput) Tags 

func (o LookupContactFlowResultOutput) Tags() pulumi.StringMapOutput

A the map of tags to assign to the Contact Flow.

func (LookupContactFlowResultOutput) ToLookupContactFlowResultOutput 

func (o LookupContactFlowResultOutput) ToLookupContactFlowResultOutput() LookupContactFlowResultOutput

func (LookupContactFlowResultOutput) ToLookupContactFlowResultOutputWithContext 

func (o LookupContactFlowResultOutput) ToLookupContactFlowResultOutputWithContext(ctx context.Context) LookupContactFlowResultOutput

func (LookupContactFlowResultOutput) Type 

func (o LookupContactFlowResultOutput) Type() pulumi.StringPtrOutput

Specifies the type of Contact Flow.

type LookupInstanceArgs 

type LookupInstanceArgs struct {
	// Returns information on a specific connect instance by alias
	InstanceAlias *string `pulumi:"instanceAlias"`
	// Returns information on a specific connect instance by id
	InstanceId *string `pulumi:"instanceId"`
}

A collection of arguments for invoking getInstance.

type LookupInstanceOutputArgs 

type LookupInstanceOutputArgs struct {
	// Returns information on a specific connect instance by alias
	InstanceAlias pulumi.StringPtrInput `pulumi:"instanceAlias"`
	// Returns information on a specific connect instance by id
	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
}

A collection of arguments for invoking getInstance.

func (LookupInstanceOutputArgs) ElementType 

func (LookupInstanceOutputArgs) ElementType() reflect.Type

type LookupInstanceResult 

type LookupInstanceResult struct {
	// The Amazon Resource Name (ARN) of the instance.
	Arn                          string `pulumi:"arn"`
	AutoResolveBestVoicesEnabled bool   `pulumi:"autoResolveBestVoicesEnabled"`
	// Specifies Whether contact flow logs are enabled.
	ContactFlowLogsEnabled bool `pulumi:"contactFlowLogsEnabled"`
	// Specifies Whether contact lens is enabled.
	ContactLensEnabled bool `pulumi:"contactLensEnabled"`
	// Specifies When the instance was created.
	CreatedTime string `pulumi:"createdTime"`
	// Specifies Whether early media for outbound calls is enabled .
	EarlyMediaEnabled bool `pulumi:"earlyMediaEnabled"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Specifies The identity management type attached to the instance.
	IdentityManagementType string `pulumi:"identityManagementType"`
	// Specifies Whether inbound calls are enabled.
	InboundCallsEnabled bool   `pulumi:"inboundCallsEnabled"`
	InstanceAlias       string `pulumi:"instanceAlias"`
	InstanceId          string `pulumi:"instanceId"`
	// Specifies Whether outbound calls are enabled.
	OutboundCallsEnabled bool `pulumi:"outboundCallsEnabled"`
	// The service role of the instance.
	ServiceRole string `pulumi:"serviceRole"`
	// Specifies The state of the instance.
	Status string `pulumi:"status"`
}

A collection of values returned by getInstance.

func LookupInstance 

func LookupInstance(ctx *pulumi.Context, args *LookupInstanceArgs, opts ...pulumi.InvokeOption) (*LookupInstanceResult, error)

Provides details about a specific Amazon Connect Instance.

## Example Usage

By instanceAlias

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "foo"
		_, err := connect.LookupInstance(ctx, &connect.LookupInstanceArgs{
			InstanceAlias: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

By instanceId

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/connect"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "97afc98d-101a-ba98-ab97-ae114fc115ec"
		_, err := connect.LookupInstance(ctx, &connect.LookupInstanceArgs{
			InstanceId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupInstanceResultOutput 

type LookupInstanceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getInstance.

func LookupInstanceOutput 

func LookupInstanceOutput(ctx *pulumi.Context, args LookupInstanceOutputArgs, opts ...pulumi.InvokeOption) LookupInstanceResultOutput

func (LookupInstanceResultOutput) Arn 

func (o LookupInstanceResultOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the instance.

func (LookupInstanceResultOutput) AutoResolveBestVoicesEnabled 

func (o LookupInstanceResultOutput) AutoResolveBestVoicesEnabled() pulumi.BoolOutput

func (LookupInstanceResultOutput) ContactFlowLogsEnabled 

func (o LookupInstanceResultOutput) ContactFlowLogsEnabled() pulumi.BoolOutput

Specifies Whether contact flow logs are enabled.

func (LookupInstanceResultOutput) ContactLensEnabled 

func (o LookupInstanceResultOutput) ContactLensEnabled() pulumi.BoolOutput

Specifies Whether contact lens is enabled.

func (LookupInstanceResultOutput) CreatedTime 

func (o LookupInstanceResultOutput) CreatedTime() pulumi.StringOutput

Specifies When the instance was created.

func (LookupInstanceResultOutput) EarlyMediaEnabled 

func (o LookupInstanceResultOutput) EarlyMediaEnabled() pulumi.BoolOutput

Specifies Whether early media for outbound calls is enabled .

func (LookupInstanceResultOutput) ElementType 

func (LookupInstanceResultOutput) ElementType() reflect.Type

func (LookupInstanceResultOutput) Id 

func (o LookupInstanceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupInstanceResultOutput) IdentityManagementType 

func (o LookupInstanceResultOutput) IdentityManagementType() pulumi.StringOutput

Specifies The identity management type attached to the instance.

func (LookupInstanceResultOutput) InboundCallsEnabled 

func (o LookupInstanceResultOutput) InboundCallsEnabled() pulumi.BoolOutput

Specifies Whether inbound calls are enabled.

func (LookupInstanceResultOutput) InstanceAlias 

func (o LookupInstanceResultOutput) InstanceAlias() pulumi.StringOutput

func (LookupInstanceResultOutput) InstanceId 

func (o LookupInstanceResultOutput) InstanceId() pulumi.StringOutput

func (LookupInstanceResultOutput) OutboundCallsEnabled 

func (o LookupInstanceResultOutput) OutboundCallsEnabled() pulumi.BoolOutput

Specifies Whether outbound calls are enabled.

func (LookupInstanceResultOutput) ServiceRole 

func (o LookupInstanceResultOutput) ServiceRole() pulumi.StringOutput

The service role of the instance.

func (LookupInstanceResultOutput) Status 

func (o LookupInstanceResultOutput) Status() pulumi.StringOutput

Specifies The state of the instance.

func (LookupInstanceResultOutput) ToLookupInstanceResultOutput 

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutput() LookupInstanceResultOutput

func (LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext 

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext(ctx context.Context) LookupInstanceResultOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.