ALIYUN::ECI::ImageCache is used to create an image cache.

Syntax

{
  "Type": "ALIYUN::ECI::ImageCache",
  "Properties": {
    "EipInstanceId": String,
    "Image": List,
    "SecurityGroupId": String,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "ImageRegistryCredential": List,
    "ImageCacheName": String
  }
}

Properties

Name Type Required Editable Description Validity
EipInstanceId String No No The ID of an EIP instance. Make sure that your ECI can access the Internet before pulling public images. We recommend that you configure a NAT gateway for your VSwitch. You can also configure a public IP address.
Image List Yes No The IDs of images to be cached. A maximum of 20 images can be cached.
SecurityGroupId String Yes No The ID of the security group. None
ResourceGroupId String No No The ID of the resource group. None
VSwitchId String Yes No The ID of the VSwitch. None
ImageRegistryCredential List No No The credentials used to log on to image repositories. This parameter is optional for images stored in Alibaba Cloud Container Registry (ACR). A maximum of 10 credentials can be configured.
ImageCacheName String Yes No The name of the image cache. None

ImageRegistryCredential syntax

"ImageRegistryCredential": [
  {
    "Server": String,
    "UserName": String,
    "Password": String
  }
]

ImageRegistryCredential properties

Name Type Required Editable Description Validity
Server String No No The URL of the image repository. This URL does not include a protocol prefix, such as http:// or https://. None
UserName String No No The username that is used to log on to the image repository. None
Password String No No The password that is used to log on to the image repository. None

Response parameters

Fn::GetAtt

  • ImageCacheId: the ID of the image cache.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "ImageCache": {
      "Type": "ALIYUN::ECI::ImageCache",
      "Properties": {
        "EipInstanceId": {
          "Ref": "EipInstanceId"
        },
        "Image": {
          "Ref": "Image"
        },
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "ImageRegistryCredential": {
          "Ref": "ImageRegistryCredential"
        },
        "ImageCacheName": {
          "Ref": "ImageCacheName"
        }
      }
    }
  },
  "Parameters": {
    "EipInstanceId": {
      "Type": "String",
      "Description": "If you want to pull the public network image, you need to configure the public network ip or configure the switch NAT gateway."
    },
    "Image": {
      "Type": "Json",
      "Description": "The image list to be cached.",
      "MaxLength": 20
    },
    "SecurityGroupId": {
      "Type": "String",
      "Description": "Security group ID."
    },
    "ResourceGroupId": {
      "Type": "String",
      "Description": "Resource group."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "VSwitch ID."
    },
    "ImageRegistryCredential": {
      "Type": "Json",
      "Description": "Private image password. Alibaba Cloud ACR image can be left blank.",
      "MaxLength": 10
    },
    "ImageCacheName": {
      "Type": "String",
      "Description": "Image cache name."
    }
  },
  "Outputs": {
    "ImageCacheId": {
      "Description": "The ID of the image cache.",
      "Value": {
        "Fn::GetAtt": [
          "ImageCache",
          "ImageCacheId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  ImageCache:
    Type: ALIYUN::ECI::ImageCache
    Properties:
      EipInstanceId:
        Ref: EipInstanceId
      Image:
        Ref: Image
      SecurityGroupId:
        Ref: SecurityGroupId
      ResourceGroupId:
        Ref: ResourceGroupId
      VSwitchId:
        Ref: VSwitchId
      ImageRegistryCredential:
        Ref: ImageRegistryCredential
      ImageCacheName:
        Ref: ImageCacheName
Parameters:
  EipInstanceId:
    Type: String
    Description: If you want to pull the public network image, you need to configure
      the public network ip or configure the switch NAT gateway.
  Image:
    Type: Json
    Description: The image list to be cached.
    MaxLength: 20
  SecurityGroupId:
    Type: String
    Description: Security group ID.
  ResourceGroupId:
    Type: String
    Description: Resource group.
  VSwitchId:
    Type: String
    Description: VSwitch ID.
  ImageRegistryCredential:
    Type: Json
    Description: Private image password. Alibaba Cloud ACR image can be left blank.
    MaxLength: 10
  ImageCacheName:
    Type: String
    Description: Image cache name.
Outputs:
  ImageCacheId:
    Description: The ID of the image cache.
    Value:
      Fn::GetAtt:
      - ImageCache
      - ImageCacheId