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

stackit.getKmsKeyring

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

    KMS Keyring datasource schema. Uses the default_region specified in the provider configuration as a fallback in case no region is defined on datasource level.

    Example Usage

    data "stackit_kms_keyring" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  keyring_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

    Using getKmsKeyring

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKmsKeyring(args: GetKmsKeyringArgs, opts?: InvokeOptions): Promise<GetKmsKeyringResult>
function getKmsKeyringOutput(args: GetKmsKeyringOutputArgs, opts?: InvokeOptions): Output<GetKmsKeyringResult>
    def get_kms_keyring(keyring_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetKmsKeyringResult
def get_kms_keyring_output(keyring_id: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    region: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetKmsKeyringResult]
    func LookupKmsKeyring(ctx *Context, args *LookupKmsKeyringArgs, opts ...InvokeOption) (*LookupKmsKeyringResult, error)
func LookupKmsKeyringOutput(ctx *Context, args *LookupKmsKeyringOutputArgs, opts ...InvokeOption) LookupKmsKeyringResultOutput

    > Note: This function is named LookupKmsKeyring in the Go SDK.

    public static class GetKmsKeyring 
{
    public static Task<GetKmsKeyringResult> InvokeAsync(GetKmsKeyringArgs args, InvokeOptions? opts = null)
    public static Output<GetKmsKeyringResult> Invoke(GetKmsKeyringInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKmsKeyringResult> getKmsKeyring(GetKmsKeyringArgs args, InvokeOptions options)
public static Output<GetKmsKeyringResult> getKmsKeyring(GetKmsKeyringArgs args, InvokeOptions options)

    fn::invoke:
  function: stackit:index/getKmsKeyring:getKmsKeyring
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.

    getKmsKeyring Result

    The following output properties are available:

    Description string
    A user chosen description to distinguish multiple keyrings.
    DisplayName string
    The display name to distinguish multiple keyrings.
    Id string
    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.
    Id string
    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.
    id String
    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.
    id string
    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.
    id str
    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.
    id String
    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.