OpenApiImageCache

An ECI Image Cache can help user to solve the time-consuming problem of image pull. For information about Alicloud ECI Image Cache and how to use it, see What is Resource Alicloud ECI Image Cache.

NOTE: Available in v1.89.0+.
NOTE: Each image cache corresponds to a snapshot, and the user does not delete the snapshot directly, otherwise the cache will fail.

Create a OpenApiImageCache Resource

new OpenApiImageCache(name: string, args: OpenApiImageCacheArgs, opts?: CustomResourceOptions);

def OpenApiImageCache(resource_name, opts=None, eip_instance_id=None, image_cache_name=None, image_cache_size=None, image_registry_credentials=None, images=None, resource_group_id=None, retention_days=None, security_group_id=None, vswitch_id=None, zone_id=None, __props__=None);

func NewOpenApiImageCache(ctx *Context, name string, args OpenApiImageCacheArgs, opts ...ResourceOption) (*OpenApiImageCache, error)

public OpenApiImageCache(string name, OpenApiImageCacheArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OpenApiImageCacheArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args OpenApiImageCacheArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OpenApiImageCacheArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

OpenApiImageCache Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OpenApiImageCache resource accepts the following input properties:

ImageCacheName string: The name of the image cache.
Images List<string>: The images to be cached. The image name must be versioned.
SecurityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
VswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
EipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
ImageCacheSize int: The size of the image cache. Default to 20. Unit: GiB.
ImageRegistryCredentials List<Pulumi.AliCloud.Eci.Inputs.OpenApiImageCacheImageRegistryCredentialArgs>: The Image Registry parameters about the image to be cached.
ResourceGroupId string: The ID of the resource group.
RetentionDays int: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
ZoneId string: The zone id to cache image.

ImageCacheName string: The name of the image cache.
Images []string: The images to be cached. The image name must be versioned.
SecurityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
VswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
EipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
ImageCacheSize int: The size of the image cache. Default to 20. Unit: GiB.
ImageRegistryCredentials []OpenApiImageCacheImageRegistryCredential: The Image Registry parameters about the image to be cached.
ResourceGroupId string: The ID of the resource group.
RetentionDays int: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
ZoneId string: The zone id to cache image.

imageCacheName string: The name of the image cache.
images string[]: The images to be cached. The image name must be versioned.
securityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
vswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
eipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
imageCacheSize number: The size of the image cache. Default to 20. Unit: GiB.
imageRegistryCredentials OpenApiImageCacheImageRegistryCredential[]: The Image Registry parameters about the image to be cached.
resourceGroupId string: The ID of the resource group.
retentionDays number: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
zoneId string: The zone id to cache image.

image_cache_name str: The name of the image cache.
images List[str]: The images to be cached. The image name must be versioned.
security_group_id str: The ID of the security group. You do not need to specify the same security group as the container group.
vswitch_id str: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
eip_instance_id str: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
image_cache_size float: The size of the image cache. Default to 20. Unit: GiB.
image_registry_credentials List[OpenApiImageCacheImageRegistryCredential]: The Image Registry parameters about the image to be cached.
resource_group_id str: The ID of the resource group.
retention_days float: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
zone_id str: The zone id to cache image.

Outputs

All input properties are implicitly available as output properties. Additionally, the OpenApiImageCache resource produces the following output properties:

ContainerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
Id string: The provider-assigned unique ID for this managed resource.
Status string

ContainerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
Id string: The provider-assigned unique ID for this managed resource.
Status string

containerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
id string: The provider-assigned unique ID for this managed resource.
status string

container_group_id str: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
id str: The provider-assigned unique ID for this managed resource.
status str

Look up an Existing OpenApiImageCache Resource

Get an existing OpenApiImageCache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OpenApiImageCacheState, opts?: CustomResourceOptions): OpenApiImageCache

