1. Packages
  2. stackit
  3. API Docs
  4. KmsWrappingKey
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.KmsWrappingKey

stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    KMS wrapping key resource schema.

    Example Usage

    resource "stackit_kms_wrapping_key" "example" {
  project_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  keyring_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  display_name = "example-name"
  protection   = "software"
  algorithm    = "rsa_2048_oaep_sha256"
  purpose      = "wrap_symmetric_key"
}

    Create KmsWrappingKey Resource

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

    Constructor syntax

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

@overload
def KmsWrappingKey(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   algorithm: Optional[str] = None,
                   display_name: Optional[str] = None,
                   keyring_id: Optional[str] = None,
                   project_id: Optional[str] = None,
                   protection: Optional[str] = None,
                   purpose: Optional[str] = None,
                   access_scope: Optional[str] = None,
                   description: Optional[str] = None,
                   region: Optional[str] = None)
    func NewKmsWrappingKey(ctx *Context, name string, args KmsWrappingKeyArgs, opts ...ResourceOption) (*KmsWrappingKey, error)
    public KmsWrappingKey(string name, KmsWrappingKeyArgs args, CustomResourceOptions? opts = null)
    public KmsWrappingKey(String name, KmsWrappingKeyArgs args)
public KmsWrappingKey(String name, KmsWrappingKeyArgs args, CustomResourceOptions options)

    type: stackit:KmsWrappingKey
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 KmsWrappingKeyArgs
    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 KmsWrappingKeyArgs
    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 KmsWrappingKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KmsWrappingKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KmsWrappingKeyArgs
    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 kmsWrappingKeyResource = new Stackit.KmsWrappingKey("kmsWrappingKeyResource", new()
{
    Algorithm = "string",
    DisplayName = "string",
    KeyringId = "string",
    ProjectId = "string",
    Protection = "string",
    Purpose = "string",
    AccessScope = "string",
    Description = "string",
    Region = "string",
});

    example, err := stackit.NewKmsWrappingKey(ctx, "kmsWrappingKeyResource", &stackit.KmsWrappingKeyArgs{
	Algorithm:   pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	KeyringId:   pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Protection:  pulumi.String("string"),
	Purpose:     pulumi.String("string"),
	AccessScope: pulumi.String("string"),
	Description: pulumi.String("string"),
	Region:      pulumi.String("string"),
})

    var kmsWrappingKeyResource = new KmsWrappingKey("kmsWrappingKeyResource", KmsWrappingKeyArgs.builder()
    .algorithm("string")
    .displayName("string")
    .keyringId("string")
    .projectId("string")
    .protection("string")
    .purpose("string")
    .accessScope("string")
    .description("string")
    .region("string")
    .build());

    kms_wrapping_key_resource = stackit.KmsWrappingKey("kmsWrappingKeyResource",
    algorithm="string",
    display_name="string",
    keyring_id="string",
    project_id="string",
    protection="string",
    purpose="string",
    access_scope="string",
    description="string",
    region="string")

    const kmsWrappingKeyResource = new stackit.KmsWrappingKey("kmsWrappingKeyResource", {
    algorithm: "string",
    displayName: "string",
    keyringId: "string",
    projectId: "string",
    protection: "string",
    purpose: "string",
    accessScope: "string",
    description: "string",
    region: "string",
});

    type: stackit:KmsWrappingKey
properties:
    accessScope: string
    algorithm: string
    description: string
    displayName: string
    keyringId: string
    projectId: string
    protection: string
    purpose: string
    region: string

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

    Algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    DisplayName string
    The display name to distinguish multiple wrapping keys.
    KeyringId string
    The ID of the associated keyring
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    Purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    AccessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    Description string
    A user chosen description to distinguish multiple wrapping keys.
    Region string
    The resource region. If not defined, the provider region is used.
    Algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    DisplayName string
    The display name to distinguish multiple wrapping keys.
    KeyringId string
    The ID of the associated keyring
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    Purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    AccessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    Description string
    A user chosen description to distinguish multiple wrapping keys.
    Region string
    The resource region. If not defined, the provider region is used.
    algorithm String
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    displayName String
    The display name to distinguish multiple wrapping keys.
    keyringId String
    The ID of the associated keyring
    projectId String
    STACKIT project ID to which the keyring is associated.
    protection String
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    purpose String
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    accessScope String
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    description String
    A user chosen description to distinguish multiple wrapping keys.
    region String
    The resource region. If not defined, the provider region is used.
    algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    displayName string
    The display name to distinguish multiple wrapping keys.
    keyringId string
    The ID of the associated keyring
    projectId string
    STACKIT project ID to which the keyring is associated.
    protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    accessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    description string
    A user chosen description to distinguish multiple wrapping keys.
    region string
    The resource region. If not defined, the provider region is used.
    algorithm str
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    display_name str
    The display name to distinguish multiple wrapping keys.
    keyring_id str
    The ID of the associated keyring
    project_id str
    STACKIT project ID to which the keyring is associated.
    protection str
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    purpose str
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    access_scope str
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    description str
    A user chosen description to distinguish multiple wrapping keys.
    region str
    The resource region. If not defined, the provider region is used.
    algorithm String
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    displayName String
    The display name to distinguish multiple wrapping keys.
    keyringId String
    The ID of the associated keyring
    projectId String
    STACKIT project ID to which the keyring is associated.
    protection String
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    purpose String
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    accessScope String
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    description String
    A user chosen description to distinguish multiple wrapping keys.
    region String
    The resource region. If not defined, the provider region is used.

    Outputs

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

    CreatedAt string
    The date and time the creation of the wrapping key was triggered.
    ExpiresAt string
    The date and time the wrapping key will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    PublicKey string
    The public key of the wrapping key.
    WrappingKeyId string
    The ID of the wrapping key
    CreatedAt string
    The date and time the creation of the wrapping key was triggered.
    ExpiresAt string
    The date and time the wrapping key will expire.
    Id string
    The provider-assigned unique ID for this managed resource.
    PublicKey string
    The public key of the wrapping key.
    WrappingKeyId string
    The ID of the wrapping key
    createdAt String
    The date and time the creation of the wrapping key was triggered.
    expiresAt String
    The date and time the wrapping key will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    publicKey String
    The public key of the wrapping key.
    wrappingKeyId String
    The ID of the wrapping key
    createdAt string
    The date and time the creation of the wrapping key was triggered.
    expiresAt string
    The date and time the wrapping key will expire.
    id string
    The provider-assigned unique ID for this managed resource.
    publicKey string
    The public key of the wrapping key.
    wrappingKeyId string
    The ID of the wrapping key
    created_at str
    The date and time the creation of the wrapping key was triggered.
    expires_at str
    The date and time the wrapping key will expire.
    id str
    The provider-assigned unique ID for this managed resource.
    public_key str
    The public key of the wrapping key.
    wrapping_key_id str
    The ID of the wrapping key
    createdAt String
    The date and time the creation of the wrapping key was triggered.
    expiresAt String
    The date and time the wrapping key will expire.
    id String
    The provider-assigned unique ID for this managed resource.
    publicKey String
    The public key of the wrapping key.
    wrappingKeyId String
    The ID of the wrapping key

    Look up Existing KmsWrappingKey Resource

    Get an existing KmsWrappingKey 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?: KmsWrappingKeyState, opts?: CustomResourceOptions): KmsWrappingKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_scope: Optional[str] = None,
        algorithm: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        expires_at: Optional[str] = None,
        keyring_id: Optional[str] = None,
        project_id: Optional[str] = None,
        protection: Optional[str] = None,
        public_key: Optional[str] = None,
        purpose: Optional[str] = None,
        region: Optional[str] = None,
        wrapping_key_id: Optional[str] = None) -> KmsWrappingKey
    func GetKmsWrappingKey(ctx *Context, name string, id IDInput, state *KmsWrappingKeyState, opts ...ResourceOption) (*KmsWrappingKey, error)
    public static KmsWrappingKey Get(string name, Input<string> id, KmsWrappingKeyState? state, CustomResourceOptions? opts = null)
    public static KmsWrappingKey get(String name, Output<String> id, KmsWrappingKeyState state, CustomResourceOptions options)
    resources:  _:    type: stackit:KmsWrappingKey    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:
    AccessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    Algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    CreatedAt string
    The date and time the creation of the wrapping key was triggered.
    Description string
    A user chosen description to distinguish multiple wrapping keys.
    DisplayName string
    The display name to distinguish multiple wrapping keys.
    ExpiresAt string
    The date and time the wrapping key will expire.
    KeyringId string
    The ID of the associated keyring
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    PublicKey string
    The public key of the wrapping key.
    Purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    Region string
    The resource region. If not defined, the provider region is used.
    WrappingKeyId string
    The ID of the wrapping key
    AccessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    Algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    CreatedAt string
    The date and time the creation of the wrapping key was triggered.
    Description string
    A user chosen description to distinguish multiple wrapping keys.
    DisplayName string
    The display name to distinguish multiple wrapping keys.
    ExpiresAt string
    The date and time the wrapping key will expire.
    KeyringId string
    The ID of the associated keyring
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    PublicKey string
    The public key of the wrapping key.
    Purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    Region string
    The resource region. If not defined, the provider region is used.
    WrappingKeyId string
    The ID of the wrapping key
    accessScope String
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    algorithm String
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    createdAt String
    The date and time the creation of the wrapping key was triggered.
    description String
    A user chosen description to distinguish multiple wrapping keys.
    displayName String
    The display name to distinguish multiple wrapping keys.
    expiresAt String
    The date and time the wrapping key will expire.
    keyringId String
    The ID of the associated keyring
    projectId String
    STACKIT project ID to which the keyring is associated.
    protection String
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    publicKey String
    The public key of the wrapping key.
    purpose String
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    region String
    The resource region. If not defined, the provider region is used.
    wrappingKeyId String
    The ID of the wrapping key
    accessScope string
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    algorithm string
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    createdAt string
    The date and time the creation of the wrapping key was triggered.
    description string
    A user chosen description to distinguish multiple wrapping keys.
    displayName string
    The display name to distinguish multiple wrapping keys.
    expiresAt string
    The date and time the wrapping key will expire.
    keyringId string
    The ID of the associated keyring
    projectId string
    STACKIT project ID to which the keyring is associated.
    protection string
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    publicKey string
    The public key of the wrapping key.
    purpose string
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    region string
    The resource region. If not defined, the provider region is used.
    wrappingKeyId string
    The ID of the wrapping key
    access_scope str
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    algorithm str
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    created_at str
    The date and time the creation of the wrapping key was triggered.
    description str
    A user chosen description to distinguish multiple wrapping keys.
    display_name str
    The display name to distinguish multiple wrapping keys.
    expires_at str
    The date and time the wrapping key will expire.
    keyring_id str
    The ID of the associated keyring
    project_id str
    STACKIT project ID to which the keyring is associated.
    protection str
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    public_key str
    The public key of the wrapping key.
    purpose str
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    region str
    The resource region. If not defined, the provider region is used.
    wrapping_key_id str
    The ID of the wrapping key
    accessScope String
    The access scope of the key. Default is PUBLIC. Possible values are: PUBLIC, SNA.
    algorithm String
    The wrapping algorithm used to wrap the key to import. Possible values are: rsa_2048_oaep_sha256, rsa_3072_oaep_sha256, rsa_4096_oaep_sha256, rsa_4096_oaep_sha512, rsa_2048_oaep_sha256_aes_256_key_wrap, rsa_3072_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha256_aes_256_key_wrap, rsa_4096_oaep_sha512_aes_256_key_wrap.
    createdAt String
    The date and time the creation of the wrapping key was triggered.
    description String
    A user chosen description to distinguish multiple wrapping keys.
    displayName String
    The display name to distinguish multiple wrapping keys.
    expiresAt String
    The date and time the wrapping key will expire.
    keyringId String
    The ID of the associated keyring
    projectId String
    STACKIT project ID to which the keyring is associated.
    protection String
    The underlying system that is responsible for protecting the key material. Possible values are: software.
    publicKey String
    The public key of the wrapping key.
    purpose String
    The purpose for which the key will be used. Possible values are: wrap_symmetric_key, wrap_asymmetric_key.
    region String
    The resource region. If not defined, the provider region is used.
    wrappingKeyId String
    The ID of the wrapping key

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.