All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::ECI::ImageCache

Last Updated:Oct 28, 2024

DATASOURCE::ECI::ImageCache is used to query the information about an image cache.

Syntax

{
  "Type": "DATASOURCE::ECI::ImageCache",
  "Properties": {
    "ImageCacheId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ImageCacheId

String

Yes

Yes

The ID of the image cache.

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

  • ImageCacheSize: the size of the image cache. Unit: GiB.

  • Progress: the progress of creating the snapshot that corresponds to the image cache.

  • ImageCacheId: the ID of the image cache.

  • ResourceGroupId: the ID of the resource group to which the image cache belongs.

  • CreateTime: the time when the image cache was created.

  • Images: the images that are contained in the image cache.

  • ImageCacheTags: the tags of the image cache.

  • SnapshotId: the ID of the snapshot that corresponds to the image cache.

  • Events: the events of pulling an image to create the image cache.

  • FlashSnapshotId: the ID of the local snapshot.

  • ImageCacheName: the name of the image cache.

  • ContainerGroupId: the ID of the container group.

  • ExpireDateTime: the expiration time.

  • EliminationStrategy: the elimination policy for the image cache. This property is empty by default, which indicates that the image cache is retained all the time.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ImageCacheId:
    Description:
      en: ImageCacheId.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      ImageCacheId:
        Ref: ImageCacheId
    Type: DATASOURCE::ECI::ImageCache
Outputs:
  ContainerGroupId:
    Description: ContainerGroupId.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ContainerGroupId
  CreateTime:
    Description: CreateTime.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  EliminationStrategy:
    Description: The elimination strategy of the mirror cache. The default is empty,
      indicating that it has been kept.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EliminationStrategy
  Events:
    Description: Events.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Events
  ExpireDateTime:
    Description: ExpireDateTime.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpireDateTime
  FlashSnapshotId:
    Description: FlashSnapshotId.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - FlashSnapshotId
  ImageCacheId:
    Description: ImageCacheId.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ImageCacheId
  ImageCacheName:
    Description: ImageCacheName.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ImageCacheName
  ImageCacheSize:
    Description: ImageCacheSize.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ImageCacheSize
  ImageCacheTags:
    Description: Tags.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ImageCacheTags
  Images:
    Description: Images.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Images
  Progress:
    Description: Progress.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Progress
  ResourceGroupId:
    Description: ResourceGroupId.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  SnapshotId:
    Description: SnapshotId.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SnapshotId
                        

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ImageCacheId": {
      "Type": "String",
      "Description": {
        "en": "ImageCacheId."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECI::ImageCache",
      "Properties": {
        "ImageCacheId": {
          "Ref": "ImageCacheId"
        }
      }
    }
  },
  "Outputs": {
    "ImageCacheSize": {
      "Description": "ImageCacheSize.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ImageCacheSize"
        ]
      }
    },
    "Progress": {
      "Description": "Progress.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Progress"
        ]
      }
    },
    "ImageCacheId": {
      "Description": "ImageCacheId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ImageCacheId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "ResourceGroupId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "CreateTime.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "Images": {
      "Description": "Images.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Images"
        ]
      }
    },
    "ImageCacheTags": {
      "Description": "Tags.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ImageCacheTags"
        ]
      }
    },
    "SnapshotId": {
      "Description": "SnapshotId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SnapshotId"
        ]
      }
    },
    "Events": {
      "Description": "Events.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Events"
        ]
      }
    },
    "FlashSnapshotId": {
      "Description": "FlashSnapshotId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "FlashSnapshotId"
        ]
      }
    },
    "ImageCacheName": {
      "Description": "ImageCacheName.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ImageCacheName"
        ]
      }
    },
    "ContainerGroupId": {
      "Description": "ContainerGroupId.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ContainerGroupId"
        ]
      }
    },
    "ExpireDateTime": {
      "Description": "ExpireDateTime.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireDateTime"
        ]
      }
    },
    "EliminationStrategy": {
      "Description": "The elimination strategy of the mirror cache. The default is empty, indicating that it has been kept.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EliminationStrategy"
        ]
      }
    }
  }
}