How to use DATASOURCE::OOS::SecretParameters to query encryption parameters - Resource Orchestration Service

DATASOURCE::OOS::SecretParameters is used to query encryption parameters.

Syntax

{
  "Type": "DATASOURCE::OOS::SecretParameters",
  "Properties": {
    "ResourceGroupId": String,
    "SecretParameterName": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
SecretParameterName	String	No	Yes	The name of the encryption parameter.	None.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

SecretParameters: details of the encryption parameters.
SecretParameterNames: the names of the encryption parameters.

Property	Type	Description	Constraint
SecretParameterNames	List	The names of the encryption parameters.	None.
SecretParameters	List	Details of the encryption parameters.	None.
SecretParameterName	string	The name of the encryption parameter.	None.
ParameterVersion	string	The version of the encryption parameter.	None.
Description	string	The description of the encryption parameter.	None.
Tags	Map	The custom tags of the encryption parameter.	None.
ShareType	string	The share type of the encryption parameter.	None.
ResourceGroupId	string	The ID of the resource group.	None.
UpdatedDate	string	The time when the encryption parameter was updated.	None.
KeyId	string	The ID of the Key Management Service (KMS) key that is used to encrypt the encryption parameter.	None.
CreatedBy	string	The user who created the encryption parameter.	None.
UpdatedBy	string	The user who updated the encryption parameter.	None.
SecretParameterId	string	The ID of the encryption parameter.	None.
Type	string	The type of the encryption parameter.	None.
CreateTime	string	The time when the encryption parameter was created.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::OOS::SecretParameters
    Properties:
      SecretParameterName: MySecretParameter
Outputs:
  SecretParameters:
    Description: The list of secret parameters.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameters
  SecretParameterNames:
    Description: The list of secret parameter names.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameterNames

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::OOS::SecretParameters",
      "Properties": {
        "SecretParameterName": "MySecretParameter"
      }
    }
  },
  "Outputs": {
    "SecretParameters": {
      "Description": "The list of secret parameters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameters"
        ]
      }
    },
    "SecretParameterNames": {
      "Description": "The list of secret parameter names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameterNames"
        ]
      }
    }
  }
}