Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. getKeyMaterial
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kms.getKeyMaterial

volcenginecc logo
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::KMS::KeyMaterial

    Using getKeyMaterial

    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 getKeyMaterial(args: GetKeyMaterialArgs, opts?: InvokeOptions): Promise<GetKeyMaterialResult>
function getKeyMaterialOutput(args: GetKeyMaterialOutputArgs, opts?: InvokeOptions): Output<GetKeyMaterialResult>
    def get_key_material(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetKeyMaterialResult
def get_key_material_output(id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetKeyMaterialResult]
    func LookupKeyMaterial(ctx *Context, args *LookupKeyMaterialArgs, opts ...InvokeOption) (*LookupKeyMaterialResult, error)
func LookupKeyMaterialOutput(ctx *Context, args *LookupKeyMaterialOutputArgs, opts ...InvokeOption) LookupKeyMaterialResultOutput

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

    public static class GetKeyMaterial 
{
    public static Task<GetKeyMaterialResult> InvokeAsync(GetKeyMaterialArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyMaterialResult> Invoke(GetKeyMaterialInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyMaterialResult> getKeyMaterial(GetKeyMaterialArgs args, InvokeOptions options)
public static Output<GetKeyMaterialResult> getKeyMaterial(GetKeyMaterialArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:kms/getKeyMaterial:getKeyMaterial
  arguments:
    # arguments dictionary
    data "volcenginecc_kms_getkeymaterial" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getKeyMaterial Result

    The following output properties are available:

    EncryptedKeyMaterial string
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    ExpirationModel string
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    Id string
    Uniquely identifies the resource.
    ImportToken string
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    KeyId string
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    KeyMaterialExpireTime string
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    KeyState string
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    Origin string
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    ValidTo int
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    EncryptedKeyMaterial string
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    ExpirationModel string
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    Id string
    Uniquely identifies the resource.
    ImportToken string
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    KeyId string
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    KeyMaterialExpireTime string
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    KeyState string
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    Origin string
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    ValidTo int
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    encrypted_key_material string
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    expiration_model string
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    id string
    Uniquely identifies the resource.
    import_token string
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    key_id string
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    key_material_expire_time string
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    key_state string
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    origin string
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    valid_to number
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    encryptedKeyMaterial String
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    expirationModel String
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    id String
    Uniquely identifies the resource.
    importToken String
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    keyId String
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    keyMaterialExpireTime String
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    keyState String
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    origin String
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    validTo Integer
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    encryptedKeyMaterial string
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    expirationModel string
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    id string
    Uniquely identifies the resource.
    importToken string
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    keyId string
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    keyMaterialExpireTime string
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    keyState string
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    origin string
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    validTo number
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    encrypted_key_material str
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    expiration_model str
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    id str
    Uniquely identifies the resource.
    import_token str
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    key_id str
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    key_material_expire_time str
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    key_state str
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    origin str
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    valid_to int
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.
    encryptedKeyMaterial String
    The key material obtained after the user encrypts using the import public key, encoded in Base64; this value is passed directly to the ImportKeyMaterial interface.
    expirationModel String
    Key material expiration type. Values: KEYMATERIALDOESNOTEXPIRE (default), KEYMATERIALEXPIRES.
    id String
    Uniquely identifies the resource.
    importToken String
    The import token obtained after the user calls the interface to retrieve import parameters; this value is passed directly to the ImportKeyMaterial interface.
    keyId String
    Unique identifier of the target master key in UUID format; the Origin of this key must be External.
    keyMaterialExpireTime String
    The expiration time of the key material recorded by the server after import; if the material does not expire, this field is an empty string.
    keyState String
    Current status of the target master key. Values: Enable, Disable, PendingDelete, Archived, PendingImport, PendingReplicaDelete.
    origin String
    Source of the target master key. Values: CloudKMS, External, ExternalKeyStore. The KeyMaterial resource is only valid for keys with External origin.
    validTo Number
    Key material expiration time, Unix timestamp in seconds; required when the ExpirationModel parameter is set to KEYMATERIALEXPIRES. Must be a time after the current moment, based on server time.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.49
    published on Thursday, Jul 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial