All Products
Search
Document Center

Resource Orchestration Service:CAS Resources

Last Updated:Apr 02, 2026

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CAS::Certificate::CertificateId

The certificate of the SLB instance.

RegionId: The region ID. The default value is the region where the stack resides.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Certificate": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CAS::Certificate::CertificateId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Certificate:
        Type: String
        AssociationProperty: ALIYUN::CAS::Certificate::CertificateId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain the SLB service certificate in the current region by setting the AssociationProperty of the Certificate parameter to ALIYUN::CAS::Certificate::CertificateId and the AssociationPropertyMetadata to RegionId.

CEN Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CEN::Instance::CenId

Query the Cloud Enterprise Network (CEN) instance information under the current Alibaba Cloud account.

  • ResourceGroupId: The ID of the resource group to which the CEN instance belongs.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ResourceGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
    },
    "CenId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::Instance::CenId",
      "AssociationPropertyMetadata": {
        "ResourceGroupId": "${ResourceGroupId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ResourceGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  CenId:
    Type: String
    AssociationProperty: ALIYUN::CEN::Instance::CenId
    AssociationPropertyMetadata:
      ResourceGroupId: ${ResourceGroupId}

ALIYUN::CEN::TransitRouter::TransitRouterId

Query the TransitRouter instance information under the CEN instance.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • CenId: The CEN instance ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ResourceGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
    },
    "CenId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::Instance::CenId",
      "AssociationPropertyMetadata": {
        "ResourceGroupId": "${ResourceGroupId}"
      }
    },
    "TransitRouterId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CEN::TransitRouter::TransitRouterId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "CenId": "${CenId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ResourceGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  CenId:
    Type: String
    AssociationProperty: ALIYUN::CEN::Instance::CenId
    AssociationPropertyMetadata:
      ResourceGroupId: ${ResourceGroupId}
  TransitRouterId:
    Type: String
    AssociationProperty: ALIYUN::CEN::TransitRouter::TransitRouterId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      CenId: ${CenId}

CMS Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CMS::Alarm::MetricSelector

Query details of metrics exposed by Cloud Monitor.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CMSMetricSelector": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CMS::Alarm::MetricSelector"
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CMSMetricSelector:
    Type: String
    AssociationProperty: ALIYUN::CMS::Alarm::MetricSelector

ALIYUN::CMS::Alarm::Rule

Threshold alert rule.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Rule": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::Rule",
          "Type": "String",
          "Description": {
            "zh-cn": "Select threshold alert rule",
            "en": "AlarmRule"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Rule:
        AssociationProperty: ALIYUN::CMS::Alarm::Rule
        Type: String
        Description:
          zh-cn: Select threshold alert rule
          en: AlarmRule
  • Example description

    This example shows how to obtain the threshold alert rule by setting the AssociationProperty of the Rule parameter to ALIYUN::CMS::Alarm::Rule.

ALIYUN::CMS::Alarm::SilenceTime

Alert silence period.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "SilenceTime": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::SilenceTime",
          "Type": "String",
          "Description": {
            "zh-cn": "Alert silence period",
            "en": "SilenceTime"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      SilenceTime:
        AssociationProperty: ALIYUN::CMS::Alarm::SilenceTime
        Type: String
        Description:
          zh-cn: Alert silence period
          en: SilenceTime
  • Example description

    This example shows how to obtain the alert silence period by setting the AssociationProperty of the SilenceTime parameter to ALIYUN::CMS::Alarm::SilenceTime.

ALIYUN::CMS::Alarm::TriggerResources

Alert resource trigger.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TriggerResources": {
          "AssociationProperty": "ALIYUN::CMS::Alarm::TriggerResources",
          "Type": "String",
          "Description": {
            "zh-cn": "Select alert resource trigger",
            "en": "TriggerResources"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TriggerResources:
        AssociationProperty: ALIYUN::CMS::Alarm::TriggerResources
        Type: String
        Description:
          zh-cn: Select alert resource trigger
          en: TriggerResources
  • Example description

    This example shows how to obtain the alert resource trigger by setting the AssociationProperty of the TriggerResources parameter to ALIYUN::CMS::Alarm::TriggerResources.

ALIYUN::CMS::Event::EventFilterRule

Event-triggered alert rule.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventRule": {
          "AssociationProperty": "ALIYUN::CMS::Event::EventFilterRule",
          "Type": "String",
          "Description": {
            "zh-cn": "Select Event-triggered Alert Rule",
            "en": "EventRule"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventRule:
        AssociationProperty: ALIYUN::CMS::Event::EventFilterRule
        Type: String
        Description:
          zh-cn: Select Event-triggered Alert Rule
          en: EventRule
  • Example description

    This example shows how to obtain the event-triggered alert rule by setting the AssociationProperty of the EventRule parameter to ALIYUN::CMS::Event::EventFilterRule.

ALIYUN::CMS::Event::EventLevel

Alert level.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventLevel": {
          "AssociationProperty": "ALIYUN::CMS::Event::EventLevel",
          "Type": "String",
          "Description": {
            "zh-cn": "Select event alert level",
            "en": "EventLevel"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventLevel:
        AssociationProperty: ALIYUN::CMS::Event::EventLevel
        Type: String
        Description:
          zh-cn: Select event alert level
          en: EventLevel
  • Example description

    This example shows how to obtain the alert level by setting the AssociationProperty of the EventLevel parameter to ALIYUN::CMS::Event::EventLevel.

ALIYUN::CMS::Event::EventName

Event alert name.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "EventName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CMS::Event::EventName",
          "Description": {
            "zh-cn": "Select event alert name",
            "en": "EventName"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      EventName:
        AssociationProperty: ALIYUN::CMS::Event::EventName
        Type: String
        Description:
          zh-cn: Select event alert name
          en: EventName
  • Example description

    This example shows how to obtain the event alert name by setting the AssociationProperty of the EventName parameter to ALIYUN::CMS::Event::EventName.

ALIYUN::CMS::Product::ProductType

Alibaba Cloud services that support events.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ProductType": {
          "AssociationProperty": "ALIYUN::CMS::Product::ProductType",
          "Type": "String",
          "Description": {
            "zh-cn": "Select event alert name",
            "en": "ProductType"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ProductType:
        AssociationProperty: ALIYUN::CMS::Product::ProductType
        Type: String
        Description:
          zh-cn: Select event alert name
          en: ProductType
  • Example description

    This example shows how to obtain the Alibaba Cloud services that support events by setting the AssociationProperty of the ProductType parameter to ALIYUN::CMS::Product::ProductType.

CR Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CR::Instance::InstanceId

Query enterprise container image instance information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • InstanceStatus: The instance status. Valid values:

    • PENDING: Initializing.

    • INIT_ERROR: Initialization failed.

    • STARTING: Starting.

    • RUNNING: Running.

    • STOPPING: Stopping.

    • STOPPED: Stopped.

    • DELETING: Deleting.

    • DELETED: Deleted.

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "CRInstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CR::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "InstanceStatus": "RUNNING"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      CRInstanceId:
        Type: String
        AssociationProperty: ALIYUN::CR::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          InstanceStatus: RUNNING

ALIYUN::CR::NameSpace::Name

Query enterprise container image namespace information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • NamespaceStatus: The namespace status. Valid values:

    • NORMAL: Normal.

    • DELETING: Deleting.

  • InstanceId: The instance ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRNameSpace": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::NameSpace::Name",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "NamespaceStatus": "NORMAL"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRNameSpace:
    Type: String
    AssociationProperty: ALIYUN::CR::NameSpace::Name
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      NamespaceStatus: NORMAL

ALIYUN::CR::Repository::RepoName

Query enterprise container image repository information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • RepoStatus: The repository status. Valid values:

    • NORMAL: Normal.

    • DELETING: Deleting.

    • DELETED: Deleted.

    • ALL: All repository statuses.

  • InstanceId: The instance ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRRepository": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::Repository::RepoName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "RepoStatus": "NORMAL"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRRepository:
    Type: String
    AssociationProperty: ALIYUN::CR::Repository::RepoName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      RepoStatus: NORMAL

ALIYUN::CR::Repository::Tag

Query enterprise container image version (Tag) information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • RepoId: The repository ID.

  • InstanceId: The instance ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "CRRepositoryTag": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::Repository::Tag",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  CRRepositoryTag:
    Type: String
    AssociationProperty: ALIYUN::CR::Repository::Tag
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

CS Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::CS::Cluster::ClusterId

The container cluster ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ClusterState: The cluster status.

    • running: Running.

    • initial: Initializing.

    • unavailable: Unavailable.

    • all: Any status.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ClusterId":{
          "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ClusterId:
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain the container cluster ID by setting the AssociationProperty of the ClusterId parameter to ALIYUN::CS::Cluster::ClusterId.

ALIYUN::CS::Cluster::ClusterNodePool

The node pool in the container cluster.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ClusterId: The container cluster ID.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ClusterId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::CS::Cluster::ClusterId"
        },
        "ClusterNodePool":{
          "AssociationProperty":"ALIYUN::CS::Cluster::ClusterId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ClusterId": "${ClusterId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ClusterId:
        Type: String
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
      ClusterNodePool:
        AssociationProperty: ALIYUN::CS::Cluster::ClusterId
        Type: String
        AssociationPropertyMetadata:
          ClusterId: ${ClusterId}
  • Example description

    This example shows how to obtain the node pool in the container cluster by setting the AssociationProperty of the ClusterNodePool parameter to ALIYUN::CS::Cluster::ClusterNodePool.

ALIYUN::CS::Cluster::KubernetesVersion

Query Kubernetes version information.

  • ClusterType: The cluster type.

    • Kubernetes: ACK dedicated cluster.

    • ManagedKubernetes: ACK managed cluster, including ACK Pro cluster, ACK Basic cluster, ACK Serverless Pro cluster, ACK Serverless Basic cluster, ACK Edge Pro cluster, and ACK Edge Basic cluster.

    • ExternalKubernetes: ACK registered cluster.

  • Profile: The cluster type for specific scenarios.

    • Default: Non-edge scenario cluster.

    • Edge: Edge scenario cluster.

    • Serverless: ASK cluster.

  • Runtime: The runtime type.

    • docker: Docker runtime.

    • containerd: Containerd runtime.

    • Sandboxed-Container.runv: Sandboxed container.

  • KubernetesVersionPrefix: The version prefix.

  • AutoSelectLatest: Automatically select the latest version.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CSManagedKubernetesClusterServiceCidr": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CS::Cluster::KubernetesVersion",
      "AssociationPropertyMetadata": {
        "AutoSelectLastest": true
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CSManagedKubernetesClusterServiceCidr:
    Type: String
    AssociationProperty: ALIYUN::CS::Cluster::KubernetesVersion
    AssociationPropertyMetadata:
      AutoSelectLastest: true

ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr

Query Kubernetes managed cluster Service CIDR information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ClusterType: The cluster type.

  • VpcId: The virtual private cloud (VPC) ID.

  • NodeCidrMask: The maximum number of IP addresses for nodes.

  • ContainerCidr: The container CIDR block.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "CSManagedKubernetesClusterServiceCidr": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "VpcId": "${VpcId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  CSManagedKubernetesClusterServiceCidr:
    Type: String
    AssociationProperty: ALIYUN::CS::ManagedKubernetesCluster::ServiceCidr
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      VpcId: ${VpcId}

Compute Nest Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ComputeNest::Artifact::ArtifactId

Query Compute Nest deployment artifact information.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ArtifactType: The deployment artifact type.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ComputeNestArtifactArtifactId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ComputeNestArtifactArtifactId:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::ComputeNest::Artifact::ArtifactIdVersion

Query Compute Nest deployment artifact version information.

  • ArtifactId: The deployment artifact ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ComputeNestArtifactArtifactId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ComputeNestArtifactArtifactIdVersion": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ComputeNest::Artifact::ArtifactIdVersion",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ArtifactId": "${ComputeNestArtifactArtifactId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ComputeNestArtifactArtifactId:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ComputeNestArtifactArtifactIdVersion:
    Type: String
    AssociationProperty: ALIYUN::ComputeNest::Artifact::ArtifactIdVersion
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ArtifactId: ${ComputeNestArtifactArtifactId}

ALIYUN::ComputeNest::Service::ServiceId

The Compute Nest service ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • InUsed: Indicates whether the service is in use.

  • IsVendor: Indicates whether a service provider exists.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ServiceId":{
          "AssociationProperty":"ALIYUN::ComputeNest::Service::ServiceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ServiceId:
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain the Compute Nest service ID by setting the AssociationProperty of the ServiceId parameter to ALIYUN::ComputeNest::Service::ServiceId.

ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId

The Compute Nest service instance ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ServiceType: The service type.

  • DeployType: The deployment type.

  • Status: The service status.

  • ServiceId: The service ID.

  • Version: The service version.

  • IsVendor: Indicates whether a service provider exists.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceInstanceId":{
          "AssociationProperty":"ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceInstanceId:
        AssociationProperty: ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    This example shows how to obtain the Compute Nest service instance ID by setting the AssociationProperty of the ServiceInstanceId parameter to ALIYUN::ComputeNest::ServiceInstance::ServiceInstanceId.

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The Compute Nest service version.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ServiceId: The service ID.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceVersion":{
          "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceVersion:
        AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    This example shows how to obtain the Compute Nest service version by setting the AssociationProperty of the ServiceVersion parameter to ALIYUN::ComputeNestSupplier::Service::ServiceVersion.

ComputeNestSupplier Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ComputeNestSupplier::Service::ServiceVersion

The Compute Nest service version.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ServiceId: The service ID.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ServiceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ComputeNest::Service::ServiceId"
        },
        "ServiceVersion":{
          "AssociationProperty":"ALIYUN::ComputeNestSupplier::Service::ServiceVersion",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "ServiceId": "${ServiceId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ServiceId:
        Type: String
        AssociationProperty: ALIYUN::ComputeNest::Service::ServiceId
      ServiceVersion:
        AssociationProperty: ALIYUN::ComputeNestSupplier::Service::ServiceVersion
        Type: String
        AssociationPropertyMetadata:
          ServiceId: ${ServiceId}
  • Example description

    This example shows how to obtain the Compute Nest service version by setting the AssociationProperty of the ServiceVersion parameter to ALIYUN::ComputeNestSupplier::Service::ServiceVersion.

DNS Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::DNS::Domain::ValidateDomain

Validate DNS domain name availability.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • DomainType: The domain name type.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DNSValidateDomain": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DNS::Domain::ValidateDomain",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DNSValidateDomain:
    Type: String
    AssociationProperty: ALIYUN::DNS::Domain::ValidateDomain
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

DashVector Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::DashVector::ApiKey

Query the AISearch API key.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DashVectorApiKey": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::DashVector::ApiKey"
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DashVectorApiKey:
    Type: String
    AssociationProperty: ALIYUN::DashVector::ApiKey

Domain Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Domain::DomainName

Query domain name information.

  • ShowDomainPrefixInput: Indicates whether to allow entering a domain name prefix.

  • MaxLength: The domain name length limit.

  • CheckICP: Check the ICP filing status.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DomainName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::Domain::DomainName "
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DomainName:
    Type: String
    AssociationProperty: 'ALIYUN::Domain::DomainName'

EAS Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::EAS::Instance::InstanceType

Query EAS instance types.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • SubscriptionType: The billing method. Valid values:

    • Subscription: upfront.

    • PayAsYouGo: Pay-as-you-go.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASInstanceType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Instance::InstanceType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "SubscriptionType": "PayAsYouGo"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  EASInstanceType:
    Type: String
    AssociationProperty: ALIYUN::EAS::Instance::InstanceType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      SubscriptionType: PayAsYouGo

ALIYUN::EAS::Resource::ResourceId

Query EAS resource group information.

  • RegionId: The region ID. The default value is the region where the stack resides.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "EASResourceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::EAS::Resource::ResourceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  EASResourceId:
    Type: String
    AssociationProperty: ALIYUN::EAS::Resource::ResourceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ECD Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ECD::Bundle::DesktopType

Query the details of desktop types.

  • RegionId: The region ID. The default value is the region where the stack resides.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "DesktopType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECD::Bundle::DesktopType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  DesktopType:
    Type: String
    AssociationProperty: ALIYUN::ECD::Bundle::DesktopType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ECI Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ECI::ContainerGroup::ContainerGroupId

Query the container group information of ECI instances.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • VSwitchId: The ID of the vSwitch to which the instance belongs.

  • ZoneId: The zone to which the instance belongs.

  • SecurityGroupId: The ID of the security group to which the instance belongs.

  • ComputeCategory: The computing power category.

  • Status: The instance status. Valid values:

    • Pending: Starting.

    • Running: Running.

    • Run succeeded.

    • Failed: Failed.

    • Scheduling: Creating.

    • ScheduleFailed: Creation failed.

    • Restarting: Restarting.

    • Updating: Updating.

    • Terminating: Terminating.

    • Expired: Expired.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECIContainerGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECI::ContainerGroup::ContainerGroupId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Status": "Running"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECIContainerGroupId:
    Type: String
    AssociationProperty: ALIYUN::ECI::ContainerGroup::ContainerGroupId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Status: Running

ECS Resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ECS::ZoneId

Query ECS zone IDs.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • SystemDiskCategory: The system disk type.

  • InstanceType: The instance type.

  • InstanceChargeType: The instance billing method.

  • WithAvailableResource: Filters zones that have inventory for any instance type.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ZoneId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ZoneId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}

ALIYUN::ECS::Command::CommandId

The Cloud Assistant command ID or Alibaba Cloud command ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ImageId: The image ID.

    Limits the types of commands to display based on the image's OSType.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "CommandId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Command::CommandId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      CommandId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Command::CommandId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain ECS Cloud Assistant commands or public commands provided by Alibaba Cloud in the current region by setting the AssociationProperty of the CommandId parameter to ALIYUN::ECS::Command::CommandId and the AssociationPropertyMetadata to RegionId.

ALIYUN::ECS::DeploymentSet::DeploymentSetId

Query the deployment set ID of an ECS deployment set.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • Strategy: The deployment policy. Valid values:

    • Availability: High availability policy.

    • AvailabilityGroup: Deployment cluster high availability policy.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECSDeploymentSetId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::DeploymentSet::DeploymentSetId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "Strategy": "Availability"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECSDeploymentSetId:
    Type: String
    AssociationProperty: ALIYUN::ECS::DeploymentSet::DeploymentSetId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      Strategy: Availability

ALIYUN::ECS::Disk::DataDiskCategory

The data disk type.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ZoneId: The zone ID.

  • InstanceType: The instance type.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        },
        "DataDiskCategory": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DataDiskCategory",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "InstanceType": "${InstanceType}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
      DataDiskCategory:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DataDiskCategory
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          InstanceType: ${InstanceType}
  • Example description

    This example shows how to obtain the ECS data disk type by setting the AssociationProperty of the DataDiskCategory parameter to ALIYUN::ECS::Disk::DataDiskCategory and the AssociationPropertyMetadata to RegionId, ZoneId, and InstanceType.

ALIYUN::ECS::Disk::DiskId

The disk ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ZoneId: The zone ID.

  • InstanceId: The instance ID.

  • DiskType: The disk type.

  • Category: The instance type.

  • SnapshotId: The snapshot ID.

  • DiskChargeType: The disk billing method.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "DiskId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DiskId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      DiskId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DiskId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain the ECS cloud disk ID in the current zone by setting the AssociationProperty of the DiskId parameter to ALIYUN::ECS::Disk::DiskId and the AssociationPropertyMetadata to RegionId.

ALIYUN::ECS::Disk::SystemDiskCategory

The system disk type.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ZoneId: The zone ID.

  • InstanceType: The instance type.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        },
        "SystemDiskCategory": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::SystemDiskCategory",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}",
            "InstanceType": "${InstanceType}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
      SystemDiskCategory:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::SystemDiskCategory
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
          InstanceType: ${InstanceType}
  • Example description

    This example shows how to obtain the ECS system disk type by setting the AssociationProperty of the SystemDiskCategory parameter to ALIYUN::ECS::Disk::SystemDiskCategory and the AssociationPropertyMetadata to RegionId, ZoneId, and InstanceType.

ALIYUN::ECS::Image::ImageId

The image ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • SupportedImageOwnerAlias: The supported image type.

  • InstanceType: The instance type.

  • ImageFamily: The image family name.

  • IsSupportIoOptimized: Indicates whether the image can run on an I/O optimized instance.

  • OSType: The operating system type.

  • Architecture: The image architecture.

  • Usage: Indicates whether the image is currently running on an ECS instance.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ImageId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Image::ImageId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "SupportedImageOwnerAlias": ["system", "self", "others"]
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ImageId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Image::ImageId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          SupportedImageOwnerAlias:
            - system
            - self
            - others
  • Example description

    This example shows how to obtain the ECS image ID in the current zone by setting the AssociationProperty of the ImageId parameter to ALIYUN::ECS::Image::ImageId and the AssociationPropertyMetadata to RegionId and SupportedImageOwnerAlias.

ALIYUN::ECS::Instance::AttributeSelector

The ECS attribute selector.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AttributeSelector": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::AttributeSelector"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AttributeSelector:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::AttributeSelector
  • Example description

    This example shows how to obtain the ECS attribute selector by setting the AssociationProperty of the AttributeSelector parameter to ALIYUN::ECS::Instance::AttributeSelector.

ALIYUN::ECS::Instance::InstanceId

The ECS instance ID.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • InstanceType: The instance type.

  • InstanceTypeFamily: The instance family.

  • Platform: The operating system platform.

  • OSType: The operating system type.

  • Status: The instance status.

  • NetworkType: The instance network type.

  • DisabledNetworkType: Disables network type.

  • ShowNetworkType: Displays instance network type.

  • InternetChargeType: The public bandwidth billing method.

  • DisabledInternetChargeType: Disables public bandwidth billing method.

  • ShowInternetChargeType: Displays public bandwidth billing method.

  • ChargeType: The instance billing method.

  • DisabledChargeType: Disables instance billing method.

  • ShowChargeType: Displays instance billing method.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example shows how to obtain existing Elastic Compute Service (ECS) instances in the current available region by setting the AssociationProperty of the InstanceId parameter to ALIYUN::ECS::Instance::InstanceId and the AssociationPropertyMetadata to RegionId.

ALIYUN::ECS::Instance::InstancePropertyEditor

The ECS instance property editor.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstancePropertyEditor": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstancePropertyEditor"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstancePropertyEditor:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstancePropertyEditor
  • Example description

    This example shows how to obtain the ECS instance property editor by setting the AssociationProperty of the InstancePropertyEditor parameter to ALIYUN::ECS::Instance::InstancePropertyEditor.

ALIYUN::ECS::Instance::InstanceType

The ECS instance type.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • ZoneId: The zone ID.

  • InstanceChargeType: The instance billing method.

  • SpotStrategy: The bidding policy for pay-as-you-go instances.

  • CreateACKClusterParams: Filters ECS instance types supported by container service.

    • NetworkPlugin: The network plugin, such as terway-eniip.

  • Constraints: Defines instance type filtering conditions (allows multiple condition combinations).

    • InstanceType: The instance type, such as ecs.c6.xlarge.

    • InstanceTypeFamily: The instance family to which the instance type belongs, such as ecs.c6.

    • vCPU: The number of vCPU cores for the instance type.

    • Memory: The memory size of the instance type.

    • Architecture: The CPU architecture.

      • X86: x86 computing.

      • ARM: Arm computing.

      • Heterogeneous: Heterogeneous computing GPU/FPGA/NPU.

      • elastic_bareMetal refers to an ECS Bare Metal Instance.

    • CustomizeFamily: Custom instance family.

      • high-clockSpeed

      • general-purpose

      • compute-optimized

      • memory-optimized

      • big-data

      • local-ssd

      • arm-general-purpose

      • arm-compute-optimized

      • arm-memory-optimized

      • gpu-a10

      • gpu-v100

      • gpu-t4

      • gpu-p100

      • gpu-p4

      • gpu-grid

      • gpu-arm

      • gpu-fpga-asic

      • gpu-other

      • basic

      • elastic-bareMetal-compute

      • elastic-bareMetal-GPU-compute

      • super-computeCluster-compute

      • super-computeCluster-GPU-compute

      • enhancement

      • current-recommendation

      • elastic-bareMetal-compute-china-CPU

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "InstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::InstanceType",
          "AssociationPropertyMetadata": {
            "Constraints": {
              "Architecture": [
                "X86"
              ],
              "vCPU": [
                4
              ],
              "Memory": [
                8
              ]
            }
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      InstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::InstanceType
        AssociationPropertyMetadata:
          Constraints:
            Architecture:
              - X86
            vCPU:
              - 4
            Memory:
              - 8
  • Example description

    This example shows how to obtain ECS instance types in the current region with x86 computing architecture, 4 vCPUs, and 8 GB of memory by setting the AssociationProperty of the InstanceType parameter to ALIYUN::ECS::Instance::InstanceType and the AssociationPropertyMetadata to Constraints (Architecture, vCPU, Memory).

ALIYUN::ECS::Instance::MaxBandwidthIn

The maximum inbound public bandwidth for ECS.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "MaxBandwidthIn": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::MaxBandwidthIn"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      MaxBandwidthIn:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::MaxBandwidthIn
  • Example description

    This example shows how to obtain the maximum inbound public bandwidth for ECS by setting the AssociationProperty of the MaxBandwidthIn parameter to ALIYUN::ECS::Instance::MaxBandwidthIn.

ALIYUN::ECS::Instance::OSType

Queries the operating system type of ECS instances.

  • RegionId: The region ID. The default value is the region where the stack resides.

  • InstanceId: The ECS instance ID.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ECSInstanceId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ECSOSType": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance::OSType",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "InstanceId": "${ECSInstanceId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ECSInstanceId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::InstanceId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ECSOSType:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance::OSType
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      InstanceId: ${ECSInstanceId}

ALIYUN::ECS::Instance::Password

The ECS instance password component.

Note

The password must contain 8 to 30 characters and include at least three of the following: uppercase letters, lowercase letters, digits, or special characters.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "password": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::Password"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      password:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::Password
  • Example description

    In this example, setting the AssociationProperty attribute of the password parameter to ALIYUN::ECS::Instance::Password enforces conditions on the ECS instance password.

    Condition: The password must be 8 to 30 characters long and include at least three of the following: uppercase letters, lowercase letters, digits, or special characters.

ALIYUN::ECS::Instance::RenewPeriod

ECS renewal period.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RenewPeriod": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::RenewPeriod"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RenewPeriod:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::RenewPeriod
  • Example description

    This example obtains the ECS renewal period by setting the `AssociationProperty` of the `RenewPeriod` parameter to `ALIYUN::ECS::Instance::RenewPeriod`.

ALIYUN::ECS::Instance::StopMode

The stop mode for an ECS instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "StopMode": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Instance::StopMode"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      StopMode:
        Type: String
        AssociationProperty: ALIYUN::ECS::Instance::StopMode
  • Example description

    In this example, the AssociationProperty property for the StopMode parameter is set to ALIYUN::ECS::Instance::StopMode to retrieve the available stop modes for an ECS instance.

ALIYUN::ECS::InstanceType::AvailableInstanceType

Available ECS instance types.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "AvailableInstanceType": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::InstanceType::AvailableInstanceType"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      AvailableInstanceType:
        Type: String
        AssociationProperty: ALIYUN::ECS::InstanceType::AvailableInstanceType
  • Example description

    This example sets the AssociationProperty parameter of AvailableInstanceType to ALIYUN::ECS::InstanceType::AvailableInstanceType to obtain available ECS instance types.

ALIYUN::ECS::KeyPair::KeyPairName

Key pair.

RegionId: The region ID (defaults to the stack's region).

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "KeyPairName": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::KeyPair::KeyPairName",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      KeyPairName:
        Type: String
        AssociationProperty: ALIYUN::ECS::KeyPair::KeyPairName
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example retrieves the ECS key pair in the current region by setting the `AssociationProperty` property of the `KeyPairName` parameter to `ALIYUN::ECS::KeyPair::KeyPairName` and the `AssociationPropertyMetadata` property to `RegionId`.

ALIYUN::ECS::LaunchTemplate::LaunchTemplateId

The launch template ID.

RegionId: The region ID. The default value is the region where the stack resides.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "LaunchTemplateId":{
          "AssociationProperty":"ALIYUN::ECS::LaunchTemplate::LaunchTemplateId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      LaunchTemplateId:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In this example, the AssociationProperty property for the LaunchTemplateId parameter is set to ALIYUN::ECS::LaunchTemplate::LaunchTemplateId, and the AssociationPropertyMetadata property is set to RegionId. This retrieves the ECS launch templates in the specified region.

ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion

Instance launch template version.

  • RegionId: The region ID (defaults to the stack's region).

  • LaunchTemplateId: Launch Template ID.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "LaunchTemplateId": {
          "AssociationProperty": "ALIYUN::ECS::LaunchTemplate::LaunchTemplateId",
          "Type": "String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "LaunchTemplateVersion": {
          "AssociationProperty": "ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion",
          "Type": "String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "LaunchTemplateId": "${LaunchTemplateId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      LaunchTemplateId:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      LaunchTemplateVersion:
        AssociationProperty: ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          LaunchTemplateId: ${LaunchTemplateId}
  • Example description

    This example retrieves the version information of the selected ECS launch template by setting the `AssociationProperty` attribute of the `LaunchTemplateVersion` parameter to `ALIYUN::ECS::LaunchTemplate::LaunchTemplateVersion` and the `AssociationPropertyMetadata` attribute to `RegionId` and `LaunchTemplateId`.

ALIYUN::ECS::ManagedInstance::InstanceId

The ID of the ECS managed instance.

  • RegionId: The region ID (defaults to the region of the stack).

  • OsType: The operating system type of the managed instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "InstanceId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ManagedInstance::InstanceId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      InstanceId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ManagedInstance::InstanceId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In this example, you can set the AssociationProperty of the InstanceId parameter to ALIYUN::ECS::ManagedInstance::InstanceId and its AssociationPropertyMetadata to RegionId to retrieve the ID of an active ECS managed instance in the current region.

ALIYUN::ECS::RAM::Role

The instance RAM role attached to the ECS instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Role": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RAM::Role"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Role:
        Type: String
        AssociationProperty: ALIYUN::ECS::RAM::Role
  • Example description

    In this example, the AssociationProperty property of the Role parameter is set to ALIYUN::ECS::RAM::Role to retrieve the instance RAM role attached to the ECS instance.

ALIYUN::ECS::RegionId

The region ID. The default value is the region where the stack resides.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
  • Example description

    In this example, setting the AssociationProperty of the RegionId parameter to ALIYUN::ECS::RegionId lists all active regions.

ALIYUN::ECS::RegionId::RegionDeploy

Sets the ECS deployment region.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSRegionDeploy": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId::RegionDeploy"
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSRegionDeploy:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId::RegionDeploy

ALIYUN::ECS::RegionId::TargetRegionIds

Destination region ID of the ECS instance.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "TargetRegionIds": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId::TargetRegionIds"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      TargetRegionIds:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId::TargetRegionIds
  • Example description

    This example sets the AssociationProperty parameter of TargetRegionIds to ALIYUN::ECS::RegionId::TargetRegionIds to obtain the destination region ID of the ECS instance.

ALIYUN::ECS::ResourceGroup::ResourceGroupId

The resource group.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ResourceGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::ResourceGroup::ResourceGroupId"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ResourceGroupId:
        Type: String
        AssociationProperty: ALIYUN::ECS::ResourceGroup::ResourceGroupId
  • Example description

    In this example, the AssociationProperty property of the ResourceGroupId parameter is set to ALIYUN::ECS::ResourceGroup::ResourceGroupId.

ALIYUN::ECS::SecurityGroup::PortRange

Sets the port range for an ECS security group based on the IP protocol.

  • IpProtocol: The IP protocol. Valid values:

    • ALL: Enables simultaneous use of multiple protocols.

    • TCP: The TCP protocol.

    • UDP: The UDP protocol.

    • ICMP: The ICMP protocol.

    • GRE: The GRE protocol.

    • ICMPv6: The ICMPv6 protocol.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ECSSecurityGroupPortRange": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::PortRange",
      "AssociationPropertyMetadata": {
        "IpProtocol": "ALL"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ECSSecurityGroupPortRange:
    Type: String
    AssociationProperty: ALIYUN::ECS::SecurityGroup::PortRange
    AssociationPropertyMetadata:
      IpProtocol: ALL

ALIYUN::ECS::SecurityGroup::SecurityGroupId

The ID of the security group.

  • RegionId: The ID of the region. The default value is the region where the stack resides.

  • VpcId: The ID of the virtual private cloud (VPC).

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        },
        "SecurityGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "VpcId": "${VpcId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
      SecurityGroupId:
        Type: String
        AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          VpcId: ${VpcId}
    
  • Example description

    In this example, setting the AssociationProperty property of the SecurityGroupId parameter to ALIYUN::ECS::SecurityGroup::SecurityGroupId and the AssociationPropertyMetadata property to RegionId and VpcId retrieves the IDs of security groups in the selected VPC and the current region.

ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId

The ID of the automatic snapshot policy.

RegionId: The ID of the region. The default value is the region of the stack.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AutoSnapshotPolicyId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AutoSnapshotPolicyId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In this example, the AssociationProperty property of the AutoSnapshotPolicyId parameter is set to ALIYUN::ECS::Snapshot::AutoSnapshotPolicyId, and the AssociationPropertyMetadata property is set to RegionId. This retrieves the ECS automatic snapshot policies in the current region.

ALIYUN::ECS::Snapshot::SnapshotId

ECS instance disk snapshot ID.

  • RegionId: The region ID. The default value is the region where the stack is located.

  • InstanceId: ECS instance ID.

  • DiskId: Disk ID.

  • Status: Snapshot status.

  • SnapshotType: Snapshot creation type.

  • Category: Snapshot category.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DiskId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Disk::DiskId"
        },
        "SnapshotId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::Snapshot::SnapshotId",
          "AssociationPropertyMetadata": {
            "DiskId": "${DiskId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DiskId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Disk::DiskId
      SnapshotId:
        Type: String
        AssociationProperty: ALIYUN::ECS::Snapshot::SnapshotId
        AssociationPropertyMetadata:
          DiskId: ${DiskId}
  • Example description

    In this example, the AssociationProperty of the SnapshotId parameter is set to ALIYUN::ECS::Snapshot::SnapshotId to obtain the ECS instance disk snapshot ID.

ALIYUN::ECS::TAG

ECS instances have attached tag information.

  • RegionId: The region ID. By default, this is the region where the stack resides.

  • ResourceType: The resource type definition.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "Tag": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::TAG",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      Tag:
        Type: String
        AssociationProperty: ALIYUN::ECS::TAG
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In this example, you can set the AssociationProperty attribute of the Tag parameter to ALIYUN::ECS::TAG to retrieve ECS instance tag information.

ALIYUN::ECS::VPC::VPCId

VPC ID.

RegionId: The region ID. The default value is the region where the stack resides.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "VpcId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      VpcId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VPC::VPCId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    In this example, the AssociationProperty of the VpcId parameter is set to ALIYUN::ECS::VPC::VPCId and the AssociationPropertyMetadata is set to RegionId. This lets you obtain the VPC ID in the current region.

ALIYUN::ECS::VSwitch

A vSwitch object.

  • RegionId: The ID of the region. The default value is the region where the stack resides.

  • ZoneId: The ID of the zone.

  • VpcId: The ID of the virtual private cloud (VPC).

  • InstanceType: The instance type.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ZoneId": {
          "Type": "String",
          "AssociationProperty": "ZoneId"
        },
        "VSwitchId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::VSwitch",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}",
            "ZoneId": "${ZoneId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ZoneId:
        Type: String
        AssociationProperty: ZoneId
      VSwitchId:
        Type: String
        AssociationProperty: ALIYUN::ECS::VSwitch
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
          ZoneId: ${ZoneId}
  • Example description

    In this example, the AssociationProperty property of the VSwitchId parameter is set to ALIYUN::ECS::VSwitch, and the AssociationPropertyMetadata property is set to RegionId and ZoneId, to obtain the selected active vSwitch object in the current region.

EHPC Resources

AssociationProperty Values

Description

Corresponding AssociationPropertyMetadata

ALIYUN::EHPC::Cluster::ClusterId

Select a cluster.

RegionId: Region ID (default is the stack's region).

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ClusterId":{
          "AssociationProperty":"ALIYUN::EHPC::Cluster::ClusterId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          },
          "Type":"String"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ClusterId:
        AssociationProperty: ALIYUN::EHPC::Cluster::ClusterId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
        Type: String
  • Example description

    Get the EHPC cluster ID by setting the AssociationProperty of the ClusterId parameter to ALIYUN::EHPC::Cluster::ClusterId.

ALIYUN::EHPC::FileSystem::FileSystemId

File system ID.

RegionId: Region ID (default is the stack's region).

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "FileSystemId":{
          "AssociationProperty":"ALIYUN::EHPC::FileSystem::FileSystemId",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      FileSystemId:
        AssociationProperty: ALIYUN::EHPC::FileSystem::FileSystemId
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    Get the EHPC file system ID by setting the AssociationProperty of the FileSystemId parameter to ALIYUN::EHPC::FileSystem::FileSystemId.

ALIYUN::EHPC::FileSystem::MountTargetDomain

Mount target.

  • RegionId: Region ID (default is the stack's region).

  • VolumeId: Alibaba Cloud NAS instance ID.

  • VpcId: Virtual private cloud (VPC) ID.

  • VSwitchId: vSwitch ID.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "MountTargetDomain":{
          "AssociationProperty":"ALIYUN::EHPC::FileSystem::MountTargetDomain",
          "Type":"String",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      MountTargetDomain:
        AssociationProperty: ALIYUN::EHPC::FileSystem::MountTargetDomain
        Type: String
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    Get the EHPC file mount target list by setting the AssociationProperty of the MountTargetDomain parameter to ALIYUN::EHPC::FileSystem::MountTargetDomain.

ESS resources

AssociationProperty value

Description

Corresponding AssociationPropertyMetadata

ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId

The ID of the Auto Scaling group.

RegionId: The region ID. The default value is the region of the stack.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "AutoScalingGroupId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      AutoScalingGroupId:
        Type: String
        AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example retrieves the ID of an Auto Scaling group by setting the AssociationProperty of the AutoScalingGroupId parameter to ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId.

ALIYUN::ESS::ECIScalingConfiguration::ContainerName

Queries the configuration of ECI scaling groups.

  • RegionId: The region ID. The default value is the region of the stack.

  • ScalingGroupId: The ID of the scaling group.

  • ScalingConfigurationId: The ID of the scaling configuration.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "ESSECIScalingConfigurationContainerName": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ECIScalingConfiguration::ContainerName",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  ESSECIScalingConfigurationContainerName:
    Type: String
    AssociationProperty: ALIYUN::ESS::ECIScalingConfiguration::ContainerName
    AssociationPropertyMetadata:
      RegionId: ${RegionId}

ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId

Queries the ID of a scaling configuration.

  • RegionId: The region ID. The default value is the region of the stack.

  • ScalingGroupId: The ID of the scaling group.

  • AutoSelectFirst: Specifies whether to select the first item.

Example code

JSON example:

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RegionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::RegionId"
    },
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}"
      }
    },
    "ServiceConnectionId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId",
      "AssociationPropertyMetadata": {
        "RegionId": "${RegionId}",
        "ScalingGroupId": "${AutoScalingGroupId}",
        "AutoSelectFirst": true
      }
    }
  }
}

YAML example:

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RegionId:
    Type: String
    AssociationProperty: ALIYUN::ECS::RegionId
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
  ServiceConnectionId:
    Type: String
    AssociationProperty: ALIYUN::ESS::ECIScalingConfiguration::ScalingConfigurationId
    AssociationPropertyMetadata:
      RegionId: ${RegionId}
      ScalingGroupId: ${AutoScalingGroupId}
      AutoSelectFirst: true

ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId

The ID of the Auto Scaling configuration.

RegionId: The region ID. The default value is the region of the stack.

Examples:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "RegionId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ECS::RegionId"
        },
        "ScalingConfigurationId": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId",
          "AssociationPropertyMetadata": {
            "RegionId": "${RegionId}"
          }
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      RegionId:
        Type: String
        AssociationProperty: ALIYUN::ECS::RegionId
      ScalingConfigurationId:
        Type: String
        AssociationProperty: ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId
        AssociationPropertyMetadata:
          RegionId: ${RegionId}
  • Example description

    This example retrieves the ID of an Auto Scaling configuration by setting the AssociationProperty of the ScalingConfigurationId parameter to ALIYUN::ESS::ScalingConfiguration::ScalingConfigurationId.

Elasticsearch resource

AssociationProperty values

Description

Corresponding AssociationPropertyMetadata

ALIYUN::Elasticsearch::Instance::InstanceType

Elasticsearch instance type.

Example:

  • Example code

    JSON example:

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "Elasticsearch": {
          "Type": "String",
          "AssociationProperty": "ALIYUN::Elasticsearch::Instance::InstanceType"
        }
      }
    }

    YAML example:

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      Elasticsearch:
        Type: String
        AssociationProperty: ALIYUN::Elasticsearch::Instance::InstanceType
  • Example description

    This example sets the AssociationProperty of the Elasticsearch parameter to ALIYUN::Elasticsearch::Instance::InstanceType to get the Elasticsearch instance type.