@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
171 lines (170 loc) • 4.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Amazon Connect Instance.
*
* ## Example Usage
*
* By instanceAlias
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.connect.getInstance({
* instanceAlias: "foo",
* });
* ```
*
* By instanceId
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.connect.getInstance({
* instanceId: "97afc98d-101a-ba98-ab97-ae114fc115ec",
* });
* ```
*/
export declare function getInstance(args?: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceResult>;
/**
* A collection of arguments for invoking getInstance.
*/
export interface GetInstanceArgs {
/**
* Returns information on a specific connect instance by alias
*
* > **NOTE:** One of either `instanceId` or `instanceAlias` is required.
*/
instanceAlias?: string;
/**
* Returns information on a specific connect instance by id
*/
instanceId?: 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;
/**
* A map of tags to assigned to the instance.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getInstance.
*/
export interface GetInstanceResult {
/**
* ARN of the instance.
*/
readonly arn: string;
readonly autoResolveBestVoicesEnabled: boolean;
/**
* Whether contact flow logs are enabled.
*/
readonly contactFlowLogsEnabled: boolean;
/**
* Whether contact lens is enabled.
*/
readonly contactLensEnabled: boolean;
/**
* When the instance was created.
*/
readonly createdTime: string;
/**
* Whether early media for outbound calls is enabled .
*/
readonly earlyMediaEnabled: boolean;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Specifies The identity management type attached to the instance.
*/
readonly identityManagementType: string;
/**
* Whether inbound calls are enabled.
*/
readonly inboundCallsEnabled: boolean;
readonly instanceAlias: string;
readonly instanceId: string;
/**
* Whether multi-party calls/conference is enabled.
*/
readonly multiPartyConferenceEnabled: boolean;
/**
* Whether outbound calls are enabled.
*/
readonly outboundCallsEnabled: boolean;
readonly region: string;
/**
* Service role of the instance.
*/
readonly serviceRole: string;
/**
* State of the instance.
*/
readonly status: string;
/**
* A map of tags to assigned to the instance.
*/
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about a specific Amazon Connect Instance.
*
* ## Example Usage
*
* By instanceAlias
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.connect.getInstance({
* instanceAlias: "foo",
* });
* ```
*
* By instanceId
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.connect.getInstance({
* instanceId: "97afc98d-101a-ba98-ab97-ae114fc115ec",
* });
* ```
*/
export declare function getInstanceOutput(args?: GetInstanceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInstanceResult>;
/**
* A collection of arguments for invoking getInstance.
*/
export interface GetInstanceOutputArgs {
/**
* Returns information on a specific connect instance by alias
*
* > **NOTE:** One of either `instanceId` or `instanceAlias` is required.
*/
instanceAlias?: pulumi.Input<string>;
/**
* Returns information on a specific connect instance by id
*/
instanceId?: 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>;
/**
* A map of tags to assigned to the instance.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}