DATASOURCE::SWAS::Instance - Resource Orchestration Service

The DATASOURCE::SWAS::Instance resource type retrieves details about a Simple Application Server instance in a specified region.

Syntax

{
  "Type": "DATASOURCE::SWAS::Instance",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

Properties

Property Name

Type

Required

Updatable

Description

Constraints

InstanceId

String

Yes

The instance ID of the Simple Application Server.

None

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): Never refresh data source resources when updating the stack.
Always: Always refresh data source resources when updating the stack.

Return Values

Fn::GetAtt

DisableReason: The reason the resource is disabled.
Status: The instance status.
ResourceGroupId: The ID of the resource group to which the Simple Application Server belongs.
InstanceId: The instance ID of the Simple Application Server.
PlanId: The plan ID.
ResourceSpec: The resource specification.
DdosStatus: The DDoS status.
Image: The image description.
BusinessStatus: The server status.
PublicIpAddress: The public IP address.
InstanceName: The server name.
InnerIpAddress: The private IP address.
NetworkAttributes: The network-related information returned by the system.
Uuid: The UUID of the instance.
Combination: Indicates whether the plan is a combination plan.
ChargeType: The billing method of the instance.
ExpiredTime: The expiration time.
CreationTime: The creation time.
ImageId: The image ID.
PlanType: The plan type.
Disks: An array that contains disk information for the Simple Application Server.
RegionId: The region ID.
Tags: The list of tags associated with the instance.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the instance.
    Required: true
Resources:
  Instance:
    Type: DATASOURCE::SWAS::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  DisableReason:
    Description: The reason why the instance is disabled.
    Value:
      Fn::GetAtt:
        - Instance
        - DisableReason
  Status:
    Description: The status of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Status
  ResourceGroupId:
    Description: The ID of the resource group to which the instance belongs.
    Value:
      Fn::GetAtt:
        - Instance
        - ResourceGroupId
  InstanceId:
    Description: The ID of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  PlanId:
    Description: The plan ID of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - PlanId
  ResourceSpec:
    Description: The resource specification of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - ResourceSpec
  DdosStatus:
    Description: The anti-DDoS status of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - DdosStatus
  Image:
    Description: The image information of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Image
  BusinessStatus:
    Description: The business status of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - BusinessStatus
  PublicIpAddress:
    Description: The public IP address of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - PublicIpAddress
  InstanceName:
    Description: The name of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceName
  InnerIpAddress:
    Description: The private IP address of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - InnerIpAddress
  NetworkAttributes:
    Description: The network attributes of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - NetworkAttributes
  Uuid:
    Description: The unique identifier of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Uuid
  Combination:
    Description: Indicates whether the instance is a combination instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Combination
  ChargeType:
    Description: The billing method of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - ChargeType
  ExpiredTime:
    Description: The expiration time of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - ExpiredTime
  CreationTime:
    Description: The creation time of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - CreationTime
  ImageId:
    Description: The ID of the image used by the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - ImageId
  PlanType:
    Description: The plan type of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - PlanType
  Disks:
    Description: The disks of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Disks
  RegionId:
    Description: The ID of the region where the instance is deployed.
    Value:
      Fn::GetAtt:
        - Instance
        - RegionId
  Tags:
    Description: The tags of the instance.
    Value:
      Fn::GetAtt:
        - Instance
        - Tags

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "Instance": {
      "Type": "DATASOURCE::SWAS::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DisableReason": {
      "Description": "The reason why the instance is disabled.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "DisableReason"
        ]
      }
    },
    "Status": {
      "Description": "The status of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Status"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group to which the instance belongs.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "ResourceGroupId"
        ]
      }
    },
    "InstanceId": {
      "Description": "The ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "PlanId": {
      "Description": "The plan ID of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "PlanId"
        ]
      }
    },
    "ResourceSpec": {
      "Description": "The resource specification of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "ResourceSpec"
        ]
      }
    },
    "DdosStatus": {
      "Description": "The anti-DDoS status of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "DdosStatus"
        ]
      }
    },
    "Image": {
      "Description": "The image information of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Image"
        ]
      }
    },
    "BusinessStatus": {
      "Description": "The business status of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "BusinessStatus"
        ]
      }
    },
    "PublicIpAddress": {
      "Description": "The public IP address of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "PublicIpAddress"
        ]
      }
    },
    "InstanceName": {
      "Description": "The name of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceName"
        ]
      }
    },
    "InnerIpAddress": {
      "Description": "The private IP address of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InnerIpAddress"
        ]
      }
    },
    "NetworkAttributes": {
      "Description": "The network attributes of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "NetworkAttributes"
        ]
      }
    },
    "Uuid": {
      "Description": "The unique identifier of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Uuid"
        ]
      }
    },
    "Combination": {
      "Description": "Indicates whether the instance is a combination instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Combination"
        ]
      }
    },
    "ChargeType": {
      "Description": "The billing method of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "ChargeType"
        ]
      }
    },
    "ExpiredTime": {
      "Description": "The expiration time of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "ExpiredTime"
        ]
      }
    },
    "CreationTime": {
      "Description": "The creation time of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "CreationTime"
        ]
      }
    },
    "ImageId": {
      "Description": "The ID of the image used by the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "ImageId"
        ]
      }
    },
    "PlanType": {
      "Description": "The plan type of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "PlanType"
        ]
      }
    },
    "Disks": {
      "Description": "The disks of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Disks"
        ]
      }
    },
    "RegionId": {
      "Description": "The ID of the region where the instance is deployed.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "RegionId"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the instance.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "Tags"
        ]
      }
    }
  }
}