DATASOURCE::EAIS::ClientInstanceAttachment - Resource Orchestration Service

DATASOURCE::EAIS::ClientInstanceAttachment is used to query the information about an Elastic Accelerated Computing Instances (EAIS) instance attached to an Elastic Compute Service (ECS) instance or elastic container instance.

Syntax

{
  "Type": "DATASOURCE::EAIS::ClientInstanceAttachment",
  "Properties": {
    "ClientInstanceAttachmentId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ClientInstanceAttachmentId

String

Yes

The ID of the ECS instance or elastic container instance to which the EAIS instance is attached.

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

InstanceId: the ID of the EAIS instance.
VSwitchId: the ID of the vSwitch.
SecurityGroupId: the ID of the security group.
ClientInstanceId: the ID of the ECS instance or elastic container instance to which the EAIS instance is attached.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClientInstanceAttachmentId:
    Type: String
    Description:
      en: The ID of the ECS or ECI instance bound to the EAIS instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::EAIS::ClientInstanceAttachment
    Properties:
      ClientInstanceAttachmentId:
        Ref: ClientInstanceAttachmentId
Outputs:
  InstanceId:
    Description: The EAIS instance ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  VSwitchId:
    Description: The vSwitch ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VSwitchId
  SecurityGroupId:
    Description: The ID of the security group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecurityGroupId
  ClientInstanceId:
    Description: The ID of the ECS or ECI instance bound to the EAIS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ClientInstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClientInstanceAttachmentId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the ECS or ECI instance bound to the EAIS instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::EAIS::ClientInstanceAttachment",
      "Properties": {
        "ClientInstanceAttachmentId": {
          "Ref": "ClientInstanceAttachmentId"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Description": "The EAIS instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "The vSwitch ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "The ID of the security group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupId"
        ]
      }
    },
    "ClientInstanceId": {
      "Description": "The ID of the ECS or ECI instance bound to the EAIS instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ClientInstanceId"
        ]
      }
    }
  }
}