DATASOURCE::DirectMail::Ipfilter - Resource Orchestration Service

DATASOURCE::DirectMail::Ipfilter is used to query the information about an IP filter.

Syntax

{
  "Type": "DATASOURCE::DirectMail::Ipfilter",
  "Properties": {
    "IpfilterId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

IpfilterId

String

Yes

The ID of the IP filter.

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

CreateTime: the creation timestamp.
IpAddress: the IP address, IP range, or CIDR block.
IpfilterId: the ID of the IP filter.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IpfilterId:
    Type: String
    Description:
      en: The ID of the resource.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DirectMail::Ipfilter
    Properties:
      IpfilterId:
        Ref: IpfilterId
Outputs:
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  IpAddress:
    Description: The IP address of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IpAddress
  IpfilterId:
    Description: The ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IpfilterId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IpfilterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the resource."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DirectMail::Ipfilter",
      "Properties": {
        "IpfilterId": {
          "Ref": "IpfilterId"
        }
      }
    }
  },
  "Outputs": {
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "IpAddress": {
      "Description": "The IP address of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpAddress"
        ]
      }
    },
    "IpfilterId": {
      "Description": "The ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IpfilterId"
        ]
      }
    }
  }
}