DATASOURCE::OOS::SecretParameter - Resource Orchestration Service

DATASOURCE::OOS::SecretParameter is used to query the information about an encryption parameter.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

SecretParameterName

String

Yes

The name of the parameter.

None.

RefreshOptions

String

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

Description: the description of the parameter.
CreatedBy: the user who created the parameter.
ResourceGroupId: the ID of the resource group.
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 Key Management Service (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.
Constraints: the constraints of the parameter.
ParameterVersion: the version of the parameter.
Value: the value of the parameter.
Tags: the information about the custom tags.
ShareType: the share type of the parameter.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecretParameterName:
    Type: String
    Description:
      en: The name of the parameter.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::OOS::SecretParameter
    Properties:
      SecretParameterName:
        Ref: SecretParameterName
Outputs:
  Description:
    Description: The description of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  CreatedBy:
    Description: The user who created the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreatedBy
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  SecretParameterName:
    Description: 'The name of the parameter. '
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameterName
  UpdatedDate:
    Description: The time when the encryption parameter was updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedDate
  CreateTime:
    Description: The time when the encryption parameter was created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  KeyId:
    Description: The ID of the key of Key Management Service (KMS) that is used for encryption.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - KeyId
  SecretParameterId:
    Description: The ID of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretParameterId
  UpdatedBy:
    Description: The user who updated the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedBy
  Type:
    Description: The type of the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Type
  Constraints:
    Description: The constraints of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Constraints
  ParameterVersion:
    Description: The version number of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ParameterVersion
  Value:
    Description: The value of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Value
  Tags:
    Description: The tags of the parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  ShareType:
    Description: The share type of the encryption parameter.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ShareType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecretParameterName": {
      "Type": "String",
      "Description": {
        "en": "The name of the parameter."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::OOS::SecretParameter",
      "Properties": {
        "SecretParameterName": {
          "Ref": "SecretParameterName"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "CreatedBy": {
      "Description": "The user who created the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreatedBy"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "SecretParameterName": {
      "Description": "The name of the parameter. ",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameterName"
        ]
      }
    },
    "UpdatedDate": {
      "Description": "The time when the encryption parameter was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedDate"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the encryption parameter was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "KeyId": {
      "Description": "The ID of the key of Key Management Service (KMS) that is used for encryption.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "KeyId"
        ]
      }
    },
    "SecretParameterId": {
      "Description": "The ID of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretParameterId"
        ]
      }
    },
    "UpdatedBy": {
      "Description": "The user who updated the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedBy"
        ]
      }
    },
    "Type": {
      "Description": "The type of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Type"
        ]
      }
    },
    "Constraints": {
      "Description": "The constraints of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Constraints"
        ]
      }
    },
    "ParameterVersion": {
      "Description": "The version number of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ParameterVersion"
        ]
      }
    },
    "Value": {
      "Description": "The value of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Value"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the encryption parameter.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShareType"
        ]
      }
    }
  }
}