Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. EncryptionKeyManager
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.EncryptionKeyManager

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    Resource to allow the rekeying of your tenant master key.

    Create EncryptionKeyManager Resource

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

    Constructor syntax

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

@overload
def EncryptionKeyManager(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         customer_provided_root_key: Optional[EncryptionKeyManagerCustomerProvidedRootKeyArgs] = None,
                         key_rotation_id: Optional[str] = None)
    func NewEncryptionKeyManager(ctx *Context, name string, args *EncryptionKeyManagerArgs, opts ...ResourceOption) (*EncryptionKeyManager, error)
    public EncryptionKeyManager(string name, EncryptionKeyManagerArgs? args = null, CustomResourceOptions? opts = null)
    public EncryptionKeyManager(String name, EncryptionKeyManagerArgs args)
public EncryptionKeyManager(String name, EncryptionKeyManagerArgs args, CustomResourceOptions options)

    type: auth0:EncryptionKeyManager
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 EncryptionKeyManagerArgs
    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 EncryptionKeyManagerArgs
    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 EncryptionKeyManagerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EncryptionKeyManagerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EncryptionKeyManagerArgs
    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 encryptionKeyManagerResource = new Auth0.EncryptionKeyManager("encryptionKeyManagerResource", new()
{
    CustomerProvidedRootKey = new Auth0.Inputs.EncryptionKeyManagerCustomerProvidedRootKeyArgs
    {
        CreatedAt = "string",
        KeyId = "string",
        ParentKeyId = "string",
        PublicWrappingKey = "string",
        State = "string",
        Type = "string",
        UpdatedAt = "string",
        WrappedKey = "string",
        WrappingAlgorithm = "string",
    },
    KeyRotationId = "string",
});

    example, err := auth0.NewEncryptionKeyManager(ctx, "encryptionKeyManagerResource", &auth0.EncryptionKeyManagerArgs{
	CustomerProvidedRootKey: &auth0.EncryptionKeyManagerCustomerProvidedRootKeyArgs{
		CreatedAt:         pulumi.String("string"),
		KeyId:             pulumi.String("string"),
		ParentKeyId:       pulumi.String("string"),
		PublicWrappingKey: pulumi.String("string"),
		State:             pulumi.String("string"),
		Type:              pulumi.String("string"),
		UpdatedAt:         pulumi.String("string"),
		WrappedKey:        pulumi.String("string"),
		WrappingAlgorithm: pulumi.String("string"),
	},
	KeyRotationId: pulumi.String("string"),
})

    var encryptionKeyManagerResource = new EncryptionKeyManager("encryptionKeyManagerResource", EncryptionKeyManagerArgs.builder()
    .customerProvidedRootKey(EncryptionKeyManagerCustomerProvidedRootKeyArgs.builder()
        .createdAt("string")
        .keyId("string")
        .parentKeyId("string")
        .publicWrappingKey("string")
        .state("string")
        .type("string")
        .updatedAt("string")
        .wrappedKey("string")
        .wrappingAlgorithm("string")
        .build())
    .keyRotationId("string")
    .build());

    encryption_key_manager_resource = auth0.EncryptionKeyManager("encryptionKeyManagerResource",
    customer_provided_root_key={
        "created_at": "string",
        "key_id": "string",
        "parent_key_id": "string",
        "public_wrapping_key": "string",
        "state": "string",
        "type": "string",
        "updated_at": "string",
        "wrapped_key": "string",
        "wrapping_algorithm": "string",
    },
    key_rotation_id="string")

    const encryptionKeyManagerResource = new auth0.EncryptionKeyManager("encryptionKeyManagerResource", {
    customerProvidedRootKey: {
        createdAt: "string",
        keyId: "string",
        parentKeyId: "string",
        publicWrappingKey: "string",
        state: "string",
        type: "string",
        updatedAt: "string",
        wrappedKey: "string",
        wrappingAlgorithm: "string",
    },
    keyRotationId: "string",
});

    type: auth0:EncryptionKeyManager
