DATASOURCE::VPC::CustomerGateways

Updated at: 2024-12-26 10:38

DATASOURCE::VPC::CustomerGateways is used to query customer gateways.

Syntax

{
  "Type": "DATASOURCE::VPC::CustomerGateways",
  "Properties": {
    "CustomerGatewayId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

Property

Type

Required

Editable

Description

Constraint

CustomerGatewayId

String

No

Yes

The ID of the customer gateway.

None.

RefreshOptions

String

No

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

  • CustomerGateways: details of the customer gateways.

  • CustomerGatewayIds: the IDs of the customer gateways.

Property

Type

Description

Constraint

CustomerGatewayIds

List

The IDs of the customer gateways.

None.

CustomerGateways

List

Details of the customer gateways.

None.

CustomerGatewayName

String

The name of the customer gateway.

None.

Description

String

The description of the customer gateway.

None.

Asn

Number

The autonomous system number (ASN) of the gateway device in the data center.

None.

AuthKey

String

The authentication key of the Border Gateway Protocol (BGP) routing protocol for the gateway device in the data center.

None.

CustomerGatewayId

String

The ID of the customer gateway.

None.

IpAddress

String

The public IP address of the gateway device in the data center.

None.

CreateTime

String

The timestamp generated when the customer gateway was created.

Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Examples

YAML
JSON
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CustomerGatewayId:
    Description: The ID of the customer gateway.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      CustomerGatewayId:
        Ref: CustomerGatewayId
    Type: DATASOURCE::VPC::CustomerGateways
Outputs:
  CustomerGatewayIds:
    Description: The list of customer gateway IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGatewayIds
  CustomerGateways:
    Description: The list of customer gateways.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CustomerGateways
JSON format
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CustomerGatewayId": {
      "Type": "String",
      "Description": "The ID of the customer gateway."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::VPC::CustomerGateways",
      "Properties": {
        "CustomerGatewayId": {
          "Ref": "CustomerGatewayId"
        }
      }
    }
  },
  "Outputs": {
    "CustomerGateways": {
      "Description": "The list of customer gateways.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGateways"
        ]
      }
    },
    "CustomerGatewayIds": {
      "Description": "The list of customer gateway IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CustomerGatewayIds"
        ]
      }
    }
  }
}
  • On this page (1, T)
  • Syntax
  • Properties
  • Return values
  • Examples
Feedback