@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
155 lines (154 loc) • 4.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Amazon Connect Security Profile.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getSecurityProfile({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* });
* ```
*
* By `securityProfileId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getSecurityProfile({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* securityProfileId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getSecurityProfile(args: GetSecurityProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetSecurityProfileResult>;
/**
* A collection of arguments for invoking getSecurityProfile.
*/
export interface GetSecurityProfileArgs {
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: string;
/**
* Returns information on a specific Security Profile by name
*
* > **NOTE:** `instanceId` and one of either `name` or `securityProfileId` 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;
/**
* Returns information on a specific Security Profile by Security Profile id
*/
securityProfileId?: string;
/**
* Map of tags to assign to the Security Profile.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getSecurityProfile.
*/
export interface GetSecurityProfileResult {
/**
* ARN of the Security Profile.
*/
readonly arn: string;
/**
* Description of the Security Profile.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly instanceId: string;
readonly name: string;
/**
* The organization resource identifier for the security profile.
*/
readonly organizationResourceId: string;
/**
* List of permissions assigned to the security profile.
*/
readonly permissions: string[];
readonly region: string;
readonly securityProfileId: string;
/**
* Map of tags to assign to the Security Profile.
*/
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about a specific Amazon Connect Security Profile.
*
* ## Example Usage
*
* By `name`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getSecurityProfile({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* name: "Example",
* });
* ```
*
* By `securityProfileId`
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.connect.getSecurityProfile({
* instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
* securityProfileId: "cccccccc-bbbb-cccc-dddd-111111111111",
* });
* ```
*/
export declare function getSecurityProfileOutput(args: GetSecurityProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSecurityProfileResult>;
/**
* A collection of arguments for invoking getSecurityProfile.
*/
export interface GetSecurityProfileOutputArgs {
/**
* Reference to the hosting Amazon Connect Instance
*/
instanceId: pulumi.Input<string>;
/**
* Returns information on a specific Security Profile by name
*
* > **NOTE:** `instanceId` and one of either `name` or `securityProfileId` 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>;
/**
* Returns information on a specific Security Profile by Security Profile id
*/
securityProfileId?: pulumi.Input<string>;
/**
* Map of tags to assign to the Security Profile.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}