Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Formal Provider
  4. API Docs
  5. ConnectorTokenEncryptionKey
Viewing docs for Formal v1.2.4
published on Saturday, Aug 8, 2026 by Formal
Schema (JSON)
formalco/pulumi-formal

formal.ConnectorTokenEncryptionKey

formal logo
Viewing docs for Formal v1.2.4
published on Saturday, Aug 8, 2026 by Formal
Schema (JSON)
formalco/pulumi-formal

    Register a KMS key encryption key (KEK) for HTTP policy token encryption on a Connector.

    Create ConnectorTokenEncryptionKey Resource

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

    Constructor syntax

    new ConnectorTokenEncryptionKey(name: string, args: ConnectorTokenEncryptionKeyArgs, opts?: CustomResourceOptions);
    @overload
def ConnectorTokenEncryptionKey(resource_name: str,
                                args: ConnectorTokenEncryptionKeyArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def ConnectorTokenEncryptionKey(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                connector_id: Optional[str] = None,
                                key_id: Optional[str] = None,
                                key_provider: Optional[str] = None)
    func NewConnectorTokenEncryptionKey(ctx *Context, name string, args ConnectorTokenEncryptionKeyArgs, opts ...ResourceOption) (*ConnectorTokenEncryptionKey, error)
    public ConnectorTokenEncryptionKey(string name, ConnectorTokenEncryptionKeyArgs args, CustomResourceOptions? opts = null)
    public ConnectorTokenEncryptionKey(String name, ConnectorTokenEncryptionKeyArgs args)
public ConnectorTokenEncryptionKey(String name, ConnectorTokenEncryptionKeyArgs args, CustomResourceOptions options)

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


    resource "formal_connector_token_encryption_key" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ConnectorTokenEncryptionKeyArgs
    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 ConnectorTokenEncryptionKeyArgs
    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 ConnectorTokenEncryptionKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorTokenEncryptionKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorTokenEncryptionKeyArgs
    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 connectorTokenEncryptionKeyResource = new Pulumi.ConnectorTokenEncryptionKey("connectorTokenEncryptionKeyResource", new()
{
    ConnectorId = "string",
    KeyId = "string",
    KeyProvider = "string",
});

    example, err := formal.NewConnectorTokenEncryptionKey(ctx, "connectorTokenEncryptionKeyResource", &formal.ConnectorTokenEncryptionKeyArgs{
	ConnectorId: pulumi.String("string"),
	KeyId:       pulumi.String("string"),
	KeyProvider: pulumi.String("string"),
})

    resource "formal_connector_token_encryption_key" "connectorTokenEncryptionKeyResource" {
  lifecycle {
    create_before_destroy = true
  }
  connector_id = "string"
  key_id       = "string"
  key_provider = "string"
}

    var connectorTokenEncryptionKeyResource = new ConnectorTokenEncryptionKey("connectorTokenEncryptionKeyResource", ConnectorTokenEncryptionKeyArgs.builder()
    .connectorId("string")
    .keyId("string")
    .keyProvider("string")
    .build());

    connector_token_encryption_key_resource = formal.ConnectorTokenEncryptionKey("connectorTokenEncryptionKeyResource",
    connector_id="string",
    key_id="string",
    key_provider="string")

    const connectorTokenEncryptionKeyResource = new formal.ConnectorTokenEncryptionKey("connectorTokenEncryptionKeyResource", {
    connectorId: "string",
    keyId: "string",
    keyProvider: "string",
});

    type: formal:ConnectorTokenEncryptionKey
properties:
    connectorId: string
    keyId: string
    keyProvider: string

    ConnectorTokenEncryptionKey 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 ConnectorTokenEncryptionKey resource accepts the following input properties:

    ConnectorId string
    The ID of the Connector this token encryption key is linked to.
    KeyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    KeyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    ConnectorId string
    The ID of the Connector this token encryption key is linked to.
    KeyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    KeyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    connector_id string
    The ID of the Connector this token encryption key is linked to.
    key_id string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    key_provider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    connectorId String
    The ID of the Connector this token encryption key is linked to.
    keyId String
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider String
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    connectorId string
    The ID of the Connector this token encryption key is linked to.
    keyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    connector_id str
    The ID of the Connector this token encryption key is linked to.
    key_id str
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    key_provider str
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    connectorId String
    The ID of the Connector this token encryption key is linked to.
    keyId String
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider String
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.

    Outputs

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

    CreatedAt string
    When the connector token encryption key was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    CreatedAt string
    When the connector token encryption key was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Last update time.
    created_at string
    When the connector token encryption key was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    Last update time.
    createdAt String
    When the connector token encryption key was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.
    createdAt string
    When the connector token 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 connector token 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 connector token encryption key was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Last update time.

    Look up Existing ConnectorTokenEncryptionKey Resource

    Get an existing ConnectorTokenEncryptionKey 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?: ConnectorTokenEncryptionKeyState, opts?: CustomResourceOptions): ConnectorTokenEncryptionKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connector_id: Optional[str] = None,
        created_at: Optional[str] = None,
        key_id: Optional[str] = None,
        key_provider: Optional[str] = None,
        updated_at: Optional[str] = None) -> ConnectorTokenEncryptionKey
    func GetConnectorTokenEncryptionKey(ctx *Context, name string, id IDInput, state *ConnectorTokenEncryptionKeyState, opts ...ResourceOption) (*ConnectorTokenEncryptionKey, error)
    public static ConnectorTokenEncryptionKey Get(string name, Input<string> id, ConnectorTokenEncryptionKeyState? state, CustomResourceOptions? opts = null)
    public static ConnectorTokenEncryptionKey get(String name, Output<String> id, ConnectorTokenEncryptionKeyState state, CustomResourceOptions options)
    resources:  _:    type: formal:ConnectorTokenEncryptionKey    get:      id: ${id}
    import {
  to = formal_connector_token_encryption_key.example
  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:
    ConnectorId string
    The ID of the Connector this token encryption key is linked to.
    CreatedAt string
    When the connector token encryption key was created.
    KeyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    KeyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    UpdatedAt string
    Last update time.
    ConnectorId string
    The ID of the Connector this token encryption key is linked to.
    CreatedAt string
    When the connector token encryption key was created.
    KeyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    KeyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    UpdatedAt string
    Last update time.
    connector_id string
    The ID of the Connector this token encryption key is linked to.
    created_at string
    When the connector token encryption key was created.
    key_id string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    key_provider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    updated_at string
    Last update time.
    connectorId String
    The ID of the Connector this token encryption key is linked to.
    createdAt String
    When the connector token encryption key was created.
    keyId String
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider String
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    updatedAt String
    Last update time.
    connectorId string
    The ID of the Connector this token encryption key is linked to.
    createdAt string
    When the connector token encryption key was created.
    keyId string
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider string
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    updatedAt string
    Last update time.
    connector_id str
    The ID of the Connector this token encryption key is linked to.
    created_at str
    When the connector token encryption key was created.
    key_id str
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    key_provider str
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    updated_at str
    Last update time.
    connectorId String
    The ID of the Connector this token encryption key is linked to.
    createdAt String
    When the connector token encryption key was created.
    keyId String
    Provider-native key identifier (AWS KMS ARN, GCP CryptoKey resource name, or Azure Key Vault key URI).
    keyProvider String
    The KMS provider. One of 'aws-kms', 'gcp-kms', or 'azure-key-vault'.
    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 logo
    Viewing docs for Formal v1.2.4
    published on Saturday, Aug 8, 2026 by Formal
    Schema (JSON)
    formalco/pulumi-formal

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial