DATASOURCE::APIG::Domain - Resource Orchestration Service

Use DATASOURCE::APIG::Query domain names using domain type.

Syntax

{
  "Type": "DATASOURCE::APIG::Domain",
  "Properties": {
    "DomainId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Update allowed

Description

Constraint

DomainId

String

Yes

The ID of the domain name.

None

RefreshOptions

String

Yes

The data source resources refresh mode when the stack is updated.

Valid values:

Never (default): never refresh data source resources when the stack is updated.
Always: always refresh data source resources when the stack is updated.

Return values

Fn::GetAtt

DomainId: Domain id
TlsCipherSuitesConfig: Configuration of cipher suites.
ResourceGroupId: Resource group ID
DomainName: Domain name
ForceHttps: Specifies whether to force HTTPS redirection.
TlsMax: Maximum TLS protocol version. Supports up to TLS 1.3.
CertIdentifier: Certificate identifier.
TlsMin: Minimum TLS protocol version. Supports at least TLS 1.0.
Http2Option: HTTP/2 settings.
Protocol: Supported protocol types for the domain.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainId:
    Type: String
    Description:
      en: The ID of the domain.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Domain
    Properties:
      DomainId:
        Ref: DomainId
Outputs:
  DomainId:
    Description: The ID of the domain.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainId
  TlsCipherSuitesConfig:
    Description: The TLS cipher suite configurations.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TlsCipherSuitesConfig
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  DomainName:
    Description: The domain name.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainName
  ForceHttps:
    Description: Set the HTTPS protocol type and whether to enable forced HTTPS redirection.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ForceHttps
  TlsMax:
    Description: The maximum version of the TLS protocol. The maximum version of the TLS protocol is 1.3.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TlsMax
  CertIdentifier:
    Description: The certificate ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CertIdentifier
  TlsMin:
    Description: The minimum version of the TLS protocol. The minimum version of the TLS protocol is 1.0.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TlsMin
  Http2Option:
    Description: The HTTP/2 configuration.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Http2Option
  Protocol:
    Description: The supported protocol.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Protocol

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the domain."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Domain",
      "Properties": {
        "DomainId": {
          "Ref": "DomainId"
        }
      }
    }
  },
  "Outputs": {
    "DomainId": {
      "Description": "The ID of the domain.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainId"
        ]
      }
    },
    "TlsCipherSuitesConfig": {
      "Description": "The TLS cipher suite configurations.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TlsCipherSuitesConfig"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "DomainName": {
      "Description": "The domain name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainName"
        ]
      }
    },
    "ForceHttps": {
      "Description": "Set the HTTPS protocol type and whether to enable forced HTTPS redirection.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ForceHttps"
        ]
      }
    },
    "TlsMax": {
      "Description": "The maximum version of the TLS protocol. The maximum version of the TLS protocol is 1.3.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TlsMax"
        ]
      }
    },
    "CertIdentifier": {
      "Description": "The certificate ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CertIdentifier"
        ]
      }
    },
    "TlsMin": {
      "Description": "The minimum version of the TLS protocol. The minimum version of the TLS protocol is 1.0.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TlsMin"
        ]
      }
    },
    "Http2Option": {
      "Description": "The HTTP/2 configuration.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Http2Option"
        ]
      }
    },
    "Protocol": {
      "Description": "The supported protocol.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Protocol"
        ]
      }
    }
  }
}