@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
69 lines (68 loc) • 2.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Definition of AWS::Location::APIKey Resource Type
*/
export declare function getApiKey(args: GetApiKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetApiKeyResult>;
export interface GetApiKeyArgs {
/**
* A custom name for the API key resource.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique API key name.
* - No spaces allowed. For example, `ExampleAPIKey` .
*/
keyName: string;
}
export interface GetApiKeyResult {
/**
* The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
*/
readonly arn?: string;
/**
* The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
*/
readonly createTime?: string;
/**
* Updates the description for the API key resource.
*/
readonly description?: string;
/**
* The optional timestamp for when the API key resource will expire in [ISO 8601 format](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) .
*/
readonly expireTime?: string;
/**
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
*/
readonly keyArn?: string;
/**
* The API key restrictions for the API key resource.
*/
readonly restrictions?: outputs.location.ApiKeyRestrictions;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags?: outputs.Tag[];
/**
* The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly updateTime?: string;
}
/**
* Definition of AWS::Location::APIKey Resource Type
*/
export declare function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiKeyResult>;
export interface GetApiKeyOutputArgs {
/**
* A custom name for the API key resource.
*
* Requirements:
*
* - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
* - Must be a unique API key name.
* - No spaces allowed. For example, `ExampleAPIKey` .
*/
keyName: pulumi.Input<string>;
}