Documentation ¶
Overview ¶
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com
Index ¶
- func ApiAttachment_IsConstruct(x interface{}) *bool
- func Domain_IsConstruct(x interface{}) *bool
- func Environment_IsConstruct(x interface{}) *bool
- func Gateway_IsConstruct(x interface{}) *bool
- func HttpApi_IsConstruct(x interface{}) *bool
- func NewApiAttachment_Override(a ApiAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewDomain_Override(d Domain, scope alicloudroscdkcore.Construct, id *string, props *DomainProps, ...)
- func NewEnvironment_Override(e Environment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewGateway_Override(g Gateway, scope alicloudroscdkcore.Construct, id *string, props *GatewayProps, ...)
- func NewHttpApi_Override(h HttpApi, scope alicloudroscdkcore.Construct, id *string, props *HttpApiProps, ...)
- func NewOperation_Override(o Operation, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPluginAttachment_Override(p PluginAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPluginClass_Override(p PluginClass, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewPlugin_Override(p Plugin, scope alicloudroscdkcore.Construct, id *string, props *PluginProps, ...)
- func NewPolicy_Override(p Policy, scope alicloudroscdkcore.Construct, id *string, props *PolicyProps, ...)
- func NewRosApiAttachment_Override(r RosApiAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosDomain_Override(r RosDomain, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosEnvironment_Override(r RosEnvironment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosGateway_Override(r RosGateway, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosHttpApi_Override(r RosHttpApi, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosOperation_Override(r RosOperation, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPluginAttachment_Override(r RosPluginAttachment, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPluginClass_Override(r RosPluginClass, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPlugin_Override(r RosPlugin, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosPolicy_Override(r RosPolicy, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosRoute_Override(r RosRoute, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRosService_Override(r RosService, scope alicloudroscdkcore.Construct, id *string, ...)
- func NewRoute_Override(r Route, scope alicloudroscdkcore.Construct, id *string, props *RouteProps, ...)
- func NewService_Override(s Service, scope alicloudroscdkcore.Construct, id *string, props *ServiceProps, ...)
- func Operation_IsConstruct(x interface{}) *bool
- func PluginAttachment_IsConstruct(x interface{}) *bool
- func PluginClass_IsConstruct(x interface{}) *bool
- func Plugin_IsConstruct(x interface{}) *bool
- func Policy_IsConstruct(x interface{}) *bool
- func RosApiAttachment_IsConstruct(x interface{}) *bool
- func RosApiAttachment_IsRosElement(x interface{}) *bool
- func RosApiAttachment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosApiAttachment_ROS_RESOURCE_TYPE_NAME() *string
- func RosDomain_IsConstruct(x interface{}) *bool
- func RosDomain_IsRosElement(x interface{}) *bool
- func RosDomain_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosDomain_ROS_RESOURCE_TYPE_NAME() *string
- func RosEnvironment_IsConstruct(x interface{}) *bool
- func RosEnvironment_IsRosElement(x interface{}) *bool
- func RosEnvironment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosEnvironment_ROS_RESOURCE_TYPE_NAME() *string
- func RosGateway_IsConstruct(x interface{}) *bool
- func RosGateway_IsRosElement(x interface{}) *bool
- func RosGateway_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosGateway_ROS_RESOURCE_TYPE_NAME() *string
- func RosHttpApi_IsConstruct(x interface{}) *bool
- func RosHttpApi_IsRosElement(x interface{}) *bool
- func RosHttpApi_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosHttpApi_ROS_RESOURCE_TYPE_NAME() *string
- func RosOperation_IsConstruct(x interface{}) *bool
- func RosOperation_IsRosElement(x interface{}) *bool
- func RosOperation_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosOperation_ROS_RESOURCE_TYPE_NAME() *string
- func RosPluginAttachment_IsConstruct(x interface{}) *bool
- func RosPluginAttachment_IsRosElement(x interface{}) *bool
- func RosPluginAttachment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPluginAttachment_ROS_RESOURCE_TYPE_NAME() *string
- func RosPluginClass_IsConstruct(x interface{}) *bool
- func RosPluginClass_IsRosElement(x interface{}) *bool
- func RosPluginClass_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPluginClass_ROS_RESOURCE_TYPE_NAME() *string
- func RosPlugin_IsConstruct(x interface{}) *bool
- func RosPlugin_IsRosElement(x interface{}) *bool
- func RosPlugin_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPlugin_ROS_RESOURCE_TYPE_NAME() *string
- func RosPolicy_IsConstruct(x interface{}) *bool
- func RosPolicy_IsRosElement(x interface{}) *bool
- func RosPolicy_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosPolicy_ROS_RESOURCE_TYPE_NAME() *string
- func RosRoute_IsConstruct(x interface{}) *bool
- func RosRoute_IsRosElement(x interface{}) *bool
- func RosRoute_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosRoute_ROS_RESOURCE_TYPE_NAME() *string
- func RosService_IsConstruct(x interface{}) *bool
- func RosService_IsRosElement(x interface{}) *bool
- func RosService_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
- func RosService_ROS_RESOURCE_TYPE_NAME() *string
- func Route_IsConstruct(x interface{}) *bool
- func Service_IsConstruct(x interface{}) *bool
- type ApiAttachment
- type ApiAttachmentProps
- type Domain
- type DomainProps
- type Environment
- type EnvironmentProps
- type Gateway
- type GatewayProps
- type HttpApi
- type HttpApiProps
- type IApiAttachment
- type IDomain
- type IEnvironment
- type IGateway
- type IHttpApi
- type IOperation
- type IPlugin
- type IPluginAttachment
- type IPluginClass
- type IPolicy
- type IRoute
- type IService
- type Operation
- type OperationProps
- type Plugin
- type PluginAttachment
- type PluginAttachmentProps
- type PluginClass
- type PluginClassProps
- type PluginProps
- type Policy
- type PolicyProps
- type RosApiAttachment
- type RosApiAttachmentProps
- type RosApiAttachment_ConditionsProperty
- type RosApiAttachment_MatchProperty
- type RosApiAttachment_ServiceConfigsProperty
- type RosDomain
- type RosDomainProps
- type RosEnvironment
- type RosEnvironmentProps
- type RosGateway
- type RosGatewayProps
- type RosGateway_LogConfigProperty
- type RosGateway_NetworkAccessConfigProperty
- type RosGateway_SlsProperty
- type RosGateway_VSwitchProperty
- type RosGateway_VpcProperty
- type RosGateway_ZoneConfigProperty
- type RosHttpApi
- type RosHttpApiProps
- type RosOperation
- type RosOperationProps
- type RosOperation_MockProperty
- type RosPlugin
- type RosPluginAttachment
- type RosPluginAttachmentProps
- type RosPluginAttachment_PluginInfoProperty
- type RosPluginClass
- type RosPluginClassProps
- type RosPluginProps
- type RosPolicy
- type RosPolicyProps
- type RosRoute
- type RosRouteProps
- type RosRoute_BackendProperty
- type RosRoute_DomainInfosProperty
- type RosRoute_EnvironmentInfoProperty
- type RosRoute_GatewayInfoProperty
- type RosRoute_HeadersProperty
- type RosRoute_MatchProperty
- type RosRoute_PathProperty
- type RosRoute_QueryParamsProperty
- type RosRoute_ServicesProperty
- type RosRoute_SubDomainsProperty
- type RosService
- type RosServiceProps
- type Route
- type RouteProps
- type Service
- type ServiceProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApiAttachment_IsConstruct ¶
func ApiAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Domain_IsConstruct ¶
func Domain_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Environment_IsConstruct ¶
func Environment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Gateway_IsConstruct ¶
func Gateway_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func HttpApi_IsConstruct ¶
func HttpApi_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func NewApiAttachment_Override ¶
func NewApiAttachment_Override(a ApiAttachment, scope alicloudroscdkcore.Construct, id *string, props *ApiAttachmentProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewDomain_Override ¶
func NewDomain_Override(d Domain, scope alicloudroscdkcore.Construct, id *string, props *DomainProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewEnvironment_Override ¶
func NewEnvironment_Override(e Environment, scope alicloudroscdkcore.Construct, id *string, props *EnvironmentProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewGateway_Override ¶
func NewGateway_Override(g Gateway, scope alicloudroscdkcore.Construct, id *string, props *GatewayProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewHttpApi_Override ¶
func NewHttpApi_Override(h HttpApi, scope alicloudroscdkcore.Construct, id *string, props *HttpApiProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewOperation_Override ¶
func NewOperation_Override(o Operation, scope alicloudroscdkcore.Construct, id *string, props *OperationProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPluginAttachment_Override ¶
func NewPluginAttachment_Override(p PluginAttachment, scope alicloudroscdkcore.Construct, id *string, props *PluginAttachmentProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPluginClass_Override ¶
func NewPluginClass_Override(p PluginClass, scope alicloudroscdkcore.Construct, id *string, props *PluginClassProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPlugin_Override ¶
func NewPlugin_Override(p Plugin, scope alicloudroscdkcore.Construct, id *string, props *PluginProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewPolicy_Override ¶
func NewPolicy_Override(p Policy, scope alicloudroscdkcore.Construct, id *string, props *PolicyProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewRosApiAttachment_Override ¶
func NewRosApiAttachment_Override(r RosApiAttachment, scope alicloudroscdkcore.Construct, id *string, props *RosApiAttachmentProps, enableResourcePropertyConstraint *bool)
func NewRosDomain_Override ¶
func NewRosDomain_Override(r RosDomain, scope alicloudroscdkcore.Construct, id *string, props *RosDomainProps, enableResourcePropertyConstraint *bool)
func NewRosEnvironment_Override ¶
func NewRosEnvironment_Override(r RosEnvironment, scope alicloudroscdkcore.Construct, id *string, props *RosEnvironmentProps, enableResourcePropertyConstraint *bool)
func NewRosGateway_Override ¶
func NewRosGateway_Override(r RosGateway, scope alicloudroscdkcore.Construct, id *string, props *RosGatewayProps, enableResourcePropertyConstraint *bool)
func NewRosHttpApi_Override ¶
func NewRosHttpApi_Override(r RosHttpApi, scope alicloudroscdkcore.Construct, id *string, props *RosHttpApiProps, enableResourcePropertyConstraint *bool)
func NewRosOperation_Override ¶
func NewRosOperation_Override(r RosOperation, scope alicloudroscdkcore.Construct, id *string, props *RosOperationProps, enableResourcePropertyConstraint *bool)
func NewRosPluginAttachment_Override ¶
func NewRosPluginAttachment_Override(r RosPluginAttachment, scope alicloudroscdkcore.Construct, id *string, props *RosPluginAttachmentProps, enableResourcePropertyConstraint *bool)
func NewRosPluginClass_Override ¶
func NewRosPluginClass_Override(r RosPluginClass, scope alicloudroscdkcore.Construct, id *string, props *RosPluginClassProps, enableResourcePropertyConstraint *bool)
func NewRosPlugin_Override ¶
func NewRosPlugin_Override(r RosPlugin, scope alicloudroscdkcore.Construct, id *string, props *RosPluginProps, enableResourcePropertyConstraint *bool)
func NewRosPolicy_Override ¶
func NewRosPolicy_Override(r RosPolicy, scope alicloudroscdkcore.Construct, id *string, props *RosPolicyProps, enableResourcePropertyConstraint *bool)
func NewRosRoute_Override ¶
func NewRosRoute_Override(r RosRoute, scope alicloudroscdkcore.Construct, id *string, props *RosRouteProps, enableResourcePropertyConstraint *bool)
func NewRosService_Override ¶
func NewRosService_Override(r RosService, scope alicloudroscdkcore.Construct, id *string, props *RosServiceProps, enableResourcePropertyConstraint *bool)
func NewRoute_Override ¶
func NewRoute_Override(r Route, scope alicloudroscdkcore.Construct, id *string, props *RouteProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func NewService_Override ¶
func NewService_Override(s Service, scope alicloudroscdkcore.Construct, id *string, props *ServiceProps, enableResourcePropertyConstraint *bool)
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
func Operation_IsConstruct ¶
func Operation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func PluginAttachment_IsConstruct ¶
func PluginAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func PluginClass_IsConstruct ¶
func PluginClass_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Plugin_IsConstruct ¶
func Plugin_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Policy_IsConstruct ¶
func Policy_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApiAttachment_IsConstruct ¶
func RosApiAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosApiAttachment_IsRosElement ¶
func RosApiAttachment_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosApiAttachment_IsRosResource ¶
func RosApiAttachment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosApiAttachment_ROS_RESOURCE_TYPE_NAME ¶
func RosApiAttachment_ROS_RESOURCE_TYPE_NAME() *string
func RosDomain_IsConstruct ¶
func RosDomain_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosDomain_IsRosElement ¶
func RosDomain_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosDomain_IsRosResource ¶
func RosDomain_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosDomain_ROS_RESOURCE_TYPE_NAME ¶
func RosDomain_ROS_RESOURCE_TYPE_NAME() *string
func RosEnvironment_IsConstruct ¶
func RosEnvironment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosEnvironment_IsRosElement ¶
func RosEnvironment_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosEnvironment_IsRosResource ¶
func RosEnvironment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosEnvironment_ROS_RESOURCE_TYPE_NAME ¶
func RosEnvironment_ROS_RESOURCE_TYPE_NAME() *string
func RosGateway_IsConstruct ¶
func RosGateway_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosGateway_IsRosElement ¶
func RosGateway_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosGateway_IsRosResource ¶
func RosGateway_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosGateway_ROS_RESOURCE_TYPE_NAME ¶
func RosGateway_ROS_RESOURCE_TYPE_NAME() *string
func RosHttpApi_IsConstruct ¶
func RosHttpApi_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosHttpApi_IsRosElement ¶
func RosHttpApi_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosHttpApi_IsRosResource ¶
func RosHttpApi_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosHttpApi_ROS_RESOURCE_TYPE_NAME ¶
func RosHttpApi_ROS_RESOURCE_TYPE_NAME() *string
func RosOperation_IsConstruct ¶
func RosOperation_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosOperation_IsRosElement ¶
func RosOperation_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosOperation_IsRosResource ¶
func RosOperation_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosOperation_ROS_RESOURCE_TYPE_NAME ¶
func RosOperation_ROS_RESOURCE_TYPE_NAME() *string
func RosPluginAttachment_IsConstruct ¶
func RosPluginAttachment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPluginAttachment_IsRosElement ¶
func RosPluginAttachment_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosPluginAttachment_IsRosResource ¶
func RosPluginAttachment_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPluginAttachment_ROS_RESOURCE_TYPE_NAME ¶
func RosPluginAttachment_ROS_RESOURCE_TYPE_NAME() *string
func RosPluginClass_IsConstruct ¶
func RosPluginClass_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPluginClass_IsRosElement ¶
func RosPluginClass_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosPluginClass_IsRosResource ¶
func RosPluginClass_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPluginClass_ROS_RESOURCE_TYPE_NAME ¶
func RosPluginClass_ROS_RESOURCE_TYPE_NAME() *string
func RosPlugin_IsConstruct ¶
func RosPlugin_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPlugin_IsRosElement ¶
func RosPlugin_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosPlugin_IsRosResource ¶
func RosPlugin_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPlugin_ROS_RESOURCE_TYPE_NAME ¶
func RosPlugin_ROS_RESOURCE_TYPE_NAME() *string
func RosPolicy_IsConstruct ¶
func RosPolicy_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosPolicy_IsRosElement ¶
func RosPolicy_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosPolicy_IsRosResource ¶
func RosPolicy_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosPolicy_ROS_RESOURCE_TYPE_NAME ¶
func RosPolicy_ROS_RESOURCE_TYPE_NAME() *string
func RosRoute_IsConstruct ¶
func RosRoute_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosRoute_IsRosElement ¶
func RosRoute_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosRoute_IsRosResource ¶
func RosRoute_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosRoute_ROS_RESOURCE_TYPE_NAME ¶
func RosRoute_ROS_RESOURCE_TYPE_NAME() *string
func RosService_IsConstruct ¶
func RosService_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func RosService_IsRosElement ¶
func RosService_IsRosElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func RosService_IsRosResource ¶
func RosService_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool
Check whether the given construct is a RosResource.
func RosService_ROS_RESOURCE_TYPE_NAME ¶
func RosService_ROS_RESOURCE_TYPE_NAME() *string
func Route_IsConstruct ¶
func Route_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
func Service_IsConstruct ¶
func Service_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
Types ¶
type ApiAttachment ¶
type ApiAttachment interface { alicloudroscdkcore.Resource IApiAttachment // Attribute EnvironmentId: The ID of the environment to which the API is to deploy. AttrEnvironmentId() interface{} // Attribute HttpApiId: The ID of the HTTP API. AttrHttpApiId() interface{} // Attribute RouteId: The route ID. // // When publishing an HTTP API route, it must be passed in. AttrRouteId() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *ApiAttachmentProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::ApiAttachment`.
func NewApiAttachment ¶
func NewApiAttachment(scope alicloudroscdkcore.Construct, id *string, props *ApiAttachmentProps, enableResourcePropertyConstraint *bool) ApiAttachment
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ApiAttachmentProps ¶
type ApiAttachmentProps struct { // Property backendScene: API release scenario. BackendScene interface{} `field:"required" json:"backendScene" yaml:"backendScene"` // Property environmentId: The ID of the environment to which the API is to deploy. EnvironmentId interface{} `field:"required" json:"environmentId" yaml:"environmentId"` // Property httpApiId: The ID of the HTTP API. HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` // Property serviceConfigs: Services associated with API publishing and their configurations. ServiceConfigs interface{} `field:"required" json:"serviceConfigs" yaml:"serviceConfigs"` // Property description: The description of publication. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property domainIds: The list of user domain names associated with API publishing. DomainIds interface{} `field:"optional" json:"domainIds" yaml:"domainIds"` // Property routeId: The route ID. // // When publishing an HTTP API route, it must be passed in. RouteId interface{} `field:"optional" json:"routeId" yaml:"routeId"` }
Properties for defining a `ApiAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-apiattachment
type Domain ¶
type Domain interface { alicloudroscdkcore.Resource IDomain // Attribute DomainId: The ID of the Domain. AttrDomainId() interface{} // Attribute DomainName: The name of the Domain. AttrDomainName() interface{} // Attribute Protocol: The types of protocols. AttrProtocol() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *DomainProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Domain`.
func NewDomain ¶
func NewDomain(scope alicloudroscdkcore.Construct, id *string, props *DomainProps, enableResourcePropertyConstraint *bool) Domain
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type DomainProps ¶
type DomainProps struct { // Property domainName: The name of the Domain. DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"` // Property protocol: The types of protocols supported by the domain are as follows: * HTTP: Supports only the HTTP protocol. // // * HTTPS: Supports only the HTTPS protocol. Protocol interface{} `field:"required" json:"protocol" yaml:"protocol"` }
Properties for defining a `Domain`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-domain
type Environment ¶
type Environment interface { alicloudroscdkcore.Resource IEnvironment // Attribute Description: Description of the environment. AttrDescription() interface{} // Attribute EnvironmentId: The ID of the environment. AttrEnvironmentId() interface{} // Attribute EnvironmentName: The name of the resource. AttrEnvironmentName() interface{} // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *EnvironmentProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Environment`.
func NewEnvironment ¶
func NewEnvironment(scope alicloudroscdkcore.Construct, id *string, props *EnvironmentProps, enableResourcePropertyConstraint *bool) Environment
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type EnvironmentProps ¶
type EnvironmentProps struct { // Property environmentName: The name of the environment. EnvironmentName interface{} `field:"required" json:"environmentName" yaml:"environmentName"` // Property gatewayId: Gateway id. GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` // Property description: Description of the environment, which can include information such as the purpose of the environment and its owner. Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `Environment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-environment
type Gateway ¶
type Gateway interface { alicloudroscdkcore.Resource IGateway // Attribute CreateTime: The creation timestamp. // // Unit: milliseconds. AttrCreateTime() interface{} // Attribute Environments: The list of environments associated with the Gateway. AttrEnvironments() interface{} // Attribute ExpireTime: Package year and package month expiration timestamp. // // Unit: milliseconds. AttrExpireTime() interface{} // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} // Attribute GatewayName: The name of the resource. AttrGatewayName() interface{} // Attribute LoadBalancers: The list of Gateway ingress addresses. AttrLoadBalancers() interface{} // Attribute PaymentType: The payment type of the gateway. AttrPaymentType() interface{} // Attribute SecurityGroup: The Security Group of the Gateway. AttrSecurityGroup() interface{} // Attribute Spec: Gateway instance specifications. AttrSpec() interface{} // Attribute UpdateTime: Update the timestamp. // // Unit: milliseconds. AttrUpdateTime() interface{} // Attribute Version: The gateway version. AttrVersion() interface{} // Attribute Vpc: The VPC associated with the Gateway. AttrVpc() interface{} // Attribute VSwitch: The virtual switch associated with the Gateway. AttrVSwitch() interface{} // Attribute Zones: The List of zones associated with the Gateway. AttrZones() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *GatewayProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Gateway`.
func NewGateway ¶
func NewGateway(scope alicloudroscdkcore.Construct, id *string, props *GatewayProps, enableResourcePropertyConstraint *bool) Gateway
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type GatewayProps ¶
type GatewayProps struct { // Property paymentType: The payment type of the gateway. // // Valid values: // * PayAsYouGo // * Subscription. PaymentType interface{} `field:"required" json:"paymentType" yaml:"paymentType"` // Property spec: Gateway instance specifications. Spec interface{} `field:"required" json:"spec" yaml:"spec"` // Property zoneConfig: Availability Zone Configuration. ZoneConfig interface{} `field:"required" json:"zoneConfig" yaml:"zoneConfig"` // Property gatewayName: The name of the Gateway. GatewayName interface{} `field:"optional" json:"gatewayName" yaml:"gatewayName"` // Property logConfig: Log Configuration. LogConfig interface{} `field:"optional" json:"logConfig" yaml:"logConfig"` // Property networkAccessConfig: Network Access Configuration. NetworkAccessConfig interface{} `field:"optional" json:"networkAccessConfig" yaml:"networkAccessConfig"` // Property vpc: The VPC associated with the Gateway. Vpc interface{} `field:"optional" json:"vpc" yaml:"vpc"` // Property vSwitch: The virtual switch associated with the Gateway. VSwitch interface{} `field:"optional" json:"vSwitch" yaml:"vSwitch"` }
Properties for defining a `Gateway`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-gateway
type HttpApi ¶
type HttpApi interface { alicloudroscdkcore.Resource IHttpApi // Attribute BasePath: The base path of the API. AttrBasePath() interface{} // Attribute Description: Description of API. AttrDescription() interface{} // Attribute Environments: Published Environmental Information of the API. AttrEnvironments() interface{} // Attribute HttpApiId: The ID of the API. AttrHttpApiId() interface{} // Attribute HttpApiName: The name of the API. AttrHttpApiName() interface{} // Attribute Protocols: List of API Access Protocols. AttrProtocols() interface{} // Attribute Type: The type of HTTP API. AttrType() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *HttpApiProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::HttpApi`.
func NewHttpApi ¶
func NewHttpApi(scope alicloudroscdkcore.Construct, id *string, props *HttpApiProps, enableResourcePropertyConstraint *bool) HttpApi
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type HttpApiProps ¶
type HttpApiProps struct { // Property httpApiName: The name of the API. HttpApiName interface{} `field:"required" json:"httpApiName" yaml:"httpApiName"` // Property protocols: List of API Access Protocols. Protocols interface{} `field:"required" json:"protocols" yaml:"protocols"` // Property basePath: The base path of the API should start with a \/. BasePath interface{} `field:"optional" json:"basePath" yaml:"basePath"` // Property description: Description of API. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property type: The type of HTTP API, Valid values: * Http * Rest * WebSocket * HttpIngress. Type interface{} `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `HttpApi`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi
type IApiAttachment ¶ added in v1.6.0
type IApiAttachment interface { alicloudroscdkcore.IResource // Attribute EnvironmentId: The ID of the environment to which the API is to deploy. AttrEnvironmentId() interface{} // Attribute HttpApiId: The ID of the HTTP API. AttrHttpApiId() interface{} // Attribute RouteId: The route ID. // // When publishing an HTTP API route, it must be passed in. AttrRouteId() interface{} Props() *ApiAttachmentProps }
Represents a `ApiAttachment`.
type IDomain ¶ added in v1.6.0
type IDomain interface { alicloudroscdkcore.IResource // Attribute DomainId: The ID of the Domain. AttrDomainId() interface{} // Attribute DomainName: The name of the Domain. AttrDomainName() interface{} // Attribute Protocol: The types of protocols. AttrProtocol() interface{} Props() *DomainProps }
Represents a `Domain`.
type IEnvironment ¶ added in v1.6.0
type IEnvironment interface { alicloudroscdkcore.IResource // Attribute Description: Description of the environment. AttrDescription() interface{} // Attribute EnvironmentId: The ID of the environment. AttrEnvironmentId() interface{} // Attribute EnvironmentName: The name of the resource. AttrEnvironmentName() interface{} // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} Props() *EnvironmentProps }
Represents a `Environment`.
type IGateway ¶ added in v1.6.0
type IGateway interface { alicloudroscdkcore.IResource // Attribute CreateTime: The creation timestamp. // // Unit: milliseconds. AttrCreateTime() interface{} // Attribute Environments: The list of environments associated with the Gateway. AttrEnvironments() interface{} // Attribute ExpireTime: Package year and package month expiration timestamp. // // Unit: milliseconds. AttrExpireTime() interface{} // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} // Attribute GatewayName: The name of the resource. AttrGatewayName() interface{} // Attribute LoadBalancers: The list of Gateway ingress addresses. AttrLoadBalancers() interface{} // Attribute PaymentType: The payment type of the gateway. AttrPaymentType() interface{} // Attribute SecurityGroup: The Security Group of the Gateway. AttrSecurityGroup() interface{} // Attribute Spec: Gateway instance specifications. AttrSpec() interface{} // Attribute UpdateTime: Update the timestamp. // // Unit: milliseconds. AttrUpdateTime() interface{} // Attribute Version: The gateway version. AttrVersion() interface{} // Attribute Vpc: The VPC associated with the Gateway. AttrVpc() interface{} // Attribute VSwitch: The virtual switch associated with the Gateway. AttrVSwitch() interface{} // Attribute Zones: The List of zones associated with the Gateway. AttrZones() interface{} Props() *GatewayProps }
Represents a `Gateway`.
type IHttpApi ¶ added in v1.6.0
type IHttpApi interface { alicloudroscdkcore.IResource // Attribute BasePath: The base path of the API. AttrBasePath() interface{} // Attribute Description: Description of API. AttrDescription() interface{} // Attribute Environments: Published Environmental Information of the API. AttrEnvironments() interface{} // Attribute HttpApiId: The ID of the API. AttrHttpApiId() interface{} // Attribute HttpApiName: The name of the API. AttrHttpApiName() interface{} // Attribute Protocols: List of API Access Protocols. AttrProtocols() interface{} // Attribute Type: The type of HTTP API. AttrType() interface{} Props() *HttpApiProps }
Represents a `HttpApi`.
type IOperation ¶ added in v1.6.0
type IOperation interface { alicloudroscdkcore.IResource // Attribute CreateTime: The creation timestamp of the operation. AttrCreateTime() interface{} // Attribute Description: The description of the operation. AttrDescription() interface{} // Attribute Method: The method of http protocol. AttrMethod() interface{} // Attribute Mock: Mock configuration. AttrMock() interface{} // Attribute OperationId: The ID of the operation. AttrOperationId() interface{} // Attribute OperationName: The name of the resource. AttrOperationName() interface{} // Attribute Path: The interface path of the operation. AttrPath() interface{} Props() *OperationProps }
Represents a `Operation`.
type IPlugin ¶ added in v1.6.0
type IPlugin interface { alicloudroscdkcore.IResource // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} // Attribute GatewayName: The name of the gateway. AttrGatewayName() interface{} // Attribute PluginClassId: The ID of the plugin class. AttrPluginClassId() interface{} // Attribute PluginId: The ID of the plugin. AttrPluginId() interface{} Props() *PluginProps }
Represents a `Plugin`.
type IPluginAttachment ¶ added in v1.6.0
type IPluginAttachment interface { alicloudroscdkcore.IResource // Attribute AttachResourceId: The resource ID to be attached by the plugin. AttrAttachResourceId() interface{} // Attribute AttachResourceIds: The list of resource IDs to be attached by the plugin. AttrAttachResourceIds() interface{} // Attribute AttachResourceNames: The list of resource names to be attached by the plugin. AttrAttachResourceNames() interface{} // Attribute AttachResourceParentIds: The list of parent IDs for resources to be attached by the plugin. AttrAttachResourceParentIds() interface{} // Attribute AttachResourceType: The type of the resource to be attached by the plugin. AttrAttachResourceType() interface{} // Attribute Enable: Whether to enable this plugin. AttrEnable() interface{} // Attribute EnvironmentId: The ID of the environment. AttrEnvironmentId() interface{} // Attribute PluginAttachmentId: The ID of plugin attachment. AttrPluginAttachmentId() interface{} // Attribute PluginClassInfo: The type of the plugin. AttrPluginClassInfo() interface{} // Attribute PluginInfo: The information about the association of plugin with gateway instance. AttrPluginInfo() interface{} Props() *PluginAttachmentProps }
Represents a `PluginAttachment`.
type IPluginClass ¶ added in v1.6.0
type IPluginClass interface { alicloudroscdkcore.IResource // Attribute Alias: The alias of the plugin class. AttrAlias() interface{} // Attribute Description: The description of the plugin class. AttrDescription() interface{} // Attribute Document: The document of plugin. AttrDocument() interface{} // Attribute PluginClassName: The name of the plugin class. AttrPluginClassName() interface{} // Attribute Type: The type of the plugin class. AttrType() interface{} // Attribute WasmLanguage: Wasm language. AttrWasmLanguage() interface{} Props() *PluginClassProps }
Represents a `PluginClass`.
type IPolicy ¶ added in v1.6.0
type IPolicy interface { alicloudroscdkcore.IResource // Attribute PolicyClassId: The ID of policy class. AttrPolicyClassId() interface{} // Attribute PolicyClassName: The name of policy class. AttrPolicyClassName() interface{} // Attribute PolicyConfig: Policy Configuration. AttrPolicyConfig() interface{} // Attribute PolicyId: The ID of the policy. AttrPolicyId() interface{} // Attribute PolicyName: The name of the policy. AttrPolicyName() interface{} Props() *PolicyProps }
Represents a `Policy`.
type IRoute ¶ added in v1.6.0
type IRoute interface { alicloudroscdkcore.IResource // Attribute Backend: Backend services. AttrBackend() interface{} // Attribute Description: The description of route resource. AttrDescription() interface{} // Attribute DomainInfos: Domain items. AttrDomainInfos() interface{} // Attribute EnvironmentInfo: Environment information. AttrEnvironmentInfo() interface{} // Attribute Match: The match rule of route resource. AttrMatch() interface{} // Attribute RouteId: The ID of route resource. AttrRouteId() interface{} // Attribute RouteName: The name of the route. AttrRouteName() interface{} Props() *RouteProps }
Represents a `Route`.
type IService ¶ added in v1.6.0
type IService interface { alicloudroscdkcore.IResource // Attribute Addresses: Service Address List. AttrAddresses() interface{} // Attribute GatewayId: The ID of the Cloud Native API Gateway. AttrGatewayId() interface{} // Attribute ServiceId: The ID of the service. AttrServiceId() interface{} // Attribute ServiceName: The Name of the service . AttrServiceName() interface{} // Attribute SourceType: Service source type. AttrSourceType() interface{} Props() *ServiceProps }
Represents a `Service`.
type Operation ¶
type Operation interface { alicloudroscdkcore.Resource IOperation // Attribute CreateTime: The creation timestamp of the operation. AttrCreateTime() interface{} // Attribute Description: The description of the operation. AttrDescription() interface{} // Attribute Method: The method of http protocol. AttrMethod() interface{} // Attribute Mock: Mock configuration. AttrMock() interface{} // Attribute OperationId: The ID of the operation. AttrOperationId() interface{} // Attribute OperationName: The name of the resource. AttrOperationName() interface{} // Attribute Path: The interface path of the operation. AttrPath() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *OperationProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Operation`.
func NewOperation ¶
func NewOperation(scope alicloudroscdkcore.Construct, id *string, props *OperationProps, enableResourcePropertyConstraint *bool) Operation
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type OperationProps ¶
type OperationProps struct { // Property httpApiId: The HTTP API ID to which the interface belongs. HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` // Property method: The method of http protocol. Method interface{} `field:"required" json:"method" yaml:"method"` // Property operationName: The name of the operation. OperationName interface{} `field:"required" json:"operationName" yaml:"operationName"` // Property path: The interface path of the operation. Path interface{} `field:"required" json:"path" yaml:"path"` // Property description: The description of the operation. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property mock: Mock configuration. Mock interface{} `field:"optional" json:"mock" yaml:"mock"` }
Properties for defining a `Operation`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-operation
type Plugin ¶
type Plugin interface { alicloudroscdkcore.Resource IPlugin // Attribute GatewayId: The ID of the Gateway. AttrGatewayId() interface{} // Attribute GatewayName: The name of the gateway. AttrGatewayName() interface{} // Attribute PluginClassId: The ID of the plugin class. AttrPluginClassId() interface{} // Attribute PluginId: The ID of the plugin. AttrPluginId() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *PluginProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Plugin`.
func NewPlugin ¶
func NewPlugin(scope alicloudroscdkcore.Construct, id *string, props *PluginProps, enableResourcePropertyConstraint *bool) Plugin
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PluginAttachment ¶
type PluginAttachment interface { alicloudroscdkcore.Resource IPluginAttachment // Attribute AttachResourceId: The resource ID to be attached by the plugin. AttrAttachResourceId() interface{} // Attribute AttachResourceIds: The list of resource IDs to be attached by the plugin. AttrAttachResourceIds() interface{} // Attribute AttachResourceNames: The list of resource names to be attached by the plugin. AttrAttachResourceNames() interface{} // Attribute AttachResourceParentIds: The list of parent IDs for resources to be attached by the plugin. AttrAttachResourceParentIds() interface{} // Attribute AttachResourceType: The type of the resource to be attached by the plugin. AttrAttachResourceType() interface{} // Attribute Enable: Whether to enable this plugin. AttrEnable() interface{} // Attribute EnvironmentId: The ID of the environment. AttrEnvironmentId() interface{} // Attribute PluginAttachmentId: The ID of plugin attachment. AttrPluginAttachmentId() interface{} // Attribute PluginClassInfo: The type of the plugin. AttrPluginClassInfo() interface{} // Attribute PluginInfo: The information about the association of plugin with gateway instance. AttrPluginInfo() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *PluginAttachmentProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::PluginAttachment`.
func NewPluginAttachment ¶
func NewPluginAttachment(scope alicloudroscdkcore.Construct, id *string, props *PluginAttachmentProps, enableResourcePropertyConstraint *bool) PluginAttachment
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PluginAttachmentProps ¶
type PluginAttachmentProps struct { // Property pluginInfo: The information about the association of plugin with gateway instance. PluginInfo interface{} `field:"required" json:"pluginInfo" yaml:"pluginInfo"` // Property attachResourceId: The resource ID to be attached by the plugin. AttachResourceId interface{} `field:"optional" json:"attachResourceId" yaml:"attachResourceId"` // Property attachResourceIds: The list of resource IDs to be attached by the plugin. AttachResourceIds interface{} `field:"optional" json:"attachResourceIds" yaml:"attachResourceIds"` // Property attachResourceType: The type of the resource to be attached by the plugin. AttachResourceType interface{} `field:"optional" json:"attachResourceType" yaml:"attachResourceType"` // Property enable: Whether to enable this plugin, default value is false. Enable interface{} `field:"optional" json:"enable" yaml:"enable"` // Property environmentId: The ID of the environment. EnvironmentId interface{} `field:"optional" json:"environmentId" yaml:"environmentId"` }
Properties for defining a `PluginAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-pluginattachment
type PluginClass ¶
type PluginClass interface { alicloudroscdkcore.Resource IPluginClass // Attribute Alias: The alias of the plugin class. AttrAlias() interface{} // Attribute Description: The description of the plugin class. AttrDescription() interface{} // Attribute Document: The document of plugin. AttrDocument() interface{} // Attribute PluginClassName: The name of the plugin class. AttrPluginClassName() interface{} // Attribute Type: The type of the plugin class. AttrType() interface{} // Attribute WasmLanguage: Wasm language. AttrWasmLanguage() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *PluginClassProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::PluginClass`.
func NewPluginClass ¶
func NewPluginClass(scope alicloudroscdkcore.Construct, id *string, props *PluginClassProps, enableResourcePropertyConstraint *bool) PluginClass
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PluginClassProps ¶
type PluginClassProps struct { // Property description: The description of the plugin class. Description interface{} `field:"required" json:"description" yaml:"description"` // Property executePriority: The execute priority of the Plugin. ExecutePriority interface{} `field:"required" json:"executePriority" yaml:"executePriority"` // Property executeStage: The Execution stage. ExecuteStage interface{} `field:"required" json:"executeStage" yaml:"executeStage"` // Property pluginClassName: The name of the plugin class. PluginClassName interface{} `field:"required" json:"pluginClassName" yaml:"pluginClassName"` // Property version: The version of plugin class. Version interface{} `field:"required" json:"version" yaml:"version"` // Property versionDescription: The description of the version . VersionDescription interface{} `field:"required" json:"versionDescription" yaml:"versionDescription"` // Property wasmLanguage: the language of the wasm. WasmLanguage interface{} `field:"required" json:"wasmLanguage" yaml:"wasmLanguage"` // Property wasmUrl: The url of the wasm. WasmUrl interface{} `field:"required" json:"wasmUrl" yaml:"wasmUrl"` // Property alias: The alias of the plugin class. Alias interface{} `field:"optional" json:"alias" yaml:"alias"` // Property supportedMinGatewayVersion: The supported minimum gateway version. SupportedMinGatewayVersion interface{} `field:"optional" json:"supportedMinGatewayVersion" yaml:"supportedMinGatewayVersion"` }
Properties for defining a `PluginClass`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-pluginclass
type PluginProps ¶
type PluginProps struct { // Property gatewayId: The ID of the Gateway. GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` // Property pluginClassId: The ID of the plugin class. PluginClassId interface{} `field:"required" json:"pluginClassId" yaml:"pluginClassId"` }
Properties for defining a `Plugin`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-plugin
type Policy ¶
type Policy interface { alicloudroscdkcore.Resource IPolicy // Attribute PolicyClassId: The ID of policy class. AttrPolicyClassId() interface{} // Attribute PolicyClassName: The name of policy class. AttrPolicyClassName() interface{} // Attribute PolicyConfig: Policy Configuration. AttrPolicyConfig() interface{} // Attribute PolicyId: The ID of the policy. AttrPolicyId() interface{} // Attribute PolicyName: The name of the policy. AttrPolicyName() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *PolicyProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Policy`.
func NewPolicy ¶
func NewPolicy(scope alicloudroscdkcore.Construct, id *string, props *PolicyProps, enableResourcePropertyConstraint *bool) Policy
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type PolicyProps ¶
type PolicyProps struct { // Property attachResourceIds: The Mount point id list. AttachResourceIds interface{} `field:"required" json:"attachResourceIds" yaml:"attachResourceIds"` // Property attachResourceType: Policies support mount point types. // // HttpApi:HttpApi. // Operation: the Operation of the HttpApi. // GatewayRoute: Gateway route. // GatewayService: Gateway service. // GatewayServicePort: The Gateway service port. // Domain: The Gateway Domain name. // Gateway: Gateway. AttachResourceType interface{} `field:"required" json:"attachResourceType" yaml:"attachResourceType"` // Property environmentId: The id of the environment. EnvironmentId interface{} `field:"required" json:"environmentId" yaml:"environmentId"` // Property gatewayId: The ID of the Gateway. GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` // Property policyClassName: The name of the policy class. PolicyClassName interface{} `field:"required" json:"policyClassName" yaml:"policyClassName"` // Property policyConfig: Policy Configuration. PolicyConfig interface{} `field:"required" json:"policyConfig" yaml:"policyConfig"` // Property policyName: The name of the policy. PolicyName interface{} `field:"optional" json:"policyName" yaml:"policyName"` }
Properties for defining a `Policy`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-policy
type RosApiAttachment ¶
type RosApiAttachment interface { alicloudroscdkcore.RosResource AttrEnvironmentId() alicloudroscdkcore.IResolvable AttrHttpApiId() alicloudroscdkcore.IResolvable AttrRouteId() alicloudroscdkcore.IResolvable BackendScene() interface{} SetBackendScene(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) DomainIds() interface{} SetDomainIds(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvironmentId() interface{} SetEnvironmentId(val interface{}) HttpApiId() interface{} SetHttpApiId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string RouteId() interface{} SetRouteId(val interface{}) ServiceConfigs() interface{} SetServiceConfigs(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::ApiAttachment`.
func NewRosApiAttachment ¶
func NewRosApiAttachment(scope alicloudroscdkcore.Construct, id *string, props *RosApiAttachmentProps, enableResourcePropertyConstraint *bool) RosApiAttachment
type RosApiAttachmentProps ¶
type RosApiAttachmentProps struct { BackendScene interface{} `field:"required" json:"backendScene" yaml:"backendScene"` EnvironmentId interface{} `field:"required" json:"environmentId" yaml:"environmentId"` HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` ServiceConfigs interface{} `field:"required" json:"serviceConfigs" yaml:"serviceConfigs"` Description interface{} `field:"optional" json:"description" yaml:"description"` DomainIds interface{} `field:"optional" json:"domainIds" yaml:"domainIds"` RouteId interface{} `field:"optional" json:"routeId" yaml:"routeId"` }
Properties for defining a `RosApiAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-apiattachment
type RosApiAttachment_ConditionsProperty ¶
type RosApiAttachment_ConditionsProperty struct { Key interface{} `field:"optional" json:"key" yaml:"key"` Operator interface{} `field:"optional" json:"operator" yaml:"operator"` Type interface{} `field:"optional" json:"type" yaml:"type"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosApiAttachment_MatchProperty ¶
type RosApiAttachment_MatchProperty struct { Conditions interface{} `field:"optional" json:"conditions" yaml:"conditions"` DefaultMatch interface{} `field:"optional" json:"defaultMatch" yaml:"defaultMatch"` }
type RosApiAttachment_ServiceConfigsProperty ¶
type RosApiAttachment_ServiceConfigsProperty struct { ServiceId interface{} `field:"required" json:"serviceId" yaml:"serviceId"` Weight interface{} `field:"required" json:"weight" yaml:"weight"` Match interface{} `field:"optional" json:"match" yaml:"match"` Port interface{} `field:"optional" json:"port" yaml:"port"` Protocol interface{} `field:"optional" json:"protocol" yaml:"protocol"` Version interface{} `field:"optional" json:"version" yaml:"version"` }
type RosDomain ¶
type RosDomain interface { alicloudroscdkcore.RosResource AttrDomainId() alicloudroscdkcore.IResolvable AttrDomainName() alicloudroscdkcore.IResolvable AttrProtocol() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string DomainName() interface{} SetDomainName(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode Protocol() interface{} SetProtocol(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Domain`.
func NewRosDomain ¶
func NewRosDomain(scope alicloudroscdkcore.Construct, id *string, props *RosDomainProps, enableResourcePropertyConstraint *bool) RosDomain
type RosDomainProps ¶
type RosDomainProps struct { DomainName interface{} `field:"required" json:"domainName" yaml:"domainName"` Protocol interface{} `field:"required" json:"protocol" yaml:"protocol"` }
Properties for defining a `RosDomain`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-domain
type RosEnvironment ¶
type RosEnvironment interface { alicloudroscdkcore.RosResource AttrDescription() alicloudroscdkcore.IResolvable AttrEnvironmentId() alicloudroscdkcore.IResolvable AttrEnvironmentName() alicloudroscdkcore.IResolvable AttrGatewayId() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvironmentName() interface{} SetEnvironmentName(val interface{}) GatewayId() interface{} SetGatewayId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Environment`.
func NewRosEnvironment ¶
func NewRosEnvironment(scope alicloudroscdkcore.Construct, id *string, props *RosEnvironmentProps, enableResourcePropertyConstraint *bool) RosEnvironment
type RosEnvironmentProps ¶
type RosEnvironmentProps struct { EnvironmentName interface{} `field:"required" json:"environmentName" yaml:"environmentName"` GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` Description interface{} `field:"optional" json:"description" yaml:"description"` }
Properties for defining a `RosEnvironment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-environment
type RosGateway ¶
type RosGateway interface { alicloudroscdkcore.RosResource AttrCreateTime() alicloudroscdkcore.IResolvable AttrEnvironments() alicloudroscdkcore.IResolvable AttrExpireTime() alicloudroscdkcore.IResolvable AttrGatewayId() alicloudroscdkcore.IResolvable AttrGatewayName() alicloudroscdkcore.IResolvable AttrLoadBalancers() alicloudroscdkcore.IResolvable AttrPaymentType() alicloudroscdkcore.IResolvable AttrSecurityGroup() alicloudroscdkcore.IResolvable AttrSpec() alicloudroscdkcore.IResolvable AttrUpdateTime() alicloudroscdkcore.IResolvable AttrVersion() alicloudroscdkcore.IResolvable AttrVpc() alicloudroscdkcore.IResolvable AttrVSwitch() alicloudroscdkcore.IResolvable AttrZones() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GatewayName() interface{} SetGatewayName(val interface{}) LogConfig() interface{} SetLogConfig(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string NetworkAccessConfig() interface{} SetNetworkAccessConfig(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode PaymentType() interface{} SetPaymentType(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string Spec() interface{} SetSpec(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} Vpc() interface{} SetVpc(val interface{}) VSwitch() interface{} SetVSwitch(val interface{}) ZoneConfig() interface{} SetZoneConfig(val interface{}) AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Gateway`.
func NewRosGateway ¶
func NewRosGateway(scope alicloudroscdkcore.Construct, id *string, props *RosGatewayProps, enableResourcePropertyConstraint *bool) RosGateway
type RosGatewayProps ¶
type RosGatewayProps struct { PaymentType interface{} `field:"required" json:"paymentType" yaml:"paymentType"` Spec interface{} `field:"required" json:"spec" yaml:"spec"` ZoneConfig interface{} `field:"required" json:"zoneConfig" yaml:"zoneConfig"` GatewayName interface{} `field:"optional" json:"gatewayName" yaml:"gatewayName"` LogConfig interface{} `field:"optional" json:"logConfig" yaml:"logConfig"` NetworkAccessConfig interface{} `field:"optional" json:"networkAccessConfig" yaml:"networkAccessConfig"` Vpc interface{} `field:"optional" json:"vpc" yaml:"vpc"` VSwitch interface{} `field:"optional" json:"vSwitch" yaml:"vSwitch"` }
Properties for defining a `RosGateway`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-gateway
type RosGateway_LogConfigProperty ¶
type RosGateway_LogConfigProperty struct {
Sls interface{} `field:"optional" json:"sls" yaml:"sls"`
}
type RosGateway_NetworkAccessConfigProperty ¶
type RosGateway_NetworkAccessConfigProperty struct {
Type interface{} `field:"required" json:"type" yaml:"type"`
}
type RosGateway_SlsProperty ¶
type RosGateway_SlsProperty struct {
Enable interface{} `field:"optional" json:"enable" yaml:"enable"`
}
type RosGateway_VSwitchProperty ¶
type RosGateway_VSwitchProperty struct { VSwitchId interface{} `field:"required" json:"vSwitchId" yaml:"vSwitchId"` Name interface{} `field:"optional" json:"name" yaml:"name"` }
type RosGateway_VpcProperty ¶
type RosGateway_VpcProperty struct { VpcId interface{} `field:"required" json:"vpcId" yaml:"vpcId"` Name interface{} `field:"optional" json:"name" yaml:"name"` }
type RosGateway_ZoneConfigProperty ¶
type RosGateway_ZoneConfigProperty struct {
SelectOption interface{} `field:"required" json:"selectOption" yaml:"selectOption"`
}
type RosHttpApi ¶
type RosHttpApi interface { alicloudroscdkcore.RosResource AttrBasePath() alicloudroscdkcore.IResolvable AttrDescription() alicloudroscdkcore.IResolvable AttrEnvironments() alicloudroscdkcore.IResolvable AttrHttpApiId() alicloudroscdkcore.IResolvable AttrHttpApiName() alicloudroscdkcore.IResolvable AttrProtocols() alicloudroscdkcore.IResolvable AttrType() alicloudroscdkcore.IResolvable BasePath() interface{} SetBasePath(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) HttpApiName() interface{} SetHttpApiName(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode Protocols() interface{} SetProtocols(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack Type() interface{} SetType(val interface{}) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::HttpApi`.
func NewRosHttpApi ¶
func NewRosHttpApi(scope alicloudroscdkcore.Construct, id *string, props *RosHttpApiProps, enableResourcePropertyConstraint *bool) RosHttpApi
type RosHttpApiProps ¶
type RosHttpApiProps struct { HttpApiName interface{} `field:"required" json:"httpApiName" yaml:"httpApiName"` Protocols interface{} `field:"required" json:"protocols" yaml:"protocols"` BasePath interface{} `field:"optional" json:"basePath" yaml:"basePath"` Description interface{} `field:"optional" json:"description" yaml:"description"` Type interface{} `field:"optional" json:"type" yaml:"type"` }
Properties for defining a `RosHttpApi`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-httpapi
type RosOperation ¶
type RosOperation interface { alicloudroscdkcore.RosResource AttrCreateTime() alicloudroscdkcore.IResolvable AttrDescription() alicloudroscdkcore.IResolvable AttrMethod() alicloudroscdkcore.IResolvable AttrMock() alicloudroscdkcore.IResolvable AttrOperationId() alicloudroscdkcore.IResolvable AttrOperationName() alicloudroscdkcore.IResolvable AttrPath() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) HttpApiId() interface{} SetHttpApiId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string Method() interface{} SetMethod(val interface{}) Mock() interface{} SetMock(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode OperationName() interface{} SetOperationName(val interface{}) Path() interface{} SetPath(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Operation`.
func NewRosOperation ¶
func NewRosOperation(scope alicloudroscdkcore.Construct, id *string, props *RosOperationProps, enableResourcePropertyConstraint *bool) RosOperation
type RosOperationProps ¶
type RosOperationProps struct { HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` Method interface{} `field:"required" json:"method" yaml:"method"` OperationName interface{} `field:"required" json:"operationName" yaml:"operationName"` Path interface{} `field:"required" json:"path" yaml:"path"` Description interface{} `field:"optional" json:"description" yaml:"description"` Mock interface{} `field:"optional" json:"mock" yaml:"mock"` }
Properties for defining a `RosOperation`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-operation
type RosOperation_MockProperty ¶
type RosOperation_MockProperty struct { ResponseCode interface{} `field:"required" json:"responseCode" yaml:"responseCode"` Enable interface{} `field:"optional" json:"enable" yaml:"enable"` ResponseContent interface{} `field:"optional" json:"responseContent" yaml:"responseContent"` }
type RosPlugin ¶
type RosPlugin interface { alicloudroscdkcore.RosResource AttrGatewayId() alicloudroscdkcore.IResolvable AttrGatewayName() alicloudroscdkcore.IResolvable AttrPluginClassId() alicloudroscdkcore.IResolvable AttrPluginId() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GatewayId() interface{} SetGatewayId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode PluginClassId() interface{} SetPluginClassId(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Plugin`.
func NewRosPlugin ¶
func NewRosPlugin(scope alicloudroscdkcore.Construct, id *string, props *RosPluginProps, enableResourcePropertyConstraint *bool) RosPlugin
type RosPluginAttachment ¶
type RosPluginAttachment interface { alicloudroscdkcore.RosResource AttachResourceId() interface{} SetAttachResourceId(val interface{}) AttachResourceIds() interface{} SetAttachResourceIds(val interface{}) AttachResourceType() interface{} SetAttachResourceType(val interface{}) AttrAttachResourceId() alicloudroscdkcore.IResolvable AttrAttachResourceIds() alicloudroscdkcore.IResolvable AttrAttachResourceNames() alicloudroscdkcore.IResolvable AttrAttachResourceParentIds() alicloudroscdkcore.IResolvable AttrAttachResourceType() alicloudroscdkcore.IResolvable AttrEnable() alicloudroscdkcore.IResolvable AttrEnvironmentId() alicloudroscdkcore.IResolvable AttrPluginAttachmentId() alicloudroscdkcore.IResolvable AttrPluginClassInfo() alicloudroscdkcore.IResolvable AttrPluginInfo() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Enable() interface{} SetEnable(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvironmentId() interface{} SetEnvironmentId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode PluginInfo() interface{} SetPluginInfo(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::PluginAttachment`.
func NewRosPluginAttachment ¶
func NewRosPluginAttachment(scope alicloudroscdkcore.Construct, id *string, props *RosPluginAttachmentProps, enableResourcePropertyConstraint *bool) RosPluginAttachment
type RosPluginAttachmentProps ¶
type RosPluginAttachmentProps struct { PluginInfo interface{} `field:"required" json:"pluginInfo" yaml:"pluginInfo"` AttachResourceId interface{} `field:"optional" json:"attachResourceId" yaml:"attachResourceId"` AttachResourceIds interface{} `field:"optional" json:"attachResourceIds" yaml:"attachResourceIds"` AttachResourceType interface{} `field:"optional" json:"attachResourceType" yaml:"attachResourceType"` Enable interface{} `field:"optional" json:"enable" yaml:"enable"` EnvironmentId interface{} `field:"optional" json:"environmentId" yaml:"environmentId"` }
Properties for defining a `RosPluginAttachment`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-pluginattachment
type RosPluginAttachment_PluginInfoProperty ¶
type RosPluginAttachment_PluginInfoProperty struct { GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` PluginId interface{} `field:"required" json:"pluginId" yaml:"pluginId"` PluginConfig interface{} `field:"optional" json:"pluginConfig" yaml:"pluginConfig"` }
type RosPluginClass ¶
type RosPluginClass interface { alicloudroscdkcore.RosResource Alias() interface{} SetAlias(val interface{}) AttrAlias() alicloudroscdkcore.IResolvable AttrDescription() alicloudroscdkcore.IResolvable AttrDocument() alicloudroscdkcore.IResolvable AttrPluginClassName() alicloudroscdkcore.IResolvable AttrType() alicloudroscdkcore.IResolvable AttrWasmLanguage() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) ExecutePriority() interface{} SetExecutePriority(val interface{}) ExecuteStage() interface{} SetExecuteStage(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode PluginClassName() interface{} SetPluginClassName(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack SupportedMinGatewayVersion() interface{} SetSupportedMinGatewayVersion(val interface{}) // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} Version() interface{} SetVersion(val interface{}) VersionDescription() interface{} SetVersionDescription(val interface{}) WasmLanguage() interface{} SetWasmLanguage(val interface{}) WasmUrl() interface{} SetWasmUrl(val interface{}) AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::PluginClass`.
func NewRosPluginClass ¶
func NewRosPluginClass(scope alicloudroscdkcore.Construct, id *string, props *RosPluginClassProps, enableResourcePropertyConstraint *bool) RosPluginClass
type RosPluginClassProps ¶
type RosPluginClassProps struct { Description interface{} `field:"required" json:"description" yaml:"description"` ExecutePriority interface{} `field:"required" json:"executePriority" yaml:"executePriority"` ExecuteStage interface{} `field:"required" json:"executeStage" yaml:"executeStage"` PluginClassName interface{} `field:"required" json:"pluginClassName" yaml:"pluginClassName"` Version interface{} `field:"required" json:"version" yaml:"version"` VersionDescription interface{} `field:"required" json:"versionDescription" yaml:"versionDescription"` WasmLanguage interface{} `field:"required" json:"wasmLanguage" yaml:"wasmLanguage"` WasmUrl interface{} `field:"required" json:"wasmUrl" yaml:"wasmUrl"` Alias interface{} `field:"optional" json:"alias" yaml:"alias"` SupportedMinGatewayVersion interface{} `field:"optional" json:"supportedMinGatewayVersion" yaml:"supportedMinGatewayVersion"` }
Properties for defining a `RosPluginClass`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-pluginclass
type RosPluginProps ¶
type RosPluginProps struct { GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` PluginClassId interface{} `field:"required" json:"pluginClassId" yaml:"pluginClassId"` }
Properties for defining a `RosPlugin`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-plugin
type RosPolicy ¶
type RosPolicy interface { alicloudroscdkcore.RosResource AttachResourceIds() interface{} SetAttachResourceIds(val interface{}) AttachResourceType() interface{} SetAttachResourceType(val interface{}) AttrPolicyClassId() alicloudroscdkcore.IResolvable AttrPolicyClassName() alicloudroscdkcore.IResolvable AttrPolicyConfig() alicloudroscdkcore.IResolvable AttrPolicyId() alicloudroscdkcore.IResolvable AttrPolicyName() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvironmentId() interface{} SetEnvironmentId(val interface{}) GatewayId() interface{} SetGatewayId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode PolicyClassName() interface{} SetPolicyClassName(val interface{}) PolicyConfig() interface{} SetPolicyConfig(val interface{}) PolicyName() interface{} SetPolicyName(val interface{}) // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Policy`.
func NewRosPolicy ¶
func NewRosPolicy(scope alicloudroscdkcore.Construct, id *string, props *RosPolicyProps, enableResourcePropertyConstraint *bool) RosPolicy
type RosPolicyProps ¶
type RosPolicyProps struct { AttachResourceIds interface{} `field:"required" json:"attachResourceIds" yaml:"attachResourceIds"` AttachResourceType interface{} `field:"required" json:"attachResourceType" yaml:"attachResourceType"` EnvironmentId interface{} `field:"required" json:"environmentId" yaml:"environmentId"` GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` PolicyClassName interface{} `field:"required" json:"policyClassName" yaml:"policyClassName"` PolicyConfig interface{} `field:"required" json:"policyConfig" yaml:"policyConfig"` PolicyName interface{} `field:"optional" json:"policyName" yaml:"policyName"` }
Properties for defining a `RosPolicy`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-policy
type RosRoute ¶
type RosRoute interface { alicloudroscdkcore.RosResource AttrBackend() alicloudroscdkcore.IResolvable AttrDescription() alicloudroscdkcore.IResolvable AttrDomainInfos() alicloudroscdkcore.IResolvable AttrEnvironmentInfo() alicloudroscdkcore.IResolvable AttrMatch() alicloudroscdkcore.IResolvable AttrRouteId() alicloudroscdkcore.IResolvable AttrRouteName() alicloudroscdkcore.IResolvable Backend() interface{} SetBackend(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string Description() interface{} SetDescription(val interface{}) DomainIds() interface{} SetDomainIds(val interface{}) DomainInfos() interface{} SetDomainInfos(val interface{}) EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) EnvironmentInfo() interface{} SetEnvironmentInfo(val interface{}) HttpApiId() interface{} SetHttpApiId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string Match() interface{} SetMatch(val interface{}) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string RouteName() interface{} SetRouteName(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Route`.
func NewRosRoute ¶
func NewRosRoute(scope alicloudroscdkcore.Construct, id *string, props *RosRouteProps, enableResourcePropertyConstraint *bool) RosRoute
type RosRouteProps ¶
type RosRouteProps struct { Backend interface{} `field:"required" json:"backend" yaml:"backend"` EnvironmentInfo interface{} `field:"required" json:"environmentInfo" yaml:"environmentInfo"` HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` Match interface{} `field:"required" json:"match" yaml:"match"` RouteName interface{} `field:"required" json:"routeName" yaml:"routeName"` Description interface{} `field:"optional" json:"description" yaml:"description"` DomainIds interface{} `field:"optional" json:"domainIds" yaml:"domainIds"` DomainInfos interface{} `field:"optional" json:"domainInfos" yaml:"domainInfos"` }
Properties for defining a `RosRoute`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-route
type RosRoute_BackendProperty ¶
type RosRoute_BackendProperty struct { Scene interface{} `field:"required" json:"scene" yaml:"scene"` Services interface{} `field:"required" json:"services" yaml:"services"` }
type RosRoute_DomainInfosProperty ¶
type RosRoute_DomainInfosProperty struct { DomainId interface{} `field:"optional" json:"domainId" yaml:"domainId"` Name interface{} `field:"optional" json:"name" yaml:"name"` Protocol interface{} `field:"optional" json:"protocol" yaml:"protocol"` }
type RosRoute_EnvironmentInfoProperty ¶
type RosRoute_EnvironmentInfoProperty struct { EnvironmentId interface{} `field:"required" json:"environmentId" yaml:"environmentId"` Alias interface{} `field:"optional" json:"alias" yaml:"alias"` GatewayInfo interface{} `field:"optional" json:"gatewayInfo" yaml:"gatewayInfo"` Name interface{} `field:"optional" json:"name" yaml:"name"` SubDomains interface{} `field:"optional" json:"subDomains" yaml:"subDomains"` }
type RosRoute_GatewayInfoProperty ¶
type RosRoute_GatewayInfoProperty struct { GatewayId interface{} `field:"optional" json:"gatewayId" yaml:"gatewayId"` Name interface{} `field:"optional" json:"name" yaml:"name"` }
type RosRoute_HeadersProperty ¶
type RosRoute_HeadersProperty struct { Name interface{} `field:"optional" json:"name" yaml:"name"` Type interface{} `field:"optional" json:"type" yaml:"type"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosRoute_MatchProperty ¶
type RosRoute_MatchProperty struct { Path interface{} `field:"required" json:"path" yaml:"path"` Headers interface{} `field:"optional" json:"headers" yaml:"headers"` IgnoreUriCase interface{} `field:"optional" json:"ignoreUriCase" yaml:"ignoreUriCase"` Methods interface{} `field:"optional" json:"methods" yaml:"methods"` QueryParams interface{} `field:"optional" json:"queryParams" yaml:"queryParams"` }
type RosRoute_PathProperty ¶
type RosRoute_PathProperty struct { Type interface{} `field:"required" json:"type" yaml:"type"` Value interface{} `field:"required" json:"value" yaml:"value"` }
type RosRoute_QueryParamsProperty ¶
type RosRoute_QueryParamsProperty struct { Name interface{} `field:"optional" json:"name" yaml:"name"` Type interface{} `field:"optional" json:"type" yaml:"type"` Value interface{} `field:"optional" json:"value" yaml:"value"` }
type RosRoute_ServicesProperty ¶
type RosRoute_ServicesProperty struct { Name interface{} `field:"optional" json:"name" yaml:"name"` Port interface{} `field:"optional" json:"port" yaml:"port"` Protocol interface{} `field:"optional" json:"protocol" yaml:"protocol"` ServiceId interface{} `field:"optional" json:"serviceId" yaml:"serviceId"` Version interface{} `field:"optional" json:"version" yaml:"version"` Weight interface{} `field:"optional" json:"weight" yaml:"weight"` }
type RosRoute_SubDomainsProperty ¶
type RosRoute_SubDomainsProperty struct { DomainId interface{} `field:"optional" json:"domainId" yaml:"domainId"` Name interface{} `field:"optional" json:"name" yaml:"name"` NetworkType interface{} `field:"optional" json:"networkType" yaml:"networkType"` Protocol interface{} `field:"optional" json:"protocol" yaml:"protocol"` }
type RosService ¶
type RosService interface { alicloudroscdkcore.RosResource Addresses() interface{} SetAddresses(val interface{}) AttrAddresses() alicloudroscdkcore.IResolvable AttrGatewayId() alicloudroscdkcore.IResolvable AttrServiceId() alicloudroscdkcore.IResolvable AttrServiceName() alicloudroscdkcore.IResolvable AttrSourceType() alicloudroscdkcore.IResolvable // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) GatewayId() interface{} SetGatewayId(val interface{}) // The logical ID for this stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Return a string that will be resolved to a RosTemplate `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Options for this resource, such as condition, update policy etc. RosOptions() alicloudroscdkcore.IRosResourceOptions RosProperties() *map[string]interface{} // ROS resource type. RosResourceType() *string ServiceName() interface{} SetServiceName(val interface{}) SourceType() interface{} SetSourceType(val interface{}) // The stack in which this element is defined. // // RosElements must be defined within a stack scope (directly or indirectly). Stack() alicloudroscdkcore.Stack // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} AddCondition(con alicloudroscdkcore.RosCondition) AddCount(count interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependsOn(target alicloudroscdkcore.RosResource) AddDesc(desc *string) AddMetaData(key *string, value interface{}) // Adds an override to the synthesized ROS resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // For example, // “`typescript // addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) // addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “`. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) AddRosDependency(target *string) // Sets the deletion policy of the resource based on the removal policy specified. ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions) FetchCondition() alicloudroscdkcore.RosCondition FetchDesc() *string FetchRosDependency() *[]*string // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string) alicloudroscdkcore.Reference // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string ValidateProperties(_properties interface{}) }
This class is a base encapsulation around the ROS resource type `ALIYUN::APIG::Service`.
func NewRosService ¶
func NewRosService(scope alicloudroscdkcore.Construct, id *string, props *RosServiceProps, enableResourcePropertyConstraint *bool) RosService
type RosServiceProps ¶
type RosServiceProps struct { Addresses interface{} `field:"required" json:"addresses" yaml:"addresses"` GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` ServiceName interface{} `field:"required" json:"serviceName" yaml:"serviceName"` SourceType interface{} `field:"required" json:"sourceType" yaml:"sourceType"` }
Properties for defining a `RosService`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-service
type Route ¶
type Route interface { alicloudroscdkcore.Resource IRoute // Attribute Backend: Backend services. AttrBackend() interface{} // Attribute Description: The description of route resource. AttrDescription() interface{} // Attribute DomainInfos: Domain items. AttrDomainInfos() interface{} // Attribute EnvironmentInfo: Environment information. AttrEnvironmentInfo() interface{} // Attribute Match: The match rule of route resource. AttrMatch() interface{} // Attribute RouteId: The ID of route resource. AttrRouteId() interface{} // Attribute RouteName: The name of the route. AttrRouteName() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *RouteProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Route`.
func NewRoute ¶
func NewRoute(scope alicloudroscdkcore.Construct, id *string, props *RouteProps, enableResourcePropertyConstraint *bool) Route
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type RouteProps ¶
type RouteProps struct { // Property backend: Backend service configuration for routing. Backend interface{} `field:"required" json:"backend" yaml:"backend"` // Property environmentInfo: The information if the environment. EnvironmentInfo interface{} `field:"required" json:"environmentInfo" yaml:"environmentInfo"` // Property httpApiId: The ID of the API. HttpApiId interface{} `field:"required" json:"httpApiId" yaml:"httpApiId"` // Property match: The match rule of route resource. Match interface{} `field:"required" json:"match" yaml:"match"` // Property routeName: The name of the route. RouteName interface{} `field:"required" json:"routeName" yaml:"routeName"` // Property description: The description of route. Description interface{} `field:"optional" json:"description" yaml:"description"` // Property domainIds: The list of domain name IDs. DomainIds interface{} `field:"optional" json:"domainIds" yaml:"domainIds"` // Property domainInfos: Domain items. DomainInfos interface{} `field:"optional" json:"domainInfos" yaml:"domainInfos"` }
Properties for defining a `Route`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-route
type Service ¶
type Service interface { alicloudroscdkcore.Resource IService // Attribute Addresses: Service Address List. AttrAddresses() interface{} // Attribute GatewayId: The ID of the Cloud Native API Gateway. AttrGatewayId() interface{} // Attribute ServiceId: The ID of the service. AttrServiceId() interface{} // Attribute ServiceName: The Name of the service . AttrServiceName() interface{} // Attribute SourceType: Service source type. AttrSourceType() interface{} EnableResourcePropertyConstraint() *bool SetEnableResourcePropertyConstraint(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *alicloudroscdkcore.ResourceEnvironment Id() *string SetId(val *string) // The construct tree node associated with this construct. Node() alicloudroscdkcore.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by ROS // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string Props() *ServiceProps Ref() *string Resource() alicloudroscdkcore.RosResource SetResource(val alicloudroscdkcore.RosResource) Scope() alicloudroscdkcore.Construct SetScope(val alicloudroscdkcore.Construct) // The stack in which this resource is defined. Stack() alicloudroscdkcore.Stack AddCondition(condition alicloudroscdkcore.RosCondition) AddCount(count interface{}) AddDependency(resource alicloudroscdkcore.Resource) AddResourceDesc(desc *string) ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy) FetchCondition() alicloudroscdkcore.RosCondition FetchDependency() *[]*string FetchResourceDesc() *string GeneratePhysicalName() *string GetAtt(name *string) alicloudroscdkcore.IResolvable // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. Prepare() SetMetadata(key *string, value interface{}) // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. Synthesize(session alicloudroscdkcore.ISynthesisSession) // Returns a string representation of this construct. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. Validate() *[]*string }
This class encapsulates and extends the ROS resource type `ALIYUN::APIG::Service`.
func NewService ¶
func NewService(scope alicloudroscdkcore.Construct, id *string, props *ServiceProps, enableResourcePropertyConstraint *bool) Service
Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
type ServiceProps ¶
type ServiceProps struct { // Property addresses: Service Address List. Addresses interface{} `field:"required" json:"addresses" yaml:"addresses"` // Property gatewayId: The ID of the Cloud Native API Gateway. GatewayId interface{} `field:"required" json:"gatewayId" yaml:"gatewayId"` // Property serviceName: The name of the service. ServiceName interface{} `field:"required" json:"serviceName" yaml:"serviceName"` // Property sourceType: The type of the service source. SourceType interface{} `field:"required" json:"sourceType" yaml:"sourceType"` }
Properties for defining a `Service`.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apig-service
Source Files ¶
- ApiAttachment.go
- ApiAttachmentProps.go
- ApiAttachment__checks.go
- Domain.go
- DomainProps.go
- Domain__checks.go
- Environment.go
- EnvironmentProps.go
- Environment__checks.go
- Gateway.go
- GatewayProps.go
- Gateway__checks.go
- HttpApi.go
- HttpApiProps.go
- HttpApi__checks.go
- IApiAttachment.go
- IDomain.go
- IEnvironment.go
- IGateway.go
- IHttpApi.go
- IOperation.go
- IPlugin.go
- IPluginAttachment.go
- IPluginClass.go
- IPolicy.go
- IRoute.go
- IService.go
- Operation.go
- OperationProps.go
- Operation__checks.go
- Plugin.go
- PluginAttachment.go
- PluginAttachmentProps.go
- PluginAttachment__checks.go
- PluginClass.go
- PluginClassProps.go
- PluginClass__checks.go
- PluginProps.go
- Plugin__checks.go
- Policy.go
- PolicyProps.go
- Policy__checks.go
- RosApiAttachment.go
- RosApiAttachmentProps.go
- RosApiAttachment_ConditionsProperty.go
- RosApiAttachment_MatchProperty.go
- RosApiAttachment_ServiceConfigsProperty.go
- RosApiAttachment__checks.go
- RosDomain.go
- RosDomainProps.go
- RosDomain__checks.go
- RosEnvironment.go
- RosEnvironmentProps.go
- RosEnvironment__checks.go
- RosGateway.go
- RosGatewayProps.go
- RosGateway_LogConfigProperty.go
- RosGateway_NetworkAccessConfigProperty.go
- RosGateway_SlsProperty.go
- RosGateway_VSwitchProperty.go
- RosGateway_VpcProperty.go
- RosGateway_ZoneConfigProperty.go
- RosGateway__checks.go
- RosHttpApi.go
- RosHttpApiProps.go
- RosHttpApi__checks.go
- RosOperation.go
- RosOperationProps.go
- RosOperation_MockProperty.go
- RosOperation__checks.go
- RosPlugin.go
- RosPluginAttachment.go
- RosPluginAttachmentProps.go
- RosPluginAttachment_PluginInfoProperty.go
- RosPluginAttachment__checks.go
- RosPluginClass.go
- RosPluginClassProps.go
- RosPluginClass__checks.go
- RosPluginProps.go
- RosPlugin__checks.go
- RosPolicy.go
- RosPolicyProps.go
- RosPolicy__checks.go
- RosRoute.go
- RosRouteProps.go
- RosRoute_BackendProperty.go
- RosRoute_DomainInfosProperty.go
- RosRoute_EnvironmentInfoProperty.go
- RosRoute_GatewayInfoProperty.go
- RosRoute_HeadersProperty.go
- RosRoute_MatchProperty.go
- RosRoute_PathProperty.go
- RosRoute_QueryParamsProperty.go
- RosRoute_ServicesProperty.go
- RosRoute_SubDomainsProperty.go
- RosRoute__checks.go
- RosService.go
- RosServiceProps.go
- RosService__checks.go
- Route.go
- RouteProps.go
- Route__checks.go
- Service.go
- ServiceProps.go
- Service__checks.go
- main.go