DATASOURCE::VPC::Ipv4Gateway - Resource Orchestration Service

DATASOURCE::VPC::Ipv4Gateway is used to query the information about an IPv4 gateway.

Syntax

{
  "Type": "DATASOURCE::VPC::Ipv4Gateway",
  "Properties": {
    "Ipv4GatewayId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Ipv4GatewayId

String

Yes

The ID of the IPv4 gateway.

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

Ipv4GatewayName: the name of the IPv4 gateway.
Ipv4GatewayRouteTableId: the ID of the route table that is associated with the IPv4 gateway.
Ipv4GatewayId: the ID of the IPv4 gateway.
VpcId: the ID of the virtual private cloud (VPC) that is associated with the IPv4 gateway.
CreateTime: the time when the IPv4 gateway was created.
Enabled: indicates whether the IPv4 gateway is enabled.
Ipv4GatewayDescription: the description of the IPv4 gateway.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Ipv4GatewayId:
    Description:
      en: The resource attribute field that represents the resource level 1 ID.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      Ipv4GatewayId:
        Ref: Ipv4GatewayId
    Type: DATASOURCE::VPC::Ipv4Gateway
Outputs:
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  Enabled:
    Description: Enabled.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Enabled
  Ipv4GatewayDescription:
    Description: Description information.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Ipv4GatewayDescription
  Ipv4GatewayId:
    Description: The resource attribute field that represents the resource level 1
      ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Ipv4GatewayId
  Ipv4GatewayName:
    Description: Resource name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Ipv4GatewayName
  Ipv4GatewayRouteTableId:
    Description: ID of the route table associated with IPv4 Gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Ipv4GatewayRouteTableId
  VpcId:
    Description: The ID of the VPC associated with the IPv4 Gateway.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcId

JSON

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Ipv4GatewayId": {
      "Type": "String",
      "Description": {
        "en": "The resource attribute field that represents the resource level 1 ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::Ipv4Gateway",
      "Properties": {
        "Ipv4GatewayId": {
          "Ref": "Ipv4GatewayId"
        }
      }
    }
  },
  "Outputs": {
    "Ipv4GatewayName": {
      "Description": "Resource name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ipv4GatewayName"
        ]
      }
    },
    "Ipv4GatewayRouteTableId": {
      "Description": "ID of the route table associated with IPv4 Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ipv4GatewayRouteTableId"
        ]
      }
    },
    "Ipv4GatewayId": {
      "Description": "The resource attribute field that represents the resource level 1 ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ipv4GatewayId"
        ]
      }
    },
    "VpcId": {
      "Description": "The ID of the VPC associated with the IPv4 Gateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Enabled": {
      "Description": "Enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Enabled"
        ]
      }
    },
    "Ipv4GatewayDescription": {
      "Description": "Description information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Ipv4GatewayDescription"
        ]
      }
    }
  }
}