Use DATASOURCE::NAS::AccessGroups to query information about permission groups - Resource Orchestration Service

DATASOURCE::NAS::AccessGroups is used to query the information about permission groups.

Syntax

{
  "Type": "DATASOURCE::NAS::AccessGroups",
  "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

AccessGroups: details of the permission groups.
AccessGroupNames: the names of the permission groups.

Property	Type	Description	Constraint
AccessGroupNames	List	The names of the permission groups.	None.
AccessGroups	List	Details of the permission groups.	None.
AccessGroupType	String	The type of the permission group.	Valid values: Vpc: virtual private cloud (VPC) Classic: classic network
MountTargetCount	Integer	The number of mount targets to which the permission group is attached.	None.
Description	String	The description of the permission group.	None.
RuleCount	Integer	The number of rules in the permission group.	None.
AccessGroupName	String	The name of the permission group.	None.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AccessGroupName": {
      "Type": "String",
      "Description": "The name of the permission group."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::NAS::AccessGroups",
      "Properties": {
        "AccessGroupName": {
          "Ref": "AccessGroupName"
        }
      }
    }
  },
  "Outputs": {
    "AccessGroups": {
      "Description": "The list of access groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccessGroups"
        ]
      }
    },
    "AccessGroupNames": {
      "Description": "The list of access group names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AccessGroupNames"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccessGroupName:
    Description: The name of the permission group.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      AccessGroupName:
        Ref: AccessGroupName
    Type: DATASOURCE::NAS::AccessGroups
Outputs:
  AccessGroupNames:
    Description: The list of access group names.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AccessGroupNames
  AccessGroups:
    Description: The list of access groups.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AccessGroups