@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
185 lines (184 loc) • 7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an API Gateway API Key.
*
* > **NOTE:** Since the API Gateway usage plans feature was launched on August 11, 2016, usage plans are now **required** to associate an API key with an API stage.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.apigateway.ApiKey("example", {name: "example"});
* ```
*
* ## Import
*
* Using `pulumi import`, import API Gateway Keys using the `id`. For example:
*
* ```sh
* $ pulumi import aws:apigateway/apiKey:ApiKey example 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk
* ```
*/
export declare class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey;
/**
* Returns true if the given object is an instance of ApiKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ApiKey;
/**
* ARN
*/
readonly arn: pulumi.Output<string>;
/**
* Creation date of the API key
*/
readonly createdDate: pulumi.Output<string>;
/**
* An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*/
readonly customerId: pulumi.Output<string | undefined>;
/**
* API key description. Defaults to "Managed by Pulumi".
*/
readonly description: pulumi.Output<string>;
/**
* Whether the API key can be used by callers. Defaults to `true`.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* Last update date of the API key
*/
readonly lastUpdatedDate: pulumi.Output<string>;
/**
* Name of the API key.
*/
readonly name: pulumi.Output<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.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*/
readonly value: pulumi.Output<string>;
/**
* Create a ApiKey resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
/**
* ARN
*/
arn?: pulumi.Input<string>;
/**
* Creation date of the API key
*/
createdDate?: pulumi.Input<string>;
/**
* An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*/
customerId?: pulumi.Input<string>;
/**
* API key description. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* Whether the API key can be used by callers. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Last update date of the API key
*/
lastUpdatedDate?: pulumi.Input<string>;
/**
* Name of the API key.
*/
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>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*/
value?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
/**
* An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
*/
customerId?: pulumi.Input<string>;
/**
* API key description. Defaults to "Managed by Pulumi".
*/
description?: pulumi.Input<string>;
/**
* Whether the API key can be used by callers. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Name of the API key.
*/
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>;
/**
* Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Value of the API key. If specified, the value must be an alphanumeric string between 20 and 128 characters. If not specified, it will be automatically generated by AWS on creation.
*/
value?: pulumi.Input<string>;
}