properties:
    customerProvidedRootKey:
        createdAt: string
        keyId: string
        parentKeyId: string
        publicWrappingKey: string
        state: string
        type: string
        updatedAt: string
        wrappedKey: string
        wrappingAlgorithm: string
    keyRotationId: string

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

    CustomerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    KeyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    CustomerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKeyArgs
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    KeyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    keyRotationId String
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    keyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customer_provided_root_key EncryptionKeyManagerCustomerProvidedRootKeyArgs
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    key_rotation_id str
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey Property Map
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    keyRotationId String
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.

    Outputs

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

    EncryptionKeys List<EncryptionKeyManagerEncryptionKey>
    All encryption keys.
    Id string
    The provider-assigned unique ID for this managed resource.
    EncryptionKeys []EncryptionKeyManagerEncryptionKey
    All encryption keys.
    Id string
    The provider-assigned unique ID for this managed resource.
    encryptionKeys List<EncryptionKeyManagerEncryptionKey>
    All encryption keys.
    id String
    The provider-assigned unique ID for this managed resource.
    encryptionKeys EncryptionKeyManagerEncryptionKey[]
    All encryption keys.
    id string
    The provider-assigned unique ID for this managed resource.
    encryption_keys Sequence[EncryptionKeyManagerEncryptionKey]
    All encryption keys.
    id str
    The provider-assigned unique ID for this managed resource.
    encryptionKeys List<Property Map>
    All encryption keys.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EncryptionKeyManager Resource

    Get an existing EncryptionKeyManager 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?: EncryptionKeyManagerState, opts?: CustomResourceOptions): EncryptionKeyManager
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer_provided_root_key: Optional[EncryptionKeyManagerCustomerProvidedRootKeyArgs] = None,
        encryption_keys: Optional[Sequence[EncryptionKeyManagerEncryptionKeyArgs]] = None,
        key_rotation_id: Optional[str] = None) -> EncryptionKeyManager
    func GetEncryptionKeyManager(ctx *Context, name string, id IDInput, state *EncryptionKeyManagerState, opts ...ResourceOption) (*EncryptionKeyManager, error)
    public static EncryptionKeyManager Get(string name, Input<string> id, EncryptionKeyManagerState? state, CustomResourceOptions? opts = null)
    public static EncryptionKeyManager get(String name, Output<String> id, EncryptionKeyManagerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CustomerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    EncryptionKeys List<EncryptionKeyManagerEncryptionKey>
    All encryption keys.
    KeyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    CustomerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKeyArgs
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    EncryptionKeys []EncryptionKeyManagerEncryptionKeyArgs
    All encryption keys.
    KeyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    encryptionKeys List<EncryptionKeyManagerEncryptionKey>
    All encryption keys.
    keyRotationId String
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey EncryptionKeyManagerCustomerProvidedRootKey
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    encryptionKeys EncryptionKeyManagerEncryptionKey[]
    All encryption keys.
    keyRotationId string
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customer_provided_root_key EncryptionKeyManagerCustomerProvidedRootKeyArgs
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    encryption_keys Sequence[EncryptionKeyManagerEncryptionKeyArgs]
    All encryption keys.
    key_rotation_id str
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.
    customerProvidedRootKey Property Map
    This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty customer_provided_root_key block. After applying this, the public_wrapping_key can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the wrapped_key attribute.
    encryptionKeys List<Property Map>
    All encryption keys.
    keyRotationId String
    If this value is changed, the encryption keys will be rotated. A UUID is recommended for the key_rotation_id.

    Supporting Types

    EncryptionKeyManagerCustomerProvidedRootKey, EncryptionKeyManagerCustomerProvidedRootKeyArgs

    CreatedAt string
    The ISO 8601 formatted date the customer provided root key was created.
    KeyId string
    The key ID of the customer provided root key.
    ParentKeyId string
    The key ID of the parent wrapping key.
    PublicWrappingKey string
    The public wrapping key in PEM format.
    State string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    Type string
    The type of the customer provided root key. Should be customer-provided-root-key.
    UpdatedAt string
    The ISO 8601 formatted date the customer provided root key was updated.
    WrappedKey string
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    WrappingAlgorithm string
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.
    CreatedAt string
    The ISO 8601 formatted date the customer provided root key was created.
    KeyId string
    The key ID of the customer provided root key.
    ParentKeyId string
    The key ID of the parent wrapping key.
    PublicWrappingKey string
    The public wrapping key in PEM format.
    State string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    Type string
    The type of the customer provided root key. Should be customer-provided-root-key.
    UpdatedAt string
    The ISO 8601 formatted date the customer provided root key was updated.
    WrappedKey string
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    WrappingAlgorithm string
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.
    createdAt String
    The ISO 8601 formatted date the customer provided root key was created.
    keyId String
    The key ID of the customer provided root key.
    parentKeyId String
    The key ID of the parent wrapping key.
    publicWrappingKey String
    The public wrapping key in PEM format.
    state String
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type String
    The type of the customer provided root key. Should be customer-provided-root-key.
    updatedAt String
    The ISO 8601 formatted date the customer provided root key was updated.
    wrappedKey String
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    wrappingAlgorithm String
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.
    createdAt string
    The ISO 8601 formatted date the customer provided root key was created.
    keyId string
    The key ID of the customer provided root key.
    parentKeyId string
    The key ID of the parent wrapping key.
    publicWrappingKey string
    The public wrapping key in PEM format.
    state string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type string
    The type of the customer provided root key. Should be customer-provided-root-key.
    updatedAt string
    The ISO 8601 formatted date the customer provided root key was updated.
    wrappedKey string
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    wrappingAlgorithm string
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.
    created_at str
    The ISO 8601 formatted date the customer provided root key was created.
    key_id str
    The key ID of the customer provided root key.
    parent_key_id str
    The key ID of the parent wrapping key.
    public_wrapping_key str
    The public wrapping key in PEM format.
    state str
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type str
    The type of the customer provided root key. Should be customer-provided-root-key.
    updated_at str
    The ISO 8601 formatted date the customer provided root key was updated.
    wrapped_key str
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    wrapping_algorithm str
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.
    createdAt String
    The ISO 8601 formatted date the customer provided root key was created.
    keyId String
    The key ID of the customer provided root key.
    parentKeyId String
    The key ID of the parent wrapping key.
    publicWrappingKey String
    The public wrapping key in PEM format.
    state String
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type String
    The type of the customer provided root key. Should be customer-provided-root-key.
    updatedAt String
    The ISO 8601 formatted date the customer provided root key was updated.
    wrappedKey String
    The base64-encoded customer provided root key, wrapped using the public_wrapping_key. This can be removed after the wrapped key has been applied.
    wrappingAlgorithm String
    The algorithm that should be used to wrap the customer provided root key. Should be CKM_RSA_AES_KEY_WRAP.

    EncryptionKeyManagerEncryptionKey, EncryptionKeyManagerEncryptionKeyArgs

    CreatedAt string
    The ISO 8601 formatted date the encryption key was created.
    KeyId string
    The key ID of the encryption key.
    ParentKeyId string
    The key ID of the parent wrapping key.
    State string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    Type string
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    UpdatedAt string
    The ISO 8601 formatted date the encryption key was updated.
    CreatedAt string
    The ISO 8601 formatted date the encryption key was created.
    KeyId string
    The key ID of the encryption key.
    ParentKeyId string
    The key ID of the parent wrapping key.
    State string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    Type string
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    UpdatedAt string
    The ISO 8601 formatted date the encryption key was updated.
    createdAt String
    The ISO 8601 formatted date the encryption key was created.
    keyId String
    The key ID of the encryption key.
    parentKeyId String
    The key ID of the parent wrapping key.
    state String
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type String
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    updatedAt String
    The ISO 8601 formatted date the encryption key was updated.
    createdAt string
    The ISO 8601 formatted date the encryption key was created.
    keyId string
    The key ID of the encryption key.
    parentKeyId string
    The key ID of the parent wrapping key.
    state string
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type string
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    updatedAt string
    The ISO 8601 formatted date the encryption key was updated.
    created_at str
    The ISO 8601 formatted date the encryption key was created.
    key_id str
    The key ID of the encryption key.
    parent_key_id str
    The key ID of the parent wrapping key.
    state str
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type str
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    updated_at str
    The ISO 8601 formatted date the encryption key was updated.
    createdAt String
    The ISO 8601 formatted date the encryption key was created.
    keyId String
    The key ID of the encryption key.
    parentKeyId String
    The key ID of the parent wrapping key.
    state String
    The state of the encryption key. One of pre-activation, active, deactivated, or destroyed.
    type String
    The type of the encryption key. One of customer-provided-root-key, environment-root-key, or tenant-master-key.
    updatedAt String
    The ISO 8601 formatted date the encryption key was updated.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0