@formalco/pulumi
Version:
A Pulumi package for creating and managing Formal resources.
104 lines (103 loc) • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Registering an Encryption Key with Formal.
*/
export declare class EncryptionKey extends pulumi.CustomResource {
/**
* Get an existing EncryptionKey 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?: EncryptionKeyState, opts?: pulumi.CustomResourceOptions): EncryptionKey;
/**
* Returns true if the given object is an instance of EncryptionKey. 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 EncryptionKey;
/**
* The algorithm used for encryption. Can be either 'aes*random' or 'aes*deterministic'.
*/
readonly algorithm: pulumi.Output<string>;
/**
* When the encryption key was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The URI of the decryptor (e.g., a URL to a Lambda function, either directly or via API Gateway). This is used to decrypt the data on the frontend only (and is never called by the Formal Control Plane backend).
*/
readonly decryptorUri: pulumi.Output<string>;
/**
* The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
*/
readonly keyId: pulumi.Output<string>;
/**
* The provider of the encryption key. Currently only 'aws' is supported.
*/
readonly keyProvider: pulumi.Output<string>;
/**
* Last update time.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a EncryptionKey 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: EncryptionKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EncryptionKey resources.
*/
export interface EncryptionKeyState {
/**
* The algorithm used for encryption. Can be either 'aes*random' or 'aes*deterministic'.
*/
algorithm?: pulumi.Input<string>;
/**
* When the encryption key was created.
*/
createdAt?: pulumi.Input<string>;
/**
* The URI of the decryptor (e.g., a URL to a Lambda function, either directly or via API Gateway). This is used to decrypt the data on the frontend only (and is never called by the Formal Control Plane backend).
*/
decryptorUri?: pulumi.Input<string>;
/**
* The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
*/
keyId?: pulumi.Input<string>;
/**
* The provider of the encryption key. Currently only 'aws' is supported.
*/
keyProvider?: pulumi.Input<string>;
/**
* Last update time.
*/
updatedAt?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a EncryptionKey resource.
*/
export interface EncryptionKeyArgs {
/**
* The algorithm used for encryption. Can be either 'aes*random' or 'aes*deterministic'.
*/
algorithm: pulumi.Input<string>;
/**
* The URI of the decryptor (e.g., a URL to a Lambda function, either directly or via API Gateway). This is used to decrypt the data on the frontend only (and is never called by the Formal Control Plane backend).
*/
decryptorUri: pulumi.Input<string>;
/**
* The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
*/
keyId: pulumi.Input<string>;
/**
* The provider of the encryption key. Currently only 'aws' is supported.
*/
keyProvider: pulumi.Input<string>;
}