Document Center

    Resource Orchestration Service

    • Product Introduction
      • What is ROS?
      • Benefits
      • Application scenarios
      • Terms
      • Limits
      • Pricing
        • Billing
    • Quick Start
      • Use sample templates to create stacks
      • Use RAM to control resource access
      • Create a stack group
      • Create a change set
      • Detect drift on a stack
      • Event notification
    • Stack Management
      • Overview
      • Create a stack
      • View information about a stack
      • Update a stack
      • Recreate a stack
      • Delete a stack
      • Enable deletion protection
      • Use nested stacks
      • Stack policies
      • Update a stack by replacing its resource properties
    • Stack Group Management
      • Overview
      • Grant operation permissions on stack groups
      • Create a stack group
      • Add a stack instance
      • Update a stack group
      • Override stack group parameter values
      • Delete a stack group
      • Status codes for stack groups and stack instances
    • Template
      • Template management
        • My Templates
          • Create a template
          • Edit a template
          • Delete a template
          • Use a template to create a stack
      • Template syntax
        • Template structure
        • Parameters
        • Resources
        • Outputs
        • Functions
        • Mappings
        • Conditions
        • Pseudo parameters
        • Metadata
        • Transform
      • Custom resources
        • Overview
        • Resource references
          • Custom resource references
          • Custom resource request objects
          • Custom resource response objects
        • Request types
          • Custom resource request types
          • Create
          • Update
          • Delete
      • Estimate resource prices
    • Change Set Management
      • Data structure
      • Create a stack by creating a change set
      • Update a stack
        • Overview
        • Create a change set
        • View a change set
        • Execute a change set
        • Delete a change set
    • Drift Detection
      • Overview
      • Detect drift on a stack
      • Detect drift on a resource
      • Resource types that support drift detection and resource import
      • Detect drift on a stack group
      • Correct drift on a stack
    • Terraform
      • Overview
      • Create a Terraform stack
      • Create a Terraform template
      • Terraform template structure
      • ROS features and resources supported by Terraform
    • Resource Import
      • Overview
      • Obtain a resource identifier property for resource import
      • Create a stack by importing an existing resource
      • Import an existing resource to a stack
      • Remove a resource from a stack
      • Move a resource between stacks
    • ROS CDK
      • Overview
      • Install ROS CDK
      • ROS CDK commands
      • Usage examples
        • TypeScript example
        • JavaScript example
        • Java example
        • Python example
    • Tags
      • Overview
      • Manage templates by using tags
        • Create tags
        • Delete tags
        • Search for templates by using tags
      • Manage stacks by using tags
        • Create tags
        • Search for stacks by using tags
        • Delete tags
    • Resource Types
      • View resource types
      • Resource type index
      • ACM
        • ALIYUN::ACM::Configuration
        • ALIYUN::ACM::Namespace
      • ActionTrail
        • ALIYUN::ACTIONTRAIL::Trail
        • ALIYUN::ACTIONTRAIL::TrailLogging
      • ASM
        • ALIYUN::ASM::ServiceMesh
      • API Gateway
        • ALIYUN::ApiGateway::Api
        • ALIYUN::ApiGateway::App
        • ALIYUN::ApiGateway::Authorization
        • ALIYUN::ApiGateway::CustomDomain
        • ALIYUN::ApiGateway::Deployment
        • ALIYUN::ApiGateway::Group
        • ALIYUN::ApiGateway::Instance
        • ALIYUN::ApiGateway::LogConfig
        • ALIYUN::ApiGateway::Signature
        • ALIYUN::ApiGateway::SignatureBinding
        • ALIYUN::ApiGateway::StageConfig
        • ALIYUN::ApiGateway::TrafficControl
        • ALIYUN::ApiGateway::TrafficControlBinding
        • ALIYUN::ApiGateway::VpcAccessConfig
      • BSS
        • ALIYUN::BSS::WaitOrder
      • CAS
        • ALIYUN::CAS::Certificate
      • CDN
        • ALIYUN::CDN::DomainConfig
        • ALIYUN::CDN::Domain
      • CEN
        • ALIYUN::CEN::CenInstance
        • ALIYUN::CEN::CenBandwidthLimit
        • ALIYUN::CEN::CenBandwidthPackage
        • ALIYUN::CEN::CenBandwidthPackageAssociation
        • ALIYUN::CEN::CenInstanceAttachment
        • ALIYUN::CEN::RouteEntry
      • CLOUDFW
        • ALIYUN::CLOUDFW::AddressBook
        • ALIYUN::CLOUDFW::ControlPolicy
      • ARMS
        • ALIYUN::ARMS::AlertContact
        • ALIYUN::ARMS::AlertContactGroup
        • ALIYUN::ARMS::RetcodeApp
      • CMS
        • ALIYUN::CMS::Contact
        • ALIYUN::CMS::ContactGroup
        • ALIYUN::CMS::DynamicTagGroup
        • ALIYUN::CMS::EventRule
        • ALIYUN::CMS::EventRuleTargets
        • ALIYUN::CMS::GroupMetricRule
        • ALIYUN::CMS::MetricRuleTargets
        • ALIYUN::CMS::MetricRuleTemplate
        • ALIYUN::CMS::MonitoringAgentProcess
        • ALIYUN::CMS::MonitorGroup
        • ALIYUN::CMS::MonitorGroupInstances
        • ALIYUN::CMS::SiteMonitor
      • CR
        • ALIYUN::CR::InstanceEndpointAclPolicy
        • ALIYUN::CR::Repository
        • ALIYUN::CR::Namespace
      • CS
        • ALIYUN::CS::AnyCluster
        • ALIYUN::CS::KubernetesCluster
        • ALIYUN::CS::ManagedEdgeKubernetesCluster
        • ALIYUN::CS::ManagedKubernetesCluster
        • ALIYUN::CS::ServerlessKubernetesCluster
      • DATAHUB
        • ALIYUN::DATAHUB::Project
        • ALIYUN::DATAHUB::Topic
      • DBS
        • ALIYUN::DBS::RestoreTask
      • DMS
        • ALIYUN::DMS::Instance
        • ALIYUN::DMS::User
      • DNS
        • ALIYUN::DNS::DomainGroup
        • ALIYUN::DNS::Domain
        • ALIYUN::DNS::DomainRecord
      • DRDS
        • ALIYUN::DRDS::DrdsInstance
        • ALIYUN::DRDS::DrdsDB
      • DTS
        • ALIYUN::DTS::MigrationJob
        • ALIYUN::DTS::SynchronizationJob
        • ALIYUN::DTS::SubscriptionInstance
      • ECI
        • ALIYUN::ECI::ContainerGroup
        • ALIYUN::ECI::ImageCache
      • ECS
        • ALIYUN::ECS::AutoProvisioningGroup
        • ALIYUN::ECS::AutoSnapshotPolicy
        • ALIYUN::ECS::AssignIpv6Addresses
        • ALIYUN::ECS::AssignPrivateIpAddresses
        • ALIYUN::ECS::BandwidthPackage
        • ALIYUN::ECS::Command
        • ALIYUN::ECS::CopyImage
        • ALIYUN::ECS::CustomImage
        • ALIYUN::ECS::DedicatedHost
        • ALIYUN::ECS::DeploymentSet
        • ALIYUN::ECS::Disk
        • ALIYUN::ECS::DiskAttachment
        • ALIYUN::ECS::ForwardEntry
        • ALIYUN::ECS::HpcCluster
        • ALIYUN::ECS::Instance
        • ALIYUN::ECS::InstanceClone
        • ALIYUN::ECS::InstanceGroup
        • ALIYUN::ECS::InstanceGroupClone
        • ALIYUN::ECS::Invocation
        • ALIYUN::ECS::JoinSecurityGroup
        • ALIYUN::ECS::LaunchTemplate
        • ALIYUN::ECS::NetworkInterface
        • ALIYUN::ECS::NetworkInterfaceAttachment
        • ALIYUN::ECS::NetworkInterfacePermission
        • ALIYUN::ECS::PrepayInstance
        • ALIYUN::ECS::PrepayInstanceGroupClone
        • ALIYUN::ECS::Route
        • ALIYUN::ECS::SNatEntry
        • ALIYUN::ECS::RunCommand
        • ALIYUN::ECS::SecurityGroup
        • ALIYUN::ECS::SecurityGroupClone
        • ALIYUN::ECS::SecurityGroupEgress
        • ALIYUN::ECS::SecurityGroupIngress
        • ALIYUN::ECS::Snapshot
        • ALIYUN::ECS::SSHKeyPair
        • ALIYUN::ECS::SSHKeyPairAttachment
        • ALIYUN::ECS::VPC
        • ALIYUN::ECS::VSwitch
      • EDAS
        • ALIYUN::EDAS::Application
        • ALIYUN::EDAS::Cluster
        • ALIYUN::EDAS::ClusterMember
        • ALIYUN::EDAS::DeployGroup
        • ALIYUN::EDAS::UserDefineRegion
      • Elasticsearch
        • ALIYUN::ElasticSearch::Instance
      • EHPC
        • ALIYUN::EHPC::Cluster
      • EMR
        • ALIYUN::EMR::Cluster
      • ENS
        • ALIYUN::ENS::Instance
      • ESS
        • ALIYUN::ESS::AlarmTask
        • ALIYUN::ESS::AlarmTaskEnable
        • ALIYUN::ESS::LifecycleHook
        • ALIYUN::ESS::ScalingConfiguration
        • ALIYUN::ESS::ScalingGroup
        • ALIYUN::ESS::ScalingGroupEnable
        • ALIYUN::ESS::ScalingRule
        • ALIYUN::ESS::ScheduledTask
      • FC
        • ALIYUN::FC::Alias
        • ALIYUN::FC::CustomDomain
        • ALIYUN::FC::Function
        • ALIYUN::FC::FunctionInvoker
        • ALIYUN::FC::ProvisionConfig
        • ALIYUN::FC::Service
        • ALIYUN::FC::Trigger
        • ALIYUN::FC::Version
      • FNF
        • ALIYUN::FNF::Schedule
        • ALIYUN::FNF::Flow
      • FOAS
        • ALIYUN::FOAS::Cluster
        • ALIYUN::FOAS::Project
      • GA
        • ALIYUN::GA::BandwidthPackageAcceleratorAddition
        • ALIYUN::GA::Accelerator
        • ALIYUN::GA::EndpointGroup
        • ALIYUN::GA::BandwidthPackage
        • ALIYUN::GA::IpSets
        • ALIYUN::GA::Listener
      • GWS
        • ALIYUN::GWS::Cluster
        • ALIYUN::GWS::Instance
      • HBR
        • ALIYUN::HBR::BackupClients
        • ALIYUN::HBR::RestoreJob
      • IOT
        • ALIYUN::IOT::Device
        • ALIYUN::IOT::DeviceGroup
        • ALIYUN::IOT::Product
        • ALIYUN::IOT::ProductTopic
        • ALIYUN::IOT::Rule
        • ALIYUN::IOT::RuleAction
      • KAFKA
        • ALIYUN::KAFKA::Instance
        • ALIYUN::KAFKA::Topic
      • KMS
        • ALIYUN::KMS::Alias
        • ALIYUN::KMS::Key
        • ALIYUN::KMS::Secret
      • MarketPlace
        • ALIYUN::MarketPlace::Order
      • MSE
        • ALIYUN::MSE::Cluster
      • MNS
        • ALIYUN::MNS::Topic
        • ALIYUN::MNS::Subscription
        • ALIYUN::MNS::Queue
      • MongoDB
        • ALIYUN::MONGODB::Instance
        • ALIYUN::MONGODB::ServerlessInstance
        • ALIYUN::MONGODB::ShardingInstance
      • NAS
        • ALIYUN::NAS::FileSystem
        • ALIYUN::NAS::AccessGroup
        • ALIYUN::NAS::AccessRule
        • ALIYUN::NAS::MountTarget
      • OOS
        • ALIYUN::OOS::Execution
        • ALIYUN::OOS::Template
        • ALIYUN::OOS::Parameter
      • OSS
        • ALIYUN::OSS::Bucket
      • OTS
        • ALIYUN::OTS::Instance
        • ALIYUN::OTS::SearchIndex
        • ALIYUN::OTS::Table
        • ALIYUN::OTS::VpcBinder
      • ApsaraDB for POLARDB
        • ALIYUN::POLARDB::DBClusterAccessWhiteList
        • ALIYUN::POLARDB::AccountPrivilege
        • ALIYUN::POLARDB::DBClusterEndpointAddress
        • ALIYUN::POLARDB::DBInstance
        • ALIYUN::POLARDB::DBCluster
        • ALIYUN::POLARDB::DBClusterEndpoint
        • ALIYUN::POLARDB::DBNodes
        • ALIYUN::POLARDB::Account
      • PrivateLink
        • ALIYUN::PrivateLink::VpcEndpoint
        • ALIYUN::PrivateLink::VpcEndpointService
      • PVTZ
        • ALIYUN::PVTZ::ZoneVpcBinder
        • ALIYUN::PVTZ::ZoneRecord
        • ALIYUN::PVTZ::Zone
      • RAM
        • ALIYUN::RAM::AccessKey
        • ALIYUN::RAM::AttachPolicyToRole
        • ALIYUN::RAM::AttachPolicyToUser
        • ALIYUN::RAM::Group
        • ALIYUN::RAM::ManagedPolicy
        • ALIYUN::RAM::Role
        • ALIYUN::RAM::SAMLProvider
        • ALIYUN::RAM::User
        • ALIYUN::RAM::UserToGroupAddition
      • RDS
        • ALIYUN::RDS::Account
        • ALIYUN::RDS::AccountPrivilege
        • ALIYUN::RDS::ADInfo
        • ALIYUN::RDS::Database
        • ALIYUN::RDS::DBInstance
        • ALIYUN::RDS::DBInstanceParameterGroup
        • ALIYUN::RDS::DBInstanceSecurityIps
        • ALIYUN::RDS::DBInstanceClone
        • ALIYUN::RDS::PrepayDBInstance
        • ALIYUN::RDS::ReadOnlyDBInstance
      • ResourceManager
        • ALIYUN::ResourceManager::ResourceDirectory
        • ALIYUN::ResourceManager::Account
        • ALIYUN::ResourceManager::Folder
        • ALIYUN::ResourceManager::Handshake
        • ALIYUN::ResourceManager::ResourceGroup
      • Redis
        • ALIYUN::REDIS::Account
        • ALIYUN::REDIS::Instance
        • ALIYUN::REDIS::PrepayInstance
        • ALIYUN::REDIS::Whitelist
      • ROCKETMQ
        • ALIYUN::ROCKETMQ::Instance
        • ALIYUN::ROCKETMQ::Group
        • ALIYUN::ROCKETMQ::Topic
      • ROS
        • ALIYUN::ROS::AutoEnableService
        • ALIYUN::ROS::WaitCondition
        • ALIYUN::ROS::WaitConditionHandle
        • ALIYUN::ROS::Stack
        • ALIYUN::ROS::CustomResource
      • SAE
        • ALIYUN::SAE::Application
        • ALIYUN::SAE::Namespace
        • ALIYUN::SAE::SlbBinding
      • SAG
        • ALIYUN::SAG::CloudConnectNetwork
        • ALIYUN::SAG::ACL
        • ALIYUN::SAG::ACLAssociation
        • ALIYUN::SAG::ACLRule
        • ALIYUN::SAG::SmartAccessGatewayBinding
        • ALIYUN::SAG::GrantCcnToCen
      • SLB
        • ALIYUN::SLB::AccessControl
        • ALIYUN::SLB::BackendServerAttachment
        • ALIYUN::SLB::BackendServerToVServerGroupAddition
        • ALIYUN::SLB::Certificate
        • ALIYUN::SLB::DomainExtension
        • ALIYUN::SLB::Listener
        • ALIYUN::SLB::LoadBalancer
        • ALIYUN::SLB::LoadBalancerClone
        • ALIYUN::SLB::MasterSlaveServerGroup
        • ALIYUN::SLB::Rule
        • ALIYUN::SLB::VServerGroup
      • SLS
        • ALIYUN::SLS::Alert
        • ALIYUN::SLS::ApplyConfigToMachineGroup
        • ALIYUN::SLS::Index
        • ALIYUN::SLS::Project
        • ALIYUN::SLS::Savedsearch
        • ALIYUN::SLS::Logstore
        • ALIYUN::SLS::LogtailConfig
        • ALIYUN::SLS::MachineGroup
      • TSDB
        • ALIYUN::TSDB::HiTSDBInstance
      • UIS
        • ALIYUN::UIS::UisNode
        • ALIYUN::UIS::Uis
        • ALIYUN::UIS::UisConnection
      • VPC
        • ALIYUN::VPC::CommonBandwidthPackage
        • ALIYUN::VPC::CommonBandwidthPackageIp
        • ALIYUN::VPC::CustomerGateway
        • ALIYUN::VPC::EIP
        • ALIYUN::VPC::EIPAssociation
        • ALIYUN::VPC::GrantInstanceToCen
        • ALIYUN::VPC::NatGateway
        • ALIYUN::VPC::Ipv6Gateway
        • ALIYUN::VPC::Ipv6InternetBandwidth
        • ALIYUN::VPC::PeeringRouterInterfaceBinding
        • ALIYUN::VPC::PeeringRouterInterfaceConnection
        • ALIYUN::VPC::RouterInterface
        • ALIYUN::VPC::RouteTable
        • ALIYUN::VPC::RouteTableAssociation
        • ALIYUN::VPC::SnatEntry
        • ALIYUN::VPC::SslVpnClientCert
        • ALIYUN::VPC::SslVpnServer
        • ALIYUN::VPC::VpnConnection
        • ALIYUN::VPC::VpnGateway
      • VS
        • ALIYUN::VS::Group
      • WAF
        • ALIYUN::WAF::AclRule
        • ALIYUN::WAF::Domain
        • ALIYUN::WAF::DomainConfig
        • ALIYUN::WAF::WafSwitch
        • ALIYUN::WAF::Instance
      • Transform
        • Aliyun::Serverless::Api
        • Aliyun::Serverless::CustomDomain
        • Aliyun::Serverless::Function
        • Aliyun::Serverless::Log
        • Aliyun::Serverless::Log::Logstore
        • Aliyun::Serverless::MNSTopic
        • Aliyun::Serverless::Service
        • Aliyun::Serverless::TableStore
        • Aliyun::Serverless::TableStore::Table
    • Common Tools
      • Command line tools
        • Alibaba Cloud CLI
          • Install Alibaba Cloud CLI
          • Configure Alibaba Cloud CLI
          • API operation examples
            • Overview
            • Stack operations
            • Resource operations
            • Template operations
            • Stack policy operations
            • Change set operations
            • Other API operations
      • Plug-in tools
        • Ansible
          • Overview
          • Use ali_ros_stack to create a stack
          • Use ali_ros_stack to update a stack
          • Use ali_ros_stack to delete a stack
          • Use ali_ros_stack_info to query information about a stack
    • FAQ
      • Why did template validation fail?
      • Why did resource stack creation fail?
      • Why does a stack fail to be deleted?
      • How do I configure password confirmation?
      • How do I specify images for ECS resources?
      • How do I specify different instance names and hostnames when I create multiple ECS instances at a time?
      • FAQ about SDKs
    • Best Practices
      • Website Deployment
        • Use an ROS template to deploy WordPress and phpMyAdmin
      • Batch Deployment
        • Use the Count feature to deploy large amounts of resources
        • Use the Count feature to create multiple resources at a time
      • Open Source Integration
        • Use ROS CDK to orchestrate resources
        • Use Ansible ali_ros_stack to deploy an LNMP environment
    • Service Agreements
      • Terms of Service
    • API Reference
      • List of operations by function
      • Request method
      • Request signatures
      • RAM authorization
      • Common parameters
      • Common error codes
      • Stack operations
        • ListStacks
        • GetStack
        • ListStackEvents
        • ContinueCreateStack
        • CancelUpdateStack
        • DeleteStack
        • PreviewStack
        • CreateStack
        • UpdateStack
      • Resource operations
        • GetResourceTypeTemplate
        • ListStackResources
        • GetStackResource
        • GetResourceType
        • ListResourceTypes
      • Template operations
        • GetTemplateEstimateCost
        • ValidateTemplate
        • GetTemplate
        • DeleteTemplate
        • ListTemplates
        • CreateTemplate
        • UpdateTemplate
        • GetTemplateSummary
        • ListTemplateVersions
        • SetTemplatePermission
        • GenerateTemplatePolicy
      • Stack policy operations
        • GetStackPolicy
        • SetStackPolicy
      • API operations related to change sets
        • DeleteChangeSet
        • CreateChangeSet
        • ExecuteChangeSet
        • GetChangeSet
        • ListChangeSets
      • Stack group operations
        • CreateStackGroup
        • DeleteStackGroup
        • GetStackGroup
        • ListStackGroups
        • UpdateStackGroup
        • CreateStackInstances
        • DeleteStackInstances
        • GetStackInstance
        • ListStackInstances
        • UpdateStackInstances
        • GetStackGroupOperation
        • ListStackGroupOperations
        • StopStackGroupOperation
        • ListStackGroupOperationResults
      • Drift detection operations
        • UpdateStackTemplateByResources
        • DetectStackDrift
        • DetectStackGroupDrift
        • DetectStackResourceDrift
        • GetStackDriftDetectionStatus
        • ListStackResourceDrifts
      • Tag operations
        • TagResources
        • UntagResources
        • ListTagResources
        • ListTagKeys
        • ListTagValues
      • Other operations
        • DescribeRegions
        • SignalResource
        • SetDeletionProtection
        • ListStackOperationRisks
      • Appendix
        • How to ensure idempotence
    • SDK Reference
      • Download and use SDKs
      • Use SDK for Python
      • Use SDK for Java
 
All Products
Search
  • Document Center
  • Resource Orchestration Service
  • Template
  • Custom resources
  • Resource references
  • Custom resource references

This Product

  • This Product
  • All Products

    Custom resource references

    Document Center

    Custom resource references

    Last Updated: May 27, 2020

    This section provides details about the JSON request and response fields that are used in messages sent to and from ROS when a custom resource is provided. The section also provides details about the required fields for requests to, and responses to, the custom resource provider in response to stack creation, update, and deletion.

    • Custom resource request objects
    • Custom resource response objects
    • Custom resource request types
    Previous: Overview Next: Custom resource request objects

    How helpful was this page?

    What might be the problems?

      More suggestions?

      Thank you! We've received your feedback.
      Free Trial Free Trial