@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
223 lines (222 loc) • 9.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides an Amazon Connect Routing Profile resource. For more information see
* [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.connect.RoutingProfile("example", {
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "example",
* defaultOutboundQueueId: "12345678-1234-1234-1234-123456789012",
* description: "example description",
* mediaConcurrencies: [
* {
* channel: "VOICE",
* concurrency: 1,
* crossChannelBehavior: {
* behaviorType: "ROUTE_ANY_CHANNEL",
* },
* },
* {
* channel: "CHAT",
* concurrency: 3,
* crossChannelBehavior: {
* behaviorType: "ROUTE_CURRENT_CHANNEL_ONLY",
* },
* },
* ],
* queueConfigs: [{
* channel: "VOICE",
* delay: 2,
* priority: 1,
* queueId: "12345678-1234-1234-1234-123456789012",
* }],
* tags: {
* Name: "Example Routing Profile",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Amazon Connect Routing Profiles using the `instance_id` and `routing_profile_id` separated by a colon (`:`). For example:
*
* ```sh
* $ pulumi import aws:connect/routingProfile:RoutingProfile example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
* ```
*/
export declare class RoutingProfile extends pulumi.CustomResource {
/**
* Get an existing RoutingProfile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RoutingProfileState, opts?: pulumi.CustomResourceOptions): RoutingProfile;
/**
* Returns true if the given object is an instance of RoutingProfile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RoutingProfile;
/**
* Amazon Resource Name (ARN) of the Routing Profile.
*/
readonly arn: pulumi.Output<string>;
/**
* Specifies the default outbound queue for the Routing Profile.
*/
readonly defaultOutboundQueueId: pulumi.Output<string>;
/**
* Specifies the description of the Routing Profile.
*/
readonly description: pulumi.Output<string>;
/**
* Specifies the identifier of the hosting Amazon Connect Instance.
*/
readonly instanceId: pulumi.Output<string>;
/**
* One or more `mediaConcurrencies` blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The `mediaConcurrencies` block is documented below.
*/
readonly mediaConcurrencies: pulumi.Output<outputs.connect.RoutingProfileMediaConcurrency[]>;
/**
* Specifies the name of the Routing Profile.
*/
readonly name: pulumi.Output<string>;
/**
* One or more `queueConfigs` blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The `queueConfigs` block is documented below.
*/
readonly queueConfigs: pulumi.Output<outputs.connect.RoutingProfileQueueConfig[] | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Identifier for the Routing Profile.
*/
readonly routingProfileId: pulumi.Output<string>;
/**
* Tags to apply to the Routing Profile. If configured with a provider
* `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a RoutingProfile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RoutingProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RoutingProfile resources.
*/
export interface RoutingProfileState {
/**
* Amazon Resource Name (ARN) of the Routing Profile.
*/
arn?: pulumi.Input<string>;
/**
* Specifies the default outbound queue for the Routing Profile.
*/
defaultOutboundQueueId?: pulumi.Input<string>;
/**
* Specifies the description of the Routing Profile.
*/
description?: pulumi.Input<string>;
/**
* Specifies the identifier of the hosting Amazon Connect Instance.
*/
instanceId?: pulumi.Input<string>;
/**
* One or more `mediaConcurrencies` blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The `mediaConcurrencies` block is documented below.
*/
mediaConcurrencies?: pulumi.Input<pulumi.Input<inputs.connect.RoutingProfileMediaConcurrency>[]>;
/**
* Specifies the name of the Routing Profile.
*/
name?: pulumi.Input<string>;
/**
* One or more `queueConfigs` blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The `queueConfigs` block is documented below.
*/
queueConfigs?: pulumi.Input<pulumi.Input<inputs.connect.RoutingProfileQueueConfig>[]>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Identifier for the Routing Profile.
*/
routingProfileId?: pulumi.Input<string>;
/**
* Tags to apply to the Routing Profile. If configured with a provider
* `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a RoutingProfile resource.
*/
export interface RoutingProfileArgs {
/**
* Specifies the default outbound queue for the Routing Profile.
*/
defaultOutboundQueueId: pulumi.Input<string>;
/**
* Specifies the description of the Routing Profile.
*/
description: pulumi.Input<string>;
/**
* Specifies the identifier of the hosting Amazon Connect Instance.
*/
instanceId: pulumi.Input<string>;
/**
* One or more `mediaConcurrencies` blocks that specify the channels that agents can handle in the Contact Control Panel (CCP) for this Routing Profile. The `mediaConcurrencies` block is documented below.
*/
mediaConcurrencies: pulumi.Input<pulumi.Input<inputs.connect.RoutingProfileMediaConcurrency>[]>;
/**
* Specifies the name of the Routing Profile.
*/
name?: pulumi.Input<string>;
/**
* One or more `queueConfigs` blocks that specify the inbound queues associated with the routing profile. If no queue is added, the agent only can make outbound calls. The `queueConfigs` block is documented below.
*/
queueConfigs?: pulumi.Input<pulumi.Input<inputs.connect.RoutingProfileQueueConfig>[]>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Tags to apply to the Routing Profile. If configured with a provider
* `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}