@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
163 lines (162 loc) • 4.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Amazon Connect Contact Flow.
*
* ## Example Usage
*
* By name
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.connect.getContactFlow({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Test",
* });
* ```
*
* By contactFlowId
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.connect.getContactFlow({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* contactFlowId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getContactFlow(args: GetContactFlowArgs, opts?: pulumi.InvokeOptions): Promise<GetContactFlowResult>;
/**
* A collection of arguments for invoking getContactFlow.
*/
export interface GetContactFlowArgs {
/**
* Returns information on a specific Contact Flow by contact flow id
*/
contactFlowId?: string;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: string;
/**
* Returns information on a specific Contact Flow by name
*
* > **NOTE:** `instanceId` and one of either `name` or `contactFlowId` is required.
*/
name?: string;
/**
* 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?: string;
/**
* Tags to assign to the Contact Flow.
*/
tags?: {
[key: string]: string;
};
/**
* Type of Contact Flow.
*/
type?: string;
}
/**
* A collection of values returned by getContactFlow.
*/
export interface GetContactFlowResult {
/**
* ARN of the Contact Flow.
*/
readonly arn: string;
readonly contactFlowId: string;
/**
* Logic of the Contact Flow.
*/
readonly content: string;
/**
* Description of the Contact Flow.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly name: string;
readonly region: string;
/**
* Tags to assign to the Contact Flow.
*/
readonly tags: {
[key: string]: string;
};
/**
* Type of Contact Flow.
*/
readonly type?: string;
}
/**
* Provides details about a specific Amazon Connect Contact Flow.
*
* ## Example Usage
*
* By name
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.connect.getContactFlow({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Test",
* });
* ```
*
* By contactFlowId
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.connect.getContactFlow({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* contactFlowId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getContactFlowOutput(args: GetContactFlowOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetContactFlowResult>;
/**
* A collection of arguments for invoking getContactFlow.
*/
export interface GetContactFlowOutputArgs {
/**
* Returns information on a specific Contact Flow by contact flow id
*/
contactFlowId?: pulumi.Input<string>;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: pulumi.Input<string>;
/**
* Returns information on a specific Contact Flow by name
*
* > **NOTE:** `instanceId` and one of either `name` or `contactFlowId` is required.
*/
name?: pulumi.Input<string>;
/**
* 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 assign to the Contact Flow.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Type of Contact Flow.
*/
type?: pulumi.Input<string>;
}