@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)
138 lines (137 loc) • 5.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Definition of AWS::Location::APIKey Resource Type
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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;
/**
* The Amazon Resource Name (ARN) for the resource. Used when you need to specify a resource across all AWS .
*/
readonly arn: pulumi.Output<string>;
/**
* The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
*/
readonly createTime: pulumi.Output<string>;
/**
* Updates the description for the API key resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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: pulumi.Output<string | undefined>;
/**
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter `true` to delete the key or to `false` to not preemptively delete the API key.
*
* Valid values: `true` , or `false` .
*
* > This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*/
readonly forceDelete: pulumi.Output<boolean | undefined>;
/**
* The boolean flag to be included for updating `ExpireTime` or Restrictions details.
* Must be set to `true` to update an API key resource that has been used in the past 7 days. `False` if force update is not preferred.
*/
readonly forceUpdate: pulumi.Output<boolean | undefined>;
/**
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all AWS .
*/
readonly keyArn: pulumi.Output<string>;
/**
* 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` .
*/
readonly keyName: pulumi.Output<string>;
/**
* Whether the API key should expire. Set to `true` to set the API key to have no expiration time.
*/
readonly noExpiry: pulumi.Output<boolean | undefined>;
/**
* The API key restrictions for the API key resource.
*/
readonly restrictions: pulumi.Output<outputs.location.ApiKeyRestrictions>;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The timestamp for when the API key resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
*/
readonly updateTime: 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);
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
/**
* Updates the description for the API key resource.
*/
description?: pulumi.Input<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) .
*/
expireTime?: pulumi.Input<string>;
/**
* ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter `true` to delete the key or to `false` to not preemptively delete the API key.
*
* Valid values: `true` , or `false` .
*
* > This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.
*/
forceDelete?: pulumi.Input<boolean>;
/**
* The boolean flag to be included for updating `ExpireTime` or Restrictions details.
* Must be set to `true` to update an API key resource that has been used in the past 7 days. `False` if force update is not preferred.
*/
forceUpdate?: pulumi.Input<boolean>;
/**
* 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>;
/**
* Whether the API key should expire. Set to `true` to set the API key to have no expiration time.
*/
noExpiry?: pulumi.Input<boolean>;
/**
* The API key restrictions for the API key resource.
*/
restrictions: pulumi.Input<inputs.location.ApiKeyRestrictionsArgs>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}