@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
159 lines (158 loc) • 4.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Amazon Connect Contact Flow Module.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getContactFlowModule({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "example",
* });
* ```
*
* By `contactFlowModuleId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getContactFlowModule({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* contactFlowModuleId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getContactFlowModule(args: GetContactFlowModuleArgs, opts?: pulumi.InvokeOptions): Promise<GetContactFlowModuleResult>;
/**
* A collection of arguments for invoking getContactFlowModule.
*/
export interface GetContactFlowModuleArgs {
/**
* Returns information on a specific Contact Flow Module by contact flow module id
*/
contactFlowModuleId?: string;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: string;
/**
* Returns information on a specific Contact Flow Module by name
*
* > **NOTE:** `instanceId` and one of either `name` or `contactFlowModuleId` 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;
/**
* Map of tags to assign to the Contact Flow Module.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getContactFlowModule.
*/
export interface GetContactFlowModuleResult {
/**
* ARN of the Contact Flow Module.
*/
readonly arn: string;
readonly contactFlowModuleId: string;
/**
* Logic of the Contact Flow Module.
*/
readonly content: string;
/**
* Description of the Contact Flow Module.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly name: string;
readonly region: string;
/**
* Type of Contact Flow Module Module. Values are either `ACTIVE` or `ARCHIVED`.
*/
readonly state: string;
/**
* Status of the Contact Flow Module Module. Values are either `PUBLISHED` or `SAVED`.
*/
readonly status: string;
/**
* Map of tags to assign to the Contact Flow Module.
*/
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about a specific Amazon Connect Contact Flow Module.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getContactFlowModule({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "example",
* });
* ```
*
* By `contactFlowModuleId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getContactFlowModule({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* contactFlowModuleId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getContactFlowModuleOutput(args: GetContactFlowModuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetContactFlowModuleResult>;
/**
* A collection of arguments for invoking getContactFlowModule.
*/
export interface GetContactFlowModuleOutputArgs {
/**
* Returns information on a specific Contact Flow Module by contact flow module id
*/
contactFlowModuleId?: pulumi.Input<string>;
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: pulumi.Input<string>;
/**
* Returns information on a specific Contact Flow Module by name
*
* > **NOTE:** `instanceId` and one of either `name` or `contactFlowModuleId` 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>;
/**
* Map of tags to assign to the Contact Flow Module.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}