Formal v1.0.3, Aug 18 25

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.EncryptionKey

Explore with Pulumi AI

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

Create EncryptionKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EncryptionKey(name: string, args: EncryptionKeyArgs, opts?: CustomResourceOptions);

@overload
def EncryptionKey(resource_name: str,
                  args: EncryptionKeyArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def EncryptionKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  algorithm: Optional[str] = None,
                  decryptor_uri: Optional[str] = None,
                  key_id: Optional[str] = None,
                  key_provider: Optional[str] = None)

func NewEncryptionKey(ctx *Context, name string, args EncryptionKeyArgs, opts ...ResourceOption) (*EncryptionKey, error)

public EncryptionKey(string name, EncryptionKeyArgs args, CustomResourceOptions? opts = null)

public EncryptionKey(String name, EncryptionKeyArgs args)
public EncryptionKey(String name, EncryptionKeyArgs args, CustomResourceOptions options)

type: formal:EncryptionKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args EncryptionKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EncryptionKeyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EncryptionKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EncryptionKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EncryptionKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var encryptionKeyResource = new Pulumi.EncryptionKey("encryptionKeyResource", new()
{
    Algorithm = "string",
    DecryptorUri = "string",
    KeyId = "string",
    KeyProvider = "string",
});

example, err := formal.NewEncryptionKey(ctx, "encryptionKeyResource", &formal.EncryptionKeyArgs{
	Algorithm:    pulumi.String("string"),
	DecryptorUri: pulumi.String("string"),
	KeyId:        pulumi.String("string"),
	KeyProvider:  pulumi.String("string"),
})

var encryptionKeyResource = new EncryptionKey("encryptionKeyResource", EncryptionKeyArgs.builder()
    .algorithm("string")
    .decryptorUri("string")
    .keyId("string")
    .keyProvider("string")
    .build());

encryption_key_resource = formal.EncryptionKey("encryptionKeyResource",
    algorithm="string",
    decryptor_uri="string",
    key_id="string",
    key_provider="string")

const encryptionKeyResource = new formal.EncryptionKey("encryptionKeyResource", {
    algorithm: "string",
    decryptorUri: "string",
    keyId: "string",
    keyProvider: "string",
});

type: formal:EncryptionKey
properties:
    algorithm: string
    decryptorUri: string
    keyId: string
    keyProvider: string

EncryptionKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EncryptionKey resource accepts the following input properties:

Algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
DecryptorUri 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).
KeyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
KeyProvider string: The provider of the encryption key. Currently only 'aws' is supported.

Algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
DecryptorUri 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).
KeyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
KeyProvider string: The provider of the encryption key. Currently only 'aws' is supported.

algorithm String: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
decryptorUri 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).
keyId String: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider String: The provider of the encryption key. Currently only 'aws' is supported.

algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
decryptorUri 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).
keyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider string: The provider of the encryption key. Currently only 'aws' is supported.

algorithm str: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
decryptor_uri str: 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).
key_id str: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
key_provider str: The provider of the encryption key. Currently only 'aws' is supported.

algorithm String: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
decryptorUri 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).
keyId String: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider String: The provider of the encryption key. Currently only 'aws' is supported.

Outputs

All input properties are implicitly available as output properties. Additionally, the EncryptionKey resource produces the following output properties:

CreatedAt string: When the encryption key was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last update time.

CreatedAt string: When the encryption key was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last update time.

createdAt String: When the encryption key was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last update time.

createdAt string: When the encryption key was created.
id string: The provider-assigned unique ID for this managed resource.
updatedAt string: Last update time.

created_at str: When the encryption key was created.
id str: The provider-assigned unique ID for this managed resource.
updated_at str: Last update time.

createdAt String: When the encryption key was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last update time.

Look up Existing EncryptionKey Resource

Get an existing EncryptionKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EncryptionKeyState, opts?: CustomResourceOptions): EncryptionKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        created_at: Optional[str] = None,
        decryptor_uri: Optional[str] = None,
        key_id: Optional[str] = None,
        key_provider: Optional[str] = None,
        updated_at: Optional[str] = None) -> EncryptionKey

func GetEncryptionKey(ctx *Context, name string, id IDInput, state *EncryptionKeyState, opts ...ResourceOption) (*EncryptionKey, error)

public static EncryptionKey Get(string name, Input<string> id, EncryptionKeyState? state, CustomResourceOptions? opts = null)

public static EncryptionKey get(String name, Output<String> id, EncryptionKeyState state, CustomResourceOptions options)

resources:  _:    type: formal:EncryptionKey    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
CreatedAt string: When the encryption key was created.
DecryptorUri 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).
KeyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
KeyProvider string: The provider of the encryption key. Currently only 'aws' is supported.
UpdatedAt string: Last update time.

Algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
CreatedAt string: When the encryption key was created.
DecryptorUri 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).
KeyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
KeyProvider string: The provider of the encryption key. Currently only 'aws' is supported.
UpdatedAt string: Last update time.

algorithm String: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
createdAt String: When the encryption key was created.
decryptorUri 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).
keyId String: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider String: The provider of the encryption key. Currently only 'aws' is supported.
updatedAt String: Last update time.

algorithm string: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
createdAt string: When the encryption key was created.
decryptorUri 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).
keyId string: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider string: The provider of the encryption key. Currently only 'aws' is supported.
updatedAt string: Last update time.

algorithm str: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
created_at str: When the encryption key was created.
decryptor_uri str: 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).
key_id str: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
key_provider str: The provider of the encryption key. Currently only 'aws' is supported.
updated_at str: Last update time.

algorithm String: The algorithm used for encryption. Can be either 'aesrandom' or 'aesdeterministic'.
createdAt String: When the encryption key was created.
decryptorUri 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).
keyId String: The ID of the key in the provider's system (e.g., key ARN for AWS KMS).
keyProvider String: The provider of the encryption key. Currently only 'aws' is supported.
updatedAt String: Last update time.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formalco/pulumi-formal

formal.EncryptionKey

On this page

On this page

Create EncryptionKey Resource

Constructor syntax

Parameters

Constructor example

EncryptionKey Resource Properties

Inputs

Outputs

Look up Existing EncryptionKey Resource

Package Details

On this page

On this page