全部產品
Search

搜尋本產品

    ：ALIYUN::KMS::Key

    文件中心

    ：ALIYUN::KMS::Key

    更新時間：Jun 08, 2024

    ALIYUN::KMS::Key類型用於建立一個主要金鑰。

    文法

    {
  "Type": "ALIYUN::KMS::Key",
  "Properties": {
    "KeyUsage": String,
    "Enable": Boolean,
    "PendingWindowInDays": Integer,
    "Description": String,
    "KeySpec": String,
    "EnableAutomaticRotation": Boolean,
    "RotationInterval": String,
    "ProtectionLevel": String,
    "DKMSInstanceId": String,
    "Policy": Map
  }
}

    屬性

    屬性名稱

    類型

    必須

    允許更新

    描述

    約束

    KeyUsage

    String

    否

    否

    密鑰的用途。

    取值：

    • ENCRYPT/DECRYPT：資料加密和解密。

    • SIGN/VERIFY：產生和驗證數位簽章。

    Enable

    Boolean

    否

    是

    將密鑰設定為啟用或禁用狀態。

    取值：

    • true（預設值）：將密鑰設定為啟用狀態。

    • false：將密鑰設定為禁用狀態。

    PendingWindowInDays

    Integer

    否

    否

    密鑰預刪除周期。在這段時間內，您可以撤銷刪除處於待刪除狀態的密鑰；預刪除時間過後無法撤銷刪除。

    取值範圍：7~30。

    預設值：30。

    單位：天。

    Description

    String

    否

    是

    密鑰的描述。

    長度為0~8192個字元。

    KeySpec

    String

    否

    否

    密鑰的類型。

    取值：

    • Aliyun_AES_256

    • Aliyun_SM4

    • RSA_2048

    • EC_P256

    • EC_P256K

    • EC_SM2

    說明

    在中國內地使用託管密碼機建立的密鑰，預設為Aliyun_SM4類型，其餘情況下預設為Aliyun_AES_256。

    EnableAutomaticRotation

    Boolean

    否

    是

    是否開啟密鑰自動輪轉。

    取值：

    • true：開啟密鑰自動輪轉。

    • false（預設值）：關閉密鑰自動輪轉。

    RotationInterval

    String

    否

    是

    自動輪轉的時間周期。例如：365d。

    格式為integer[unit]，其中integer表示時間長度，unit表示時間單位。

    合法的unit單位取值如下：

    • d：天

    • h：小時

    • m：分鐘

    • s：秒

    7d或者604800s均表示7天的周期。

    取值範圍：7~730天。

    ProtectionLevel

    String

    否

    否

    密鑰的保護層級。

    取值：

    • SOFTWARE（預設值）

    • HSM

    DKMSInstanceId

    String

    否

    否

    專屬KMS的執行個體ID。

    無

    Policy

    Map

    否

    否

    密鑰策略。

    JSON格式。最大長度為32768個位元組。

    關於密鑰策略的詳細介紹，請參見密鑰策略概述。不輸入該參數時，使用預設憑據策略。

    密鑰策略內容包含：

    • Version：密鑰策略的版本，目前版本僅支援設定為1。

    • Statement：密鑰策略的語句，每個密鑰策略包含一個或多個語句。

    密鑰策略格式為：

    {
    "Version": "1",
    "Statement": [
        {
            "Sid": "Enable RAM User Permissions",
            "Effect": "Allow",
            "Principal": {
              "RAM": "acs:ram::112890462****:root"
            }
            "Action": [
                "kms:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

    傳回值

    Fn::GetAtt

    KeyId：密鑰的通用唯一識別碼。

    樣本

    YAML格式 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Key:
    Type: ALIYUN::KMS::Key
    Properties:
      KeyUsage: ENCRYPT/DECRYPT
      Enable: false
      PendingWindowInDays: 15
      Description: Test create key
Outputs:
  KeyId:
    Description: The globally unique identifier for the CMK.
    Value:
      Fn::GetAtt:
        - Key
        - KeyId

    JSON格式 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Key": {
      "Type": "ALIYUN::KMS::Key",
      "Properties": {
        "KeyUsage": "ENCRYPT/DECRYPT",
        "Enable": false,
        "PendingWindowInDays": 15,
        "Description": "Test create key"
      }
    }
  },
  "Outputs": {
    "KeyId": {
      "Description": "The globally unique identifier for the CMK.",
      "Value": {
        "Fn::GetAtt": [
          "Key",
          "KeyId"
        ]
      }
    }
  }
}