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

stackit.KmsKeyring

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

    Example Usage

    resource "stackit_kms_keyring" "example" {
  project_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  display_name = "example-name"
  description  = "example description"
}

    Create KmsKeyring Resource

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

    Constructor syntax

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

@overload
def KmsKeyring(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               project_id: Optional[str] = None,
               description: Optional[str] = None,
               region: Optional[str] = None)
    func NewKmsKeyring(ctx *Context, name string, args KmsKeyringArgs, opts ...ResourceOption) (*KmsKeyring, error)
    public KmsKeyring(string name, KmsKeyringArgs args, CustomResourceOptions? opts = null)
    public KmsKeyring(String name, KmsKeyringArgs args)
public KmsKeyring(String name, KmsKeyringArgs args, CustomResourceOptions options)

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

    example, err := stackit.NewKmsKeyring(ctx, "kmsKeyringResource", &stackit.KmsKeyringArgs{
	DisplayName: pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Region:      pulumi.String("string"),
})

    var kmsKeyringResource = new KmsKeyring("kmsKeyringResource", KmsKeyringArgs.builder()
    .displayName("string")
    .projectId("string")
    .description("string")
    .region("string")
    .build());

    kms_keyring_resource = stackit.KmsKeyring("kmsKeyringResource",
    display_name="string",
    project_id="string",
    description="string",
    region="string")

    const kmsKeyringResource = new stackit.KmsKeyring("kmsKeyringResource", {
    displayName: "string",
    projectId: "string",
    description: "string",
    region: "string",
});

    type: stackit:KmsKeyring
properties:
    description: string
    displayName: string
    projectId: string
    region: string

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

    DisplayName string
    The display name to distinguish multiple keyrings.
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Description string
    A user chosen description to distinguish multiple keyrings.
    Region string
    The resource region. If not defined, the provider region is used.
    DisplayName string
    The display name to distinguish multiple keyrings.
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Description string
    A user chosen description to distinguish multiple keyrings.
    Region string
    The resource region. If not defined, the provider region is used.
    displayName String
    The display name to distinguish multiple keyrings.
    projectId String
    STACKIT project ID to which the keyring is associated.
    description String
    A user chosen description to distinguish multiple keyrings.
    region String
    The resource region. If not defined, the provider region is used.
    displayName string
    The display name to distinguish multiple keyrings.
    projectId string
    STACKIT project ID to which the keyring is associated.
    description string
    A user chosen description to distinguish multiple keyrings.
    region string
    The resource region. If not defined, the provider region is used.
    display_name str
    The display name to distinguish multiple keyrings.
    project_id str
    STACKIT project ID to which the keyring is associated.
    description str
    A user chosen description to distinguish multiple keyrings.
    region str
    The resource region. If not defined, the provider region is used.
    displayName String
    The display name to distinguish multiple keyrings.
    projectId String
    STACKIT project ID to which the keyring is associated.
    description String
    A user chosen description to distinguish multiple keyrings.
    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 KmsKeyring resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    KeyringId string
    An auto generated unique id which identifies the keyring.
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyringId string
    An auto generated unique id which identifies the keyring.
    id String
    The provider-assigned unique ID for this managed resource.
    keyringId String
    An auto generated unique id which identifies the keyring.
    id string
    The provider-assigned unique ID for this managed resource.
    keyringId string
    An auto generated unique id which identifies the keyring.
    id str
    The provider-assigned unique ID for this managed resource.
    keyring_id str
    An auto generated unique id which identifies the keyring.
    id String
    The provider-assigned unique ID for this managed resource.
    keyringId String
    An auto generated unique id which identifies the keyring.

    Look up Existing KmsKeyring Resource

    Get an existing KmsKeyring 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?: KmsKeyringState, opts?: CustomResourceOptions): KmsKeyring
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        keyring_id: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None) -> KmsKeyring
    func GetKmsKeyring(ctx *Context, name string, id IDInput, state *KmsKeyringState, opts ...ResourceOption) (*KmsKeyring, error)
    public static KmsKeyring Get(string name, Input<string> id, KmsKeyringState? state, CustomResourceOptions? opts = null)
    public static KmsKeyring get(String name, Output<String> id, KmsKeyringState state, CustomResourceOptions options)
    resources:  _:    type: stackit:KmsKeyring    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:
    Description string
    A user chosen description to distinguish multiple keyrings.
    DisplayName string
    The display name to distinguish multiple keyrings.
    KeyringId string
    An auto generated unique id which identifies the keyring.
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Description string
    A user chosen description to distinguish multiple keyrings.
    DisplayName string
    The display name to distinguish multiple keyrings.
    KeyringId string
    An auto generated unique id which identifies the keyring.
    ProjectId string
    STACKIT project ID to which the keyring is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    description String
    A user chosen description to distinguish multiple keyrings.
    displayName String
    The display name to distinguish multiple keyrings.
    keyringId String
    An auto generated unique id which identifies the keyring.
    projectId String
    STACKIT project ID to which the keyring is associated.
    region String
    The resource region. If not defined, the provider region is used.
    description string
    A user chosen description to distinguish multiple keyrings.
    displayName string
    The display name to distinguish multiple keyrings.
    keyringId string
    An auto generated unique id which identifies the keyring.
    projectId string
    STACKIT project ID to which the keyring is associated.
    region string
    The resource region. If not defined, the provider region is used.
    description str
    A user chosen description to distinguish multiple keyrings.
    display_name str
    The display name to distinguish multiple keyrings.
    keyring_id str
    An auto generated unique id which identifies the keyring.
    project_id str
    STACKIT project ID to which the keyring is associated.
    region str
    The resource region. If not defined, the provider region is used.
    description String
    A user chosen description to distinguish multiple keyrings.
    displayName String
    The display name to distinguish multiple keyrings.
    keyringId String
    An auto generated unique id which identifies the keyring.
    projectId String
    STACKIT project ID to which the keyring is associated.
    region String
    The resource region. If not defined, the provider region is used.

    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.