static get(resource_name, id, opts=None, container_group_id=None, eip_instance_id=None, image_cache_name=None, image_cache_size=None, image_registry_credentials=None, images=None, resource_group_id=None, retention_days=None, security_group_id=None, status=None, vswitch_id=None, zone_id=None, __props__=None);

func GetOpenApiImageCache(ctx *Context, name string, id IDInput, state *OpenApiImageCacheState, opts ...ResourceOption) (*OpenApiImageCache, error)

public static OpenApiImageCache Get(string name, Input<string> id, OpenApiImageCacheState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ContainerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
EipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
ImageCacheName string: The name of the image cache.
ImageCacheSize int: The size of the image cache. Default to 20. Unit: GiB.
ImageRegistryCredentials List<Pulumi.AliCloud.Eci.Inputs.OpenApiImageCacheImageRegistryCredentialArgs>: The Image Registry parameters about the image to be cached.
Images List<string>: The images to be cached. The image name must be versioned.
ResourceGroupId string: The ID of the resource group.
RetentionDays int: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
SecurityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
Status string
VswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
ZoneId string: The zone id to cache image.

ContainerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
EipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
ImageCacheName string: The name of the image cache.
ImageCacheSize int: The size of the image cache. Default to 20. Unit: GiB.
ImageRegistryCredentials []OpenApiImageCacheImageRegistryCredential: The Image Registry parameters about the image to be cached.
Images []string: The images to be cached. The image name must be versioned.
ResourceGroupId string: The ID of the resource group.
RetentionDays int: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
SecurityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
Status string
VswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
ZoneId string: The zone id to cache image.

containerGroupId string: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
eipInstanceId string: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
imageCacheName string: The name of the image cache.
imageCacheSize number: The size of the image cache. Default to 20. Unit: GiB.
imageRegistryCredentials OpenApiImageCacheImageRegistryCredential[]: The Image Registry parameters about the image to be cached.
images string[]: The images to be cached. The image name must be versioned.
resourceGroupId string: The ID of the resource group.
retentionDays number: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
securityGroupId string: The ID of the security group. You do not need to specify the same security group as the container group.
status string
vswitchId string: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
zoneId string: The zone id to cache image.

container_group_id str: The ID of the container group job that is used to create the image cache. * status -The status of the image cache.
eip_instance_id str: The instance ID of the Elastic IP Address (EIP). If you want to pull images from the Internet, you must specify an EIP to make sure that the container group can access the Internet. You can also configure the network address translation (NAT) gateway. We recommend that you configure the NAT gateway for the Internet access. Refer to Public Network Access Method
image_cache_name str: The name of the image cache.
image_cache_size float: The size of the image cache. Default to 20. Unit: GiB.
image_registry_credentials List[OpenApiImageCacheImageRegistryCredential]: The Image Registry parameters about the image to be cached.
images List[str]: The images to be cached. The image name must be versioned.
resource_group_id str: The ID of the resource group.
retention_days float: The retention days of the image cache. Once the image cache expires, it will be cleared. By default, the image cache never expires. Note: The image cache that fails to be created is retained for only one day.
security_group_id str: The ID of the security group. You do not need to specify the same security group as the container group.
status str
vswitch_id str: The ID of the VSwitch. You do not need to specify the same VSwitch as the container group.
zone_id str: The zone id to cache image.

Supporting Types

OpenApiImageCacheImageRegistryCredential

See the input and output API doc for this type.

Password string: The password of the Image Registry.
Server string: The address of Image Registry without http:// or https://.
UserName string: The user name of Image Registry.

Password string: The password of the Image Registry.
Server string: The address of Image Registry without http:// or https://.
UserName string: The user name of Image Registry.

password string: The password of the Image Registry.
server string: The address of Image Registry without http:// or https://.
userName string: The user name of Image Registry.

password str: The password of the Image Registry.
server str: The address of Image Registry without http:// or https://.
user_name str: The user name of Image Registry.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud