DATASOURCE::NAS::AccessGroup - Resource Orchestration Service

DATASOURCE::NAS::AccessGroup is used to query the information about a permission group.

Syntax

{
  "Type": "DATASOURCE::NAS::AccessGroup",
  "Properties": {
    "AccessGroupName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

AccessGroupName

String

Yes

The name of the permission group.

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

RuleCount: the number of rules in the permission group.
AccessGroupType: the type of the permission group.
Description: the description of the permission group.
AccessGroupName: the name of the permission group.
MountTargetCount: the number of mount targets to which the permission group is attached.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccessGroupName:
    Type: String
    Description:
      en: The name of the permission group.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::NAS::AccessGroup
    Properties:
      AccessGroupName:
        Ref: AccessGroupName
Outputs:
  RuleCount:
    Description: The number of permission group rules contained in this permission group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RuleCount
  AccessGroupType:
    Description: Permission group types, including VPC and Classic.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccessGroupType
  Description:
    Description: Permission group description information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  AccessGroupName:
    Description: The name of the permission group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AccessGroupName
  MountTargetCount:
    Description: The number of Mount points to which this permission group is applied.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - MountTargetCount

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AccessGroupName": {
      "Type": "String",
      "Description": {
        "en": "The name of the permission group."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NAS::AccessGroup",
      "Properties": {
        "AccessGroupName": {
          "Ref": "AccessGroupName"
        }
      }
    }
  },
  "Outputs": {
    "RuleCount": {
      "Description": "The number of permission group rules contained in this permission group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RuleCount"
        ]
      }
    },
    "AccessGroupType": {
      "Description": "Permission group types, including VPC and Classic.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccessGroupType"
        ]
      }
    },
    "Description": {
      "Description": "Permission group description information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "AccessGroupName": {
      "Description": "The name of the permission group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccessGroupName"
        ]
      }
    },
    "MountTargetCount": {
      "Description": "The number of Mount points to which this permission group is applied.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MountTargetCount"
        ]
      }
    }
  }
}