全部产品
Search
文档中心

资源编排:ALIYUN::CloudSSO::AccessConfiguration

更新时间:Jul 18, 2024

ALIYUN::CloudSSO::AccessConfiguration类型用于创建访问配置。

语法

{
  "Type": "ALIYUN::CloudSSO::AccessConfiguration",
  "Properties": {
    "SessionDuration": Integer,
    "AccessConfigurationName": String,
    "DirectoryId": String,
    "RelayState": String,
    "Description": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

AccessConfigurationName

String

访问配置名称。

格式:包含英文字母、数字或短划线(-)。

长度:最大32个字符。

DirectoryId

String

目录ID。

Description

String

访问配置的描述。

长度:最大1024个字符。

RelayState

String

初始访问页面。

云SSO用户使用访问配置访问RD账号时,初始访问的页面地址。

该页面必须是阿里云控制台页面。默认为空,表示跳转到阿里云控制台首页。

SessionDuration

Integer

会话持续时间。

云SSO用户使用访问配置访问RD账号时,会话最多保持的时间。

单位:秒。

取值范围:900~43200(15分钟~12小时)。

默认值:3600(1小时)。

返回值

Fn::GetAtt

AccessConfigurationId:访问配置ID。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccessConfigurationName:
    AllowedPattern: ^[a-zA-Z0-9-]{1,32}$
    Description:
      en: 'The name of the access configuration.

        The name can contain letters, digits, and hyphens (-).

        The name can be up to 32 characters in length.'
    Required: true
    Type: String
  Description:
    AssociationProperty: TextArea
    Description:
      en: 'The description of the access configuration.

        The description can be up to 1,024 characters in length.'
    MaxLength: 1024
    Required: false
    Type: String
  DirectoryId:
    Description:
      en: The ID of the directory.
    Required: true
    Type: String
  RelayState:
    Description:
      en: 'The initial web page that is displayed after a CloudSSO user accesses an
        account in your resource directory by using the access configuration.

        The web page must be a page of the Alibaba Cloud Management Console. By default,
        this parameter is empty, which indicates that the initial web page is the
        homepage of the Alibaba Cloud Management Console.'
    Required: false
    Type: String
  SessionDuration:
    Description:
      en: 'The duration of a session in which a CloudSSO user accesses an account
        in your resource directory by using the access configuration.

        Unit: seconds.

        Valid values: 900 to 43200. The value 900 indicates 15 minutes. The value
        43200 indicates 12 hours.

        Default value: 3600. The value indicates 1 hour.'
    MaxValue: 43200
    MinValue: 900
    Required: false
    Type: Number
Resources:
  AccessConfiguration:
    Properties:
      AccessConfigurationName:
        Ref: AccessConfigurationName
      Description:
        Ref: Description
      DirectoryId:
        Ref: DirectoryId
      RelayState:
        Ref: RelayState
      SessionDuration:
        Ref: SessionDuration
    Type: ALIYUN::CloudSSO::AccessConfiguration
Outputs:
  AccessConfigurationId:
    Description: The ID of the access configuration.
    Value:
      Fn::GetAtt:
      - AccessConfiguration
      - AccessConfigurationId
                        

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SessionDuration": {
      "Type": "Number",
      "Description": {
        "en": "The duration of a session in which a CloudSSO user accesses an account in your resource directory by using the access configuration.\nUnit: seconds.\nValid values: 900 to 43200. The value 900 indicates 15 minutes. The value 43200 indicates 12 hours.\nDefault value: 3600. The value indicates 1 hour."
      },
      "Required": false,
      "MinValue": 900,
      "MaxValue": 43200
    },
    "AccessConfigurationName": {
      "Type": "String",
      "Description": {
        "en": "The name of the access configuration.\nThe name can contain letters, digits, and hyphens (-).\nThe name can be up to 32 characters in length."
      },
      "AllowedPattern": "^[a-zA-Z0-9-]{1,32}$",
      "Required": true
    },
    "DirectoryId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the directory."
      },
      "Required": true
    },
    "RelayState": {
      "Type": "String",
      "Description": {
        "en": "The initial web page that is displayed after a CloudSSO user accesses an account in your resource directory by using the access configuration.\nThe web page must be a page of the Alibaba Cloud Management Console. By default, this parameter is empty, which indicates that the initial web page is the homepage of the Alibaba Cloud Management Console."
      },
      "Required": false
    },
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "en": "The description of the access configuration.\nThe description can be up to 1,024 characters in length."
      },
      "Required": false,
      "MaxLength": 1024
    }
  },
  "Resources": {
    "AccessConfiguration": {
      "Type": "ALIYUN::CloudSSO::AccessConfiguration",
      "Properties": {
        "SessionDuration": {
          "Ref": "SessionDuration"
        },
        "AccessConfigurationName": {
          "Ref": "AccessConfigurationName"
        },
        "DirectoryId": {
          "Ref": "DirectoryId"
        },
        "RelayState": {
          "Ref": "RelayState"
        },
        "Description": {
          "Ref": "Description"
        }
      }
    }
  },
  "Outputs": {
    "AccessConfigurationId": {
      "Description": "The ID of the access configuration.",
      "Value": {
        "Fn::GetAtt": [
          "AccessConfiguration",
          "AccessConfigurationId"
        ]
      }
    }
  }
}