ALIYUN::OOS::SecretParameter - Resource Orchestration Service

ALIYUN::OOS::SecretParameter is used to create an encryption parameter.

Syntax

{
  "Type": "ALIYUN::OOS::SecretParameter",
  "Properties": {
    "Description": String,
    "Constraints": Map,
    "ResourceGroupId": String,
    "SecretParameterName": String,
    "Value": String,
    "KeyId": String,
    "Tags": List
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
Description	String	No	Yes	The description of the parameter.	The description can be up to 200 characters in length.
Constraints	Map	No	No	The constraints of the parameter.	Valid values: AllowedValues: The values that can be specified for the parameter. The values must be array strings. AllowedPattern: The pattern that can be specified for the parameter. The pattern must be a regular expression. MinLength: the minimum length of the parameter value. MaxLength: the maximum length of the parameter value.
ResourceGroupId	String	No	Yes	The ID of the resource group to which the parameter belongs.	None.
SecretParameterName	String	Yes	No	The name of the parameter.	The name can be up to 180 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). The name cannot start with `ALIYUN`, `ACS`, `ALIBABA`, `ALICLOUD`, or `OOS`.
Value	String	Yes	Yes	The value of the parameter.	The value can be up to 4,096 characters in length.
KeyId	String	No	No	The ID of the Key Management Service (KMS) key that you want to use to encrypt the parameter.	None.
Tags	List	No	Yes	The tags of the parameter.	You can add up to 20 tags. For more information, see Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property	Type	Required	Editable	Description	Constraint
Value	String	No	No	The value of the tag.	The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.
Key	String	Yes	No	The key of the tag.	The tag key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

Description: the description of the parameter
CreatedBy: the user who created the parameter.
ResourceGroupId: the ID of the resource group to which the parameter belongs.
SecretParameterName: the name of the parameter.
UpdatedDate: the time when the parameter was updated.
CreateTime: the time when the parameter was created.
KeyId: the ID of the KMS key that is used to encrypt the parameter.
SecretParameterId: the ID of the parameter.
UpdatedBy: the user who updated the parameter.
Type: the type of the parameter.
Constraint: the constraints of the parameter.
ParameterVersion: the version of the parameter.
Tags: the tags of the parameter.
ShareType: the share type of the parameter.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::OOS::SecretParameter
    Properties:
      Constraints: '{"AllowedValues":["secretparameter"],"AllowedPattern":"secretparameter","MinLength":0,"MaxLength":20}'
      SecretParameterName: MySecretParameter
      Value: SecretParameter
      KeyId: 80e9409f-78fa-42ab-84bd-83f40c******
Outputs:
  Description:
    Description: The description of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  CreatedBy:
    Description: The user who created the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreatedBy
  ResourceGroupId:
    Description: The ID of resource group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ResourceGroupId
  SecretParameterName:
    Description: The name of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecretParameterName
  UpdatedDate:
    Description: The time when the encryption parameter was updated.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdatedDate
  CreateTime:
    Description: The time when the encryption parameter was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  KeyId:
    Description: The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - KeyId
  SecretParameterId:
    Description: The ID of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - SecretParameterId
  UpdatedBy:
    Description: The user who updated the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - UpdatedBy
  Type:
    Description: The data type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Type
  Constraints:
    Description: The constraints of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Constraints
  ParameterVersion:
    Description: The version number of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ParameterVersion
  Tags:
    Description: Tags of encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
  ShareType:
    Description: The share type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ShareType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::OOS::SecretParameter",
      "Properties": {
        "Constraints": "{\"AllowedValues\":[\"secretparameter\"],\"AllowedPattern\":\"secretparameter\",\"MinLength\":0,\"MaxLength\":20}",
        "SecretParameterName": "MySecretParameter",
        "Value": "SecretParameter",
        "KeyId": "80e9409f-78fa-42ab-84bd-83f40c******"
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "CreatedBy": {
      "Description": "The user who created the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreatedBy"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "SecretParameterName": {
      "Description": "The name of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecretParameterName"
        ]
      }
    },
    "UpdatedDate": {
      "Description": "The time when the encryption parameter was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedDate"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the encryption parameter was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "KeyId": {
      "Description": "The Customer Master Key (CMK) of Key Management Service (KMS) that is used to encrypt the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "KeyId"
        ]
      }
    },
    "SecretParameterId": {
      "Description": "The ID of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SecretParameterId"
        ]
      }
    },
    "UpdatedBy": {
      "Description": "The user who updated the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedBy"
        ]
      }
    },
    "Type": {
      "Description": "The data type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Type"
        ]
      }
    },
    "Constraints": {
      "Description": "The constraints of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Constraints"
        ]
      }
    },
    "ParameterVersion": {
      "Description": "The version number of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ParameterVersion"
        ]
      }
    },
    "Tags": {
      "Description": "Tags of encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ShareType"
        ]
      }
    }
  }